jCleanCim readme

jCleanCim is an open source tool for validation and documentation generation from Enterprise Architect CIM UML models, and IEC61850 UML models currently under development by UML 61850 task force of WG10, WG17, WG18 and TC88 JWG25. It is hosted by the CIM Methods & Tools for Enterprise Integration group on the CIM Users Group web site for the CIM and IEC61850 users community.

Although this is a Java application, it is unfortunately platform dependent due to the usage of Enterprise Architect and MS Word, which are available on MS Windows only.

(Old release notes)

Documentation

Once you unzip a jCleanCim distribution, doc directory contains the full documentation. The important parts of the source code are documented and that documentation is generated as so-called javadoc - namely, a set of web pages that allow for easy navigation.

Which distribution should I download?

jCleanCim is available in two distributions, depending on how you want to use it.

Even if you have a 64-bit Windows OS, ensure you install a 32-bit Java (JRE: runtime) or SDK (software development kit) and have it appear on your PATH before the potentially already installed 64-bit Java, because Enterprise Architect is still a 32-bit application and requires a 32-bit Java. See the commented text in the run.bat script.

Distribution User kind Prerequisites Installing
Binary distribution jCleanCim-[version]-bin.zip Run jCleanCim from the console (cmd.exe).
  • 32-bit Java 7+ runtime (JRE). To verify whether you already have it installed, open the console window and type java -version
  • Enterprise Architect build 834+ (version 7.1+)
  • (optional: to run doc generation) MS Word 2003+
Unzip the distribution anywhere on your file system; it will uncompress in its own directory tagged with the version so there is no danger of overwriting an older installation. For example, using WinZip, select "Extract to here" command.
Source distribution jCleanCim-[version]-src.zip Run jCleanCim from the console (cmd.exe) or from within eclipse.

Develop and build it with Apache ant or with eclipse.

  • 32-bit Java 7+ software development kit (SDK). To verify whether you already have it installed, open the console window and type javac -version
  • Apache ant 1.7.1+. To verify whether you already have it installed, open the console window and type ant -version.
  • Enterprise Architect build 834+ (version 7.1+)
  • (optional, runtime: to run doc generation) MS Word 2003+
  • (optional, during ant build: to build javadoc with UML for any distribution, and to document ant build targets dependencies graph) GraphViz application. To verify whether you already have it installed, open the console window and type dot -version

Same as for binary distribution (jCleanCim-[version]-bin.zip).

If used with eclipse, start eclipse SDK and after unzipping, use Import ->Existing project and browse to the unzipped directory.

Note: This is the most flexible option if you are developing, as you can have the eclipse project anywhere on your disk (not necessarily in an eclipse workspace).

discontinued since 02v00

Eclipse project archive jCleanCim-[version]-eclipse.zip

Same as for Source distribution jCleanCim-[version]-src.zip. Use Source distribution jCleanCim-[version]-src.zip.

Note for source distribution (and if you need to create the distribution yourself): Ant build file contains targets that invoke GraphViz application for creation of graphical elements for the documentation (UML-enhanced javadoc, and javadoc in pdf format). If you do not have GraphViz installed on your local system, these targets will be just skipped during the build (even if you get exceptions from the doclet, the javadoc gets generated, just without the UML diagrams). However, if you want to produce jCleanCim distributions, you should install GraphViz in order to have nicer documentation.

Dependencies

To be self-contained, jCleanCim distributions bundle relevant third party open source/distributable libraries. Java jars are in the project's lib directory, and MS Windows dlls are in the dlls directory.

The following libraries are packaged with all the distributions of jCleanCim:

The following libraries are packaged only with source distribution of jCleanCim:

Performance indicators

Since we talk to EA and to MS Word through their automation APIs, the model building (as a first step in the application) and the MS Word document generation (if enabled) take time:

Java processing - for validation, statistics calculation and documentation collection from in-memory model to pass to the actual writer (s), as well as XML document generation for web-access - takes a couple of seconds for all the models and scenarios tested.

Hints

Here items thay may be considered as issues (but will likely not be addressed soon) and performance-related advice, so please take them into account when running jCleanCim:

Disclaimer

Starting with release 02v00, jCleanCim has been licensed under the terms of GNU LGPLv3 license and includes a modified copyright. The copyright as well as a reference to the license for this software is available at the download site, and is included in every distribution and in every java source file.

Have a look here for a relatively accessible comparison of licenses.

This software has been developed in my free time, with the full knowledge and approval of my employer.


Release notes for jCleanCim-02v00, 2015-05-19


Licensing changes

From this release, the license terms have changed, see disclaimer. There should be no big impact if you were using it the same way as I did :-)

Distribution changes

Producing the distribution "Eclipse project archive jCleanCim-[version]-eclipse.zip" has been discontinued, because it's a manual and time consuming process. The same functionality is available by using the "Source distribution jCleanCim-[version]-src.zip" - by importing simply the eclipse project file from un unzipped directory.

New features

This is a release with incremental changes and no "real" new feature.

Performance improvements in release 02v00

None.

Potential backwards compatibility breaking changes for the application user

Potential forwards incompatibility for the application user: old jCleanCim with new EA

Other functional changes

Validation rules:

Bug fixes:

Known issues / limitations:

Implementation and packaging:

Documentation:


Built on 2015-05-19T13:26:17

License

Feedback

Valid XHTML 1.0 Strict