Release Notes
This section contains CIMTool release notes and can be used for quick reference of what has changed in each version. Note that these notes are the same as those available on GitHub here, 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: With the recent introduction of UUID and URI in CIM18 CIMTool was updated to support the new domain types.
Enhancement Issue #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 is related to 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: 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: 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 included research into leveraging AsciiDoc for DevOps based standards publication generation. In addition, PlantUML diagrams can be included in Draw.io (newly named Diagrams.net) diagrams. PlantUML can easily be integrated into AsciiDoc, Markdown, 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 for forthcoming instructional videos on how to utilize new features. The use of PlantUML class diagrams for validating a profile will be included.
Defect Issue #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. It should be noted that the builder currently generates RDFS2020 schema's with "flattened" CIMDatatypes (i.e. value, unit, multiplier 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:
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 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: A 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.
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.
Enhancement Issue #108: CIMTool did not yet support the new .qea and .qeax (64-bit) EA project file format introduced in the 64-bit Sparx EA 16.x releases. This enhancement allows these EA project file types to be imported directly as your CIM schema.
Enhancement Issue #114: CIMTool did not yet support the .eapx and .feap (32-bit) EA project file formats available in the 32-bit Sparx EA 15.x releases. The .feap format is an embedded Firebird database that works across both EA 15.x 32-bit and EA 16.x 64-bit release of the product. This specific type of EA project file is the only file format that can be opened in both 32-bit Sparx EA 15.x and 64-bit EA 16.x releases without conversion. Note that this enhancement intersects the work identified in Issue #108.
Enhancement Issue #118: This issues introduces a new builder to generate a LinkML representation of a CIMTool profile and is useful for a wide variety of downstream processing. The output from this builder can be leverage LinkML's core python toolchain which includes functionality like generators to convert schemas to other modeling languages and data converters and validators for working with data that conforms to LinkML (including RDF, JSON, and TSV). The following offer some useful background as to what LinkML is and how it can be leveraged: LinkML FAQ and LinkML Documentation
Enhancement Issue #133: PNNL has contributed two new XSLT custom builders (see: cimantic-graphs) that generate python-based code for working with semantic graphs. These have been added as OOTB builders. Thanks to Alex Anderson for his contribution to the CIM community.
Defect Issue #131: Aggregation relationships between classes were not appearing in either the "Project Model" view or the "Add/Remove" tab in CIMTool (only associations and generalizations were visible). Thanks to Walter Concert for catching and reporting the issue.
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 are now targeted for the 2.2.0 release.
Release 2.0.1 [12-May-2024]
CIMTool 2.0.1 is a patch release and should be utilized in place of CIMTool 2.0.0 until release 2.1.0 is finalized and made public.
Defect Issue #115: During development of the CIMTool 2.1.0 release, issues in the generated output of the RDFS XSLT builders introduced in CIMTool 2.0.0 have been identified. Specifically, during the testing of the modeling of extensions for new .qea and .feap EA project files support. In the short term a 2.0.1 patch release must be issued that re-introduced the original builders until the fix is addressed in CIMTool 2.1.0.
Release 2.0.0 [06-Mar-2024]
CIMTool 2.0.0 is a major release and establishes a new 2.x release line for the next generation of features and functionality within CIMTool.
Enhancement Issue #91: Migration of CIM Tool from the Eclipse 3.x to the Eclipse 4.x platform (e4) was done. This migration introduces no new functionality but instead addresses the need to re-baseline CIMTool to e4. This new 2.x release line of CIMTool will serve as the basis for future functionality, enhancements, and roadmap planning. Initial benefits of this release include:
- CIMTool can now execute using the latest version of Java - i.e. Java 20
- UI rendering and responsiveness is much faster in the e4 platform when executing large profiling tasks
- Much more significant heap space - 4GB max configured OOTB
- Rebranding (i.e. new icons and splash screen have been introduced to reflect the new 2.0.0 release line)
Defect Issue #75:
This fix addresses a Java memory error when importing and display large .xmi files.
Release 1.12.0 [21-Feb-2024]
CIMTool 1.12.0 is a minor release with some UI enhancements in usability and select defect fixes.
Defect Issue #26: CIMTool's *.legacy-rdfs-augmented profile builder does not correctly generate the multiplicity of the secondary (i.e. inverse association) within the profile that it produces. This was discovered as part of the IEC 61970-452 published profile whereby the multiplicity for the Terminal.TieFlow inverse association 0..2 should have been generated as 0..2 but instead was generated as 0..n.
Defect Issue #77: This fix addresses a regression issue introduced in the 1.11.0 release of CIMTool. In that release the modifications to the XSLT builder for generating XSDs the CIMTool feature for allowing multiple profiles per class no longer properly generated two distinct ComplexType(s) in the XSD.
Enhancement Issue #78: A new builder was introduced to bring CIMTool RDFS-based profiles into alignment with the latest agreed upon RDFS2020 extensions/changes.
Defect Issue #79: CIMTool's Stereotypes tab and UI does not correctly display all stereotypes imported from XMI/EAP schemas.
Enhancement Issue #80:
CIMTool currently only supports the generation of the older RDFS profile format (e.g. *.legacy-rdfs & *.legacy-rdfs-augmented) and is not current with regard to the latest extensions/additions that were agreed upon and implemented within CimConteXtor / CimSyntaxGen tooling as the new "RDFS2020" profile format. A *.legacy-cimcontextor.rdfs RDFS is introduced here that produces a variant that is a cross between CIMTool's existing *.legacy-rdfs-augmented builder and the new *.rdfs-2020.rdfs builder associated with Issue #78.
Enhancement Issue #81:
CIMTool requires enhancements to support specifying when a top-level concrete class is to utilize an rdf:ID (local) or rdf:about (global) identifier within the profile. The introduction of the <<Description>> stereotype on a concrete class is used to flags this distinction in CimConteXtor. To represent the equivalent within CIMTool a new http://langdale.com.au/2005/UML#description stereotype has been introduced that can be assigned by an end user via one of the following methods:
2.0.0
-
The "Stereotypes" tab:
-
The "Restrictions" tab:
Enhancement Issue #82: Currently, when the "Add" buttons are used to add selected class(s) or properties of a class to the profiles CIMTool defaults the cardinality on all member attributes to 1. Additionally, when selecting/adding a class to the profile that is intended to be concrete extra navigation to the "Restriction" tab is required to set it to "concrete". To provide enhanced usability and save time, the following updates have been made to the "Add/Remove" tab:
- A new checkbox labeled: "Set selected classes to concrete when added to the profile" was introduced. When the checkbox is in the checked state then the group of selected classes added to the profile will automatically be set as "concrete" in the profile.
- A new checkbox labeled: "Set selected properties to required when added to the profile" was introduced. When the checkbox is in the unchecked state then all attributes within a selected class or all attributes directly selected will default to a min cardinality of 0.
Release 1.11.1 [14-Feb-2023]
CIMTool 1.11.1 is a minor release with some UI enhancements in usability and select defect fixes.
Defect Issue #58: The CIMTool builders were updated to produce target artifacts (RDFS, OWL, etc.) that now have RDF/XML elements ordered in a consistent and deterministic manner. This was needed so that CIMTool projects hosted in a GitHub repository could have file-based comparisons performed using GitHub's built in features.
Enhancement Issue #57:
Based on user feedback the "Import Copyright Templates" wizard needed to be enhanced to allow an end user to select an option for using the default UCAIug copyright headers for an existing project. This without having to import them from the file system. This feature already existed within the "New Project" wizard but needed to be added to the copyright templates wizard.
The enhancements made to the existing "Import Copyright Templates" wizard screen are shown in the below table (click on the images to present a larger view):
| Import Copyright Templates (OLD) | Import Copyright Templates (NEW) |
|---|---|
 |
 |
Release 1.11.0 [28-Sep-2022]
CIMTool 1.11.0 is a minor release with some UI enhancements in usability and select defect fixes.
Defect Issue #47: Custom copyrights were not being imported properly in the "New Project Wizard" for the custom copyright template option.
Defect Issue #48: Copyright headers fail to update in OWL profiles on import of new headers in the "Import" Wizard.
Enhancement Issue #49: Screens introduced in release 1.10.0 to the "Import" and "New CIMTool Project" wizards have been redesigned.
In the "New CIMTool Project" wizard the previous Steps 2 and 3 have been consolidated into the single screen shown below (click on the image to present a larger view). This removes ambiguity and improves usability for end users when creating projects.
On the "Import" wizard previously there were two separate import copyright template options; one for muiltline and another for single-line templates. This has been consolidated into a single screen.
| Updated CIMTool Import Options | Import Copyright Templates |
|---|---|
 |
 |
Release 1.10.1 [02-Sep-2022]
This is a patch release for CIMTool 1.10.0
Enhancement Issue #39:
During preparation for the new CIMTool-Builders-Library repository it was discovered that the new profile-doc-rtf.xsl builder entry in the .builders file that was introduced in the 1.10.0 release was incorrectly defined. This has been corrected.
Enhancement Issue #40:
Within the CIMCheck sub project it was discovered that when the upgrade to ICU4J-71.1 occurred during the 1.10.0.RC2 release that the .xml build script and html files for the project were not updated to reflect the needed changes for the classpath for CIMCheck. This has been corrected as part of this 1.10.1 patch release.
Release 1.10.0 [26-Aug-2022]
This is the production release of CIMTool 1.10.0
Enhancement Issue #3: As of release 1.10.0.RC1 CIMTool's internal XSLT transform builders "engine" has be made public to end users with new screens added to import custom profile builders. The internal XSLT processor in CIMTool was the Apache Xalan project. However, Apache Xalan is a W3C XSLT 1.0 compliant XSLT processor. To support the much richer feature set defined in the XSLT 3.0 specification the XSLT engine has been replaced by Saxon HE 10.8. Saxon is XSLT 1.0, 2.0, and 3.0 compliant.
Enhancement Issue #27: A new builder for auto-generation of profile documentation has been added to the set shipped OOTB. This builder produces a Microsoft Word compatible RTF (Rich Text Format) document when selected in the Profile Summary Tab. Click on the images to present a larger view.
| Profile Summary Tab | Example RTF Word Document |
|---|---|
 |
 |
Enhancement Issue #30: The new copyright templates are are now also applied to the headers of the profile definitions themselves (i.e. *.owl files).
Enhancement Issue #28: Additional screens have been added to the "New CIMTool Project" wizard used when creating a new CIMTool project. These screens now appear as Steps 2 and 3 in the create project process. Below provides an overview of the Wizard (click on the images to present a larger view).
| Step 1 | Step 2 (NEW) |
|---|---|
 |
 |
| Step 3 (NEW) | Step 4 |
|---|---|
 |
 |
Release 1.10.0.RC3 [28-Jul-2022]
This is the third release candidate for CIMTool 1.10.0
Fix Issue #21: Eliminated superfluous namespaces that are being generated by the IEC 62361-100 compliant XSD schema builder that ships with CIMTool.
Enhancement Issue #23: CIMTool's internal message model definition has been extended with the addition of two new attributes for Choice elements that can be used by CIMTool builders. The purpose of the new attributes is to make easily available to XSLT-based builders the topmost class in a type hierarchy for a union defined in a profile.
Enhancement Issue #20: All builders that generate RDFS and OWL profiles were updated to utilize the new custom copyright template capabilities.
Enhancement Issue #22: Custom copyright templates are now supported in CIMTool. A copyright template is defined as an external file containing the text of either a multi-line or single-line copyright to be used by builders for inclusion in the artifacts that they generated (e.g. XSD schema, RDFS, or JSON schema profiles). A template must include a ${year} substitution variable which is recognized by CIMTool and substituted with the current year at the time a builder is executed. A UCAIug Apache 2.0 copyright template is bundled out-of-the-box with CIMTool and used as the default copyright template if an alternate is not set after a project is created. Both multi-line and single-line copyright templates are supported and can be imported/assigned using new import screens introduced in this release and shown below.
| New CIMTool Import Options | Copyright Template Import |
|---|---|
 |
 |
Release 1.10.0.RC2 [20-Jun-2022]
This is the second release candidate for CIMTool 1.10.0
Feature Issue #16: Support for the new IEC 62361-104 draft standard for JSON schema profiles has been updated from that introduced in the RC1 release. The builder now reflects the most recent changes to the JSON draft specification. However, this does not yet include namespace support for custom extensions to be included in the published standard. Updates to the builder for namespace support is planned for RC3.
Feature Issue #7: A new out-of-the-box builder has been introduced to generate XSD profiles that are compliant with the newly published 2nd Edition of the IEC 61968-100 international standard.
Feature Issue #15: XSD and JSON schema builders in CIMTool have been updated to include an official UCAIug Apache 2.0 copyright header in their output.
Fix Issue #14: CIMTool failed on startup when using the latest releases of the Java 8 JRE/JDK. It was determined that at some point in the release history of these JRE/JDKs that the ICU4J project utilized for internationalization support was upgraded in the JRE/JDK. Therefore, the ICU4J jar file originally included in the release of CIMTool has been upgraded to the latest release of jar file for the ICU4J project.
Fix Issue #6: Fix for a regression issue in the xsd.xsl builder.
Release 1.10.0.RC1 [06-May-2020]
This is the first release candidate for CIMTool 1.10.0
Feature: The RC1 release introduces support for the new IEC 62361-104 draft standard for JSON schema profiles. This RC does not include the variant of namespace support that will be included in the published standard. That is planned for RC2.
Enhancement: CIMTool supports a variety of different types of builders that generate profile artifacts. Examples include XSD schemas, JPA Java source code, RDBMS DDL scripts, RDFS profiles, etc. The ability to create custom profile builders has been available via CIMTool Eclipse plugin extension points, but such an approach requires an understanding of Eclipse plugin development. Internally, CIMTool supports a category of builders based on XSLT transforms. This release exposes this functionality by providing a configuration-based approach to adding custom XSLT transform-based builders that will automatically appear within CIMTool's "Profile Summary" tab. This enhancement allows for the use of tools such as Altova's XMLSpy to create and test XSLT 1.0 transforms and then import and manage them in CIMTool.
CIMug's goal for this enhancement is to create a repository of custom XSLT transforms contributed by the community and, in turn, beneficial to the CIM community at large.
Launch paths to the new UI screens (click on the images to present a larger view):
| From the Select Import Wizards Screen... | ...Launches the Import XSLT Builder Screen |
|---|---|
 |
 |
| From the Profile Summary Tab... | ...Launches the Manage XSLT Transform Builders Screen |
|---|---|
 |
 |
Release 1.9.7 [09-Dec-2013]
correction: .eap files are closed after parsing and can now be deleted from a project.
Release 1.9.6 [10-Sep-2013]
enhancement: platform updated to eclipse Indigo.
enhancement: direct import of EA project files. This is now the default option on the import file selector. The capability is provided by a new release of the jackcess library with MS Jet3 compatitbility.
enhancement: convenience button for the CIM 16 namespace.
correction: help facility restored.
Release 1.9.5
This is one of a series of beta testing releases. See the blurb, New and Notable for 1.9. This release adds:
- Map primitive 'duration' to xs:duration. (Note: we already map decimal, date, time, dateTime to XSD types of the same name.)
- Mappings of AbsoluteDate and AbsoluteTime removed. (Can't remove other oddball mappings such as AbsoluteDateTime because that would affect legacy schema generation.)
Release 1.9.4
This release was not generally made available pending resolution of CIM data and time type issues.
This is one of a series of beta testing releases. See the blurb, New and Notable for 1.9. This release adds:
- Hard coded translation of CIM datatypes AbsoluteDate and AbsoluteTime to xs:date and xs:time. This is to get around a (hopefully temporary) problem in the CIM where these identifiers were used instead of the XSD ones.
Release 1.9.3
This is one of a series of beta testing releases. See the blurb, New and Notable for 1.9. This release adds:
enhancement: profile repair and remapping to the CIM will ignore case when searching for a CIM term if an exact match can't be found.
Java SE 1.6 is now the minimum requirement for the JVM
correction: a bug interpreting .eap files caused namespaces to be incorrectly assigned in some cases.
enhancement: recognise ontology headers in annotations files. The given namespace overrides the default namespace for their schema (or CIM). This also triggers an improved package URI generation scheme.
correction: change the heap memory maximum to 1GB (from 2GB) allowing the product version of CIMTool to run on more systems.
enhancement: cosmetic changes to startup.
enhancement: added schema mapping wizard to 'new' menu.
Release 1.9.2 [09-Jan-2011]
This is one of a series of beta testing releases. See the blurb, New and Notable for 1.9. This release adds:
enhancement: tree views in the user interface retain their state accross refreshes including save profile and navigation away from a node and back again. This makes it easier to keep your place in the model during profile building.
Updated Ecore functionality to enable registered EPackages to be used for the base schema. Updates to the Ecore generation to ensure profiled Ecore matches the package hierarchy of the base if the base is also Ecore. Removed unused legacy merged schema generation
Release 1.9.1
This is a beta testing release to trial a number of major changes. See the blurb, New and Notable for 1.9. In summary:
- Generalised profile editing.
- Schema mapping and extension editor.
- Ecore model support.
- Recognise new CIMDatatype stereotype.
Release 1.8.3 [10-Aug-2010]
correction: improved backwards compatibility with version 1.7 for profile (.owl) files. A profile can be round-tripped from 1.7 to 1.8.2 and back repeatedly. In 1.8.2 this caused errors in the profile editor.
enhancement: basic validation for the new standard headers in CIM/XML documents. This reduces the number of spurious validation errors.
Release 1.8.2 [05-Jun-2010]
The release corrects the following defect in 1.8.1:
correction: a defect in handling of attributes (datatype properties) caused spurious validation errors and incorrectly generated XML schema.
Release 1.8.1 [06-Feb-2010]
This release incorporates changes to make CIMTool compatible with commonly used ontology editors. It has been tested with Protege 4 and Top Braid 3.2.
enhancement: namespaces for OWL files are not longer stored as properties in the CIMTool project they are embedded in the files as part of the ontology header. This change affects the user interface for profile properties as well as several wizards and the Detail tab of the profile editor for the root element of the profile.
enhancement: the ontology header is now compliant and includes the profile description, label, and (implicitly) namespace. the .owl header includes an import for the merged information schema.
enhancement: CIM datatypes are now modeled using equivalentClass axioms. Anonymous classes in their profile are linked by equivalentClass or subClass to their respective information model classes.
Release 1.7.3
correction: profile validation rules for the case where a member of a child class is lifted into a parent caused spurious diagnostics. This affected the EndDeviceAssett profile in the IEC 61968 part 9 profiles.
Release 1.7.2 [10-Nov-2009]
correction: Older Rose based CIM versions sometimes have invalid, top level datatype definitions. Attempts in release 1.4.1 to deal with these in some older EDF CIM versions broke compatibility with some older Siemens models. They are now interpreted even more flexibly in the light of other definitions to obtain a valid overall model.
Release 1.7.1 [10-Nov-2009]
correction: the inverse properties that are added the profile for the "augmented" OWL and RDFS artifacts are incorrect when the range and domain are related by inheritance.
Release 1.6.9 [19-Oct-2009]
enhancement: new .simple-flat-owl format which corresponds to the simple-owl format in version 1.6.3
Release 1.6.8 [30-Sep-2009]
enhancement: new options on the profile add/remove page control whether super or sub class members are available. It is now possible to redefine or separately define a member in subclasses.
Release 1.6.7
correction: ensure artifact generation runs to completion even when a profile contains severe errors.
Release 1.6.6 [27-Sep-2009]
correction: a problem introduced in 1.6.5 that prevented importing Enterprise Architect Jet4 projects
Release 1.6.5 [26-Sep-2009]
enhancement: additional help
correction: corrected problem introduced in 1.6.4 with the new simple-owl format that also affected validation
note: deployment now contains separate plugins for the main supporting libraries
Release 1.6.4 [26-Sep-2009]
new feature: profile searching and enhanced CIM searches. The search wizard is now available on the profile outline as well as the add/remove page and the project model view. The wizard now shows all matching classes, properties or other items in a list with context and allows the user to navigate to a specific hit.
enhancement: the Project Model View and the Documentation view now track selections made in the profile editor add/remove page and profile outline. This makes it much easier to choose items to add to a profile. It also works well with the new profile search wizard to explore a profile.
enhancement: the format of the simple-owl and simple-owl-augmented files has been changed to eliminate all nodeID attributes. Restriction elements are nested directly in Class elements to which they apply. Some URI's have been shortened due better choice of the base namespace.
Release 1.6.3 [26-Sep-2009]
enhancement: more robust import of Enterprise Architect project databases, ignoring errors such as disconnected attributes.
Release 1.6.2 [26-Sep-2009]
new feature: the Documentation View continuously shows documentation from the CIM for the current selection. To see this view, enter the CIMTool perspective using Window > Open Perspective and reset it using Window > Reset Perspective.
new feature: the Browsing Perspective is designed for browsing the CIM. To use it, choose Window > Open Perspective > CIMTool > Browsing and select a project in the Project Explorer View. Use the Project Model View and its Jump and Search buttons (top right of view) to browse. This perspective is sometimes easier to use than a standard UML editor, especially if the UML diagrams are not complete.
enhancement: addition profile checking rules and actions in the repair assistant. These detect and repair several profile problems discovered in the wild. A rule that caused a false alarm in the 61968-9 profiles has been rectified.
enhancement: the Project Model View now has a Jump button (next to Search) that moves the selection to the opposite end of an association or subclass-superclass relationship.
correction: Resource names containing spaces caused processing of the project to stall.
Release 1.6.1 [26-Sep-2009]
new feature: Profile Repair Assistant.
The Profile Repair Assistant helps correct errors in profiles, especially those which arise when the profile is paired with an updated CIM.
Each time a profile is saved or a the CIM schema is changed, the profile is checked against a set of rules. If any errors are detected, a repair file appears as a red icon adjacent to the profile in the project explorer.
Opening the repair file causes the repair assistant to run, which displays the errors and offers suggested repair actions. Any desired repairs can be checked and are applied when the save button is pressed.
new feature: directly import Enterprise Architect project files
The create project and import schema wizards now offer the option to directly import an Enterprise Architect project file. This eliminates the need to create an XMI file for import to CIMTool and speeds up the round trip when the CIM or an extension is edited concurrently with a profile.
The feature is limited to EA project files in the Jet4 format. This requires the project to be converted to Jet4 and the "use Jet4" option in EA to be enabled.
new feature: cardinality for concrete profile classes.
It is mow possible to set the minimum and maximum cardinality of a a top-level, concrete class. This is reflected in generated XML schemas by the cardinality of the corresponding first-level element defintions.
new feature: preliminary support for compound datatypes.
The <
enhancement: namespaces and other settings are stored in the project, enabling projects to be exported and imported between projects without loss of information or functionality.
enhancement: commonly used namespaces are offered by the schema import and project creation wizards.
enhancement: profile namespace checked against schema namespaces in the import profile and new profile wizards. conflicts between the profile namespaces and a schema namespace are prevented.
enhancement: improved software update system (better support of the P2 provisioning system)
enhancement: now based on eclipse 3.5 (Galileo)
correction: the namespace field in the import schema wizard was ignored.
correction: cases where the build system failed to trigger a build or triggered the same build twice corrected.
correction: the bases of an anonymous profile class could not be changed on the hierarchy page of the profile editor.
Release 1.5.5 [12-May-2009]
new feature: CIMTool can now generate java class definitions with JPA annotations. These classes can be used in a java program to implement the objects of a CIM profile.
The JPA (Java Persistance API) annotations map the classes to relational database tables. Thus the CIM profile objects can be loaded from and saved to a database with a minimum of effort. The JPA feature has been tested with a Hibernate and Oracle combination. See http://hibernate.org
The database can be created using the DDL feature released in version 1.4.4.
To use these features, check the SQL and java builder options on the summary page of your CIM profile. SQL and java artifacts will be created. The database structure is described in the CIMTool help.
correction: a regression in version 1.5.4 affecting mRID fields in SQL artifacts was fixed.
Release 1.5.4 [12-May-2009]
enhancement: A description can be added to a profile and edited on the profile editor detail tab. It will appear in the HTML documentation and as an annotation to any XML schema.
enhancement: The profile envelope name is now preserved when profiles or projects containing profiles are exported and imported. It, and the description, are stored within the profile OWL file and it is edited on the detail tab instead of the property dialog box.
Release 1.5.3 [09-Mar-2009]
enhancement: HTML profile documentation changed to more closely follow the part 301 format. Inherited members are shown for each class, grouped by superclass.
Release 1.5.2 [01-Feb-2009]
enhancement: accept comments encoded in as 'description' tags from some XMI documents generated by EA
correction: the outline and add/remove display was not updating following the assignment of a type to an element (ie a profile property).
Release 1.5.1 [21-Jan-2009]
enhancement: updated CIMTool help
correction: the remap profile to schema function failed for some profiles
package with eclipse 3.4 platform for windows (no JDT hence lighter download)
Development Releases 1.4. Caveat: Releases 1.4. are development releases. They contain internal changes in preparation for the a new guided profile update feature. While they pass the CIMTool test suite and unstructured testing, there could nevertheless be regressions.
The 1.4.* releases can be only obtained from an eclipse update site at: http://files.cimtool.org/development
Stable releases are preferred and these are available in a number of forms detailed here: http://wiki.cimtool.org/Download.html
Development Release 1.4.4 [21-Jan-2009]
new feature: CIMTool can now generate a database schema from a CIM profile. This is done by selecting the "SQL" option in the profile editor. An SQL92 DDL artifact is generated. This has been tested for compatibility with Oracle 10g.
The generated code includes tables and fields for classes and properties and comments are copied through for clarity. Constraint definitions are generated for mandatory/optional cardinality, enumeration membership, association type and class inheritance.
Class inheritance has been implemented using the PK-PK join approach.
correction: the comparison functions were not configured correctly in the previous release and would yield no results.
correction: a regression causing the cardinality of some associations extracted from xmi to be incorrect.
correction: a regression in the "make leaf classes concrete" function caused all classes to be marked as not concrete.
correction: an infinite loop when generating artifacts from some profiles containing a circular association.
correction: the eclipse platform sometimes reported errors when a profile was deleted.
Development Release 1.4.3 [21-Jan-2009]
enhancement: comparisons of profiles to profiles or schema to schema are now much faster and require much less memory. These operations now use CIMTool's cache for the inputs.
enhancement: Repair and remap profile function now corrects the namespace of enumeration values
enhancement: enumerations can now be added directly to the profile (previsously they were added only as a side effect of property definition)
correction: a regression prevented restriction of the range of a property to a subclass.
correction: enumeration restrictions were not carried into the generated OWL and RDFS artifacts and were not validated in instance documents.
Development Release 1.4.2 [21-Jan-2009]
new feature: profile consistency checking and problem display. CIMTool will check each profile against the project schema during the build phase. Inconsistencies are recorded in a diagnostic file which can be viewed with CIMTool's diagnostic editor (also used for instance validation).
When consistency errors exist error markers appear on the profile resource (in the Project Explorer view) and the affected profile elements in the profile outline view. A entry is also added to the eclipse problems view.
This is a first release of this feature and only the most common inconsistencies are detected. Some further improvements in the checking algorithm and the user interface may be expected.
Note: to check profiles a project build must be triggered. A trigger is generated if the schema (CIM and extensions) or a profile is updated.
new feature: support for the <
enhancement: support for the Siemens PowerCC namespace tags. These tags associate a namespace prefix such as 'ext' with each individual class, association or attribute. To use this information you must declare each prefix in the annotation file with a statement like this:
http://www.ercot.com/CIM11R0/2008/2.0/extension# uml:uriHasPrefix "etx" .
enhancements to support some older versions of CIM and EDF models:
do not accept top level datatype definitions in an XMI file as written. Flexibly assign a type to these identifiers based on related definitions found elsewhere in the model.
accept 'units' as well as 'unit' for the units attribute of a datatype
correction: the baseuri tag was not recognised in some XMI files.
corrections: various regressions introduced in the 1.4.1 development release.
Development Release 1.4.1 [21-Jan-2009]
First release with internal changes to the ontology API needed for future features.
new feature: Schema comparison using the eclipse compare functionality. Each project has at least one schema file (generally a .xmi file) in the Schema folder. To compare two schemas, select them in the Navigator, right click and choose Compare With > Each Other. To compare a schema with a recent version select it, right click and choose Compare With > Local History.
new feature: Integrated help. To access CIMTool help and documentation within eclipse, choose Help > Help Contents from the main menu. Look for the topic "Common CIMTool Tasks" in the table of contents. In the release, the included help consists of the most useful material from the http://cimtool.org web site.
Release 1.3.3 [11-Sep-2008]
new feature: "Add package name to default schema namespaces" preference causes unique RDF namespaces to be generated from the UML package hierarchy.
new feature: CIM/XML profiles can now have more than one restriction, in different contexts, on the same property. This was previously only supported for XSD profiles.
The simple-owl format now preserves all property restrictions and the validation rules have been reworked to enforce them.
The standard CIM/XML RDFS format cannot support this and CIMTool rolls up the restrictions into a single, consistent property definition.
correction: when rolling up restrictions to base classes for RDFS, they are always relaxed. this prevents restrictions from incorrectly affecting sibling classes.
correction: use the concrete stereotype in validation instead of treating the leaf classes as concrete. The "Stereotype leaf classes as concrete" operation can be used to obtain the previous behaviour.
enhancement: stereotypes assigned in the profile editor are copied into the generated RDFS and simple-OWL.
enhancement: build target flags and stereotypes defined in a profile are preserved in the "Reorganize per RDFS Rules" operation.
enhancement: the property sheet view for diagnostic nodes has been improved.
enhancement: tested with eclipse 3.4 (Ganymede)
Release 1.3.2 [11-Sep-2008]
correction: allow unnamed schema properties to be profiled
new feature: sawsdl semantic annotations in generated XML Schema see: http://www.w3.org/TR/sawsdl/
enhancement: generated HTML profile documentation reworked with better ordering and formating of information.
enhancement: package names added to properties sheet and generated profile documentation.
Release 1.3.1 [11-Sep-2008]
new feature: Property sheet view shows details of the selected profile or schema definition. This view has been added to the CIMTool perspective. From the menu choose Window > Reset Perspective to update your perspective. The property sheet replaces some of the fields on the profile editor detail page.
new feature: Profile comparisons using the eclipse compare functionality. To compare two profiles, select them in the Navigator, right click and choose Compare With > Each Other. To compare a profile with a recent version select it, right click and choose Compare With > Local History.
enhancement: preserve association documentation from EA UML 1.4 (Rose compatible) XMI export files. It is now possible to use EA models with CIMTool using those XMI export settings.
new feature: simple-owl-augmented and legacy-rdfs-augmented targets can be built from a profile. The new targets provide both a forward and inverse property for each property defined in the profile. They replace the old nested-simple-owl and nested-legacy-rdfs build targets. Build new build targets can be selected on the profile editor summary page.
Release 1.2.5 [18-Jul-2008]
new feature: add a class hierarchy page to the profile editor
new feature: allow more than one named profile per information model class
correction to search feature: failed to display matches in some cases
Release 1.2.4 [10-Jul-2008]
change schema tree icons to reflect UML aggregation and composition
the 'make leaf classes concrete' option in the profile editor now does exactly that and ignores other
capture aggregation annotations from Unisys XMI input
support for non-standard primitive to XSD part II mappings
Release 1.2.3 [03-Jul-2008]
Fix regression: ProjectModelView not responding to selection or double click
Release 1.2.2
Fix a jena ConversionException when remapping profile to new CIM namespace.
Add missing wizard for new incremental validation rules.
Correct title in import schema wizard.
Release 1.2.1
Released under LGPL.
Remove a Java 6 dependency.
Release 1.1.7
Added AbsoluteDateTime to the built-in list of fundamental types. It is mapped to an xsd:datetime
Fixed a regression that prevented the Import Incremental Model wizard from being completed.
Fixed a regression in the Validation View in the Validation Perspective. The view action buttons were missing.
Release 1.1.6
Fixed a bug in the backwards compatibility code for the 1.1.5 profile format change. The symptom was a failure to generate XML schemas from profile created in earlier versions.
A bug in the handling of the unit attribute of datatype definitions has been corrected.Unit and multiplier values should now be captured in the whole-of-schema OWL output as annotation properties. (Although there don't seem to be many multiplier values defined in the CIM so far.) To see this output choose File|Export|CIMTool|Export Merged Schema from the menus.
The schema search wizard has been added to the profile editor.Look for a search button on the top right of the Add/Remove page. Classes can found by typing in a few characters of their name or the name of one of their properties and selecting the desired match.
Release 1.1.5
The form of the generated XML schema has been changed in the case where a property is defined with more than one range type. In this case no element is generated for the property and an xsd:choice of element representing the types appears.
A new stereotype "Preserve" has been defined. When assigned to a property it causes the property element to be generated wrapping the type elements. This can be used to avoid ambiguities that the above schema generation rule might cause.
A schema search wizard has been added for testing. It is accessed from the project model view toolbar.
Release 1.1.4
Numerical cardinality values other than 0, 1 and unbounded are now supported.
The Add/Remove tab now has fields for entering the min and max cardinality of a property as well as check boxes for the common options. As before, cardinality values that would exceed those defined in the CIM for the given property are not allowed.
Cardinality values are carried through the generated XML schema. In the generated RDFS or simple-owl any cardinality greater than one is treated as unbounded because those formats do not allow for arbitrary values.
Release 1.1.3
Completed performance enhancements, improving the display refresh behavior in the profile editor.
Release 1.1.2
Numerous regressions that crept into 1.1.1 have been corrected.
Performance of the profile editor has been improved. There may be some minor display refresh problems introduced by this work, but the editor is much more pleasant to use.
A merged schema export wizard has been added. This allows you to export OWL for the schema (as opposed to a profile) to a file in the workspace, which will then be maintained up-to-date- by the build system, or to a file in the filesystem. Only the direct rdfs:subClassOf axioms are included, as requested.
Enumerated values in generated XSD have simple names (with no class prefix).
When a range is added to a profile property it is no longer shown with label "Unamed". It is named after the schema class. (Range profiles are new feature that allow the range defined in the schema to be narrowed to a union of its subclasses.)
A stereotype page has been added to the profile editor. Stereotypes can be added and removed from profile classes and properties. These are transmitted to the generated profile artifacts and can be used in custom profile generation rules. The list of available stereotypes is drawn from the UML and from a stereotype definition file and from a built-in list.
The By Reference and Concrete flags are now represented as stereotypes and can be assigned on the stereotype page. By Reference flags in old profiles are automatically converted to stereotypes upon editing.
The concrete flag was formerly computed and is now a manually assigned stereotype. However, the concrete stereotype can be compute for all classes in the profile by the new "Repair and Reorganise" wizard.
A "Repair and Reorganise" wizard is available from the Summary page of the profile editor. This provides a check list of global profile transformations and will apply the selected ones in the appropriate order.
The order is:
- Stereotype all properties as By Reference
- Stereotype leaf classes as Concrete
- Repair and remap profile to schema
- Reorganise profile per RDFS rules
The remap operation is usefull if namespaces in the schema have been changed. It updates the profile to reference a new schema finding the best match for each class and property. It performs a number of other repairs as well.
The reorganise operation we present before. Warning: RDFS rules are incompatible with the new property range profiles and these will be lost if this operation is performed.
Changes 2008-02-15 CIM/XML validator passes the full test suite, available at http://files.cimtool.org/Validation-Cases-2008-02-15.zip
Includes incremental CIM/XML validation.
User interface improvements.
Changes 2008-01-31 CIMTool has expanded namespace support described here: http://wiki.cimtool.org/CIMToolNamespaceSupport.html
There is support for multiple extension model namespaces.
Optionally, those namespaces can be carried through to profile artifacts (legacy-rdfs and simple-owl). This corresponds to the current practice on the ERCOT project.
The pros and cons of the latter practice are discussed here: http://wiki.cimtool.org/Namespaces.html
For a discussion of CIM extension model techniques using CIMTool see the UISOL Distributech presentation.
The CIM/XML validation function has been further developed.
Basic topology validation tests are now included and the profile conformance tests have been expanded.
Memory footprint is down and speed is up. It is now possible to validate giant models such ERCOT in about the same time again it takes to parse their XML. That is about 5 minutes parse plus 5 minutes validation on my box. The models used for IOP testing only take seconds.
A simplified user interface for validating models has been added. It is implemented as an eclipse 'perspective' with fixed layout and new views, actions and wizards for streamlining this task. From the menu select Window > Show Perspective > Validation.
A validation result browser has been implemented. This groups messages by class and property and is linked to the Project Model View.
Repetitive validation messages involving with the same description and the same class or property are now suppressed by default. This behaviour is controlled by a preference. Check Window > Preferences > CIMTool > Limit validation output.
The validation rule language has been improved and simplified. It is still rather technical to write these rules, but this is a step towards practical per-project validation rules.
Changes in the profile editor have been made.
A simplification has been made in the logic for detecting a concrete class. This affects XML schema generation.
Note that ''concrete'' classes are rendered in XML Schema as top level elements while other classes become complexTypes. A class is concrete if it is not ''nested'' in another class anywhere in the profile except with the ''by reference'' flag.
This change has the potential to change the XML Schema generated from existing profiles where a class was used both by reference and not in the same profile. That is an unlikely scenario.
The icon for a ''by reference'' association has been changed to an arrow. The icon for a ''nested'' association is a class box.
The ''Reorganize Profile'' function (found on the Summary tab) now has an option to convert all associations to ''by reference''. This is mainly useful for CIM/XML profiles where that as the correct way to model associations.
The ''Remap Profile'' has been temporarily withdrawn. A more reliable way to adjust a profile when the information model namespace(s) change is being developed.