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

Backport 2.0.1 updates #121

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CIMToolFeature/feature.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<feature
id="au.com.langdale.cimtoole.feature"
label="CIMTool"
version="2.0.0"
version="2.0.1"
provider-name="Langdale Consultants">

<description url="http://cimtool.org">
Expand Down Expand Up @@ -69,7 +69,7 @@ info@healthmarketscience redistributed under the LGPL version 2.1.
<import plugin="org.eclipse.jface" version="3.5.0" match="greaterOrEqual"/>
<import plugin="org.eclipse.ui.workbench" version="3.5.0" match="greaterOrEqual"/>
<import plugin="au.com.langdale.cimutil" version="1.8.2" match="greaterOrEqual"/>
<import plugin="au.com.langdale.rcputil" version="2.0.0" match="greaterOrEqual"/>
<import plugin="au.com.langdale.rcputil" version="2.0.1" match="greaterOrEqual"/>
<import plugin="org.eclipse.emf.ecore.xmi" version="2.5.0" match="greaterOrEqual"/>
<import plugin="org.eclipse.emf.ecore" version="2.5.0" match="greaterOrEqual"/>
<import plugin="org.eclipse.emf" version="2.5.0" match="greaterOrEqual"/>
Expand Down
2 changes: 1 addition & 1 deletion CIMToolHelp/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Bundle-ManifestVersion: 2
Automatic-Module-Name: au.com.langdale.cimtoole.help
Bundle-Name: CIMTool Help Plug-in
Bundle-SymbolicName: au.com.langdale.cimtoole.help;singleton:=true
Bundle-Version: 2.0.0
Bundle-Version: 2.0.1
Bundle-ClassPath: CIMToolHelp
Bundle-Vendor: Langdale Consultants
Bundle-RequiredExecutionEnvironment: JavaSE-20
2 changes: 1 addition & 1 deletion CIMToolPlugin/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Bundle-ManifestVersion: 2
Automatic-Module-Name: au.com.langdale.cimtoole
Bundle-Name: CIMTool Plug-in
Bundle-SymbolicName: au.com.langdale.cimtoole;singleton:=true
Bundle-Version: 2.0.0
Bundle-Version: 2.0.1
Bundle-RequiredExecutionEnvironment: JavaSE-20
Bundle-ClassPath: cimtoole.jar,
lib/commons-logging-1.1.1.jar,
Expand Down
12 changes: 0 additions & 12 deletions CIMToolPlugin/builders/builders.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,6 @@
"datetime": "2022-08-01T00:00:00Z",
"ext": "rtf"
},
"legacy-rdfs": {
"type": "TRANSFORM",
"style": "legacy-rdfs",
"datetime": "2024-01-29T00:00:00Z",
"ext": "legacy.rdfs"
},
"legacy-rdfs-augmented": {
"type": "TRANSFORM",
"style": "legacy-rdfs-augmented",
"datetime": "2024-01-29T00:00:00Z",
"ext": "legacy-augmented.rdfs"
},
"rdfs-augmented-cimcontextor": {
"type": "TRANSFORM",
"style": "rdfs-augmented-cimcontextor",
Expand Down
2 changes: 1 addition & 1 deletion CIMToolProduct/CIMTool.product
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<?pde version="3.5"?>

<product name="CIMTool" uid="au.com.langdale.cimtool.deployment" id="au.com.langdale.cimtool.product.ide" application="org.eclipse.ui.ide.workbench" version="2.0.0" useFeatures="false" includeLaunchers="true" autoIncludeRequirements="true">
<product name="CIMTool" uid="au.com.langdale.cimtool.deployment" id="au.com.langdale.cimtool.product.ide" application="org.eclipse.ui.ide.workbench" version="2.0.1" useFeatures="false" includeLaunchers="true" autoIncludeRequirements="true">

<aboutInfo>
<image path="cimtool-about.png"/>
Expand Down
2 changes: 1 addition & 1 deletion CIMToolProduct/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: CIMToolEnvironment
Bundle-SymbolicName: au.com.langdale.cimtool.product;singleton:=true
Bundle-Version: 2.0.0
Bundle-Version: 2.0.1
Bundle-ClassPath: CIMToolProduct
Bundle-Vendor: Langdale Consultants
Automatic-Module-Name: au.com.langdale.cimtool.product
2 changes: 1 addition & 1 deletion CIMUtil/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: CIMUtil
Bundle-SymbolicName: au.com.langdale.cimutil
Bundle-Version: 2.0.0
Bundle-Version: 2.0.1
Bundle-RequiredExecutionEnvironment: JavaSE-20
Require-Bundle: au.com.langdale.kena
Bundle-ClassPath: cimutil.jar,
Expand Down
2 changes: 1 addition & 1 deletion com.cimphony.cimtoole/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Bundle-RequiredExecutionEnvironment: JavaSE-20
Require-Bundle: org.eclipse.emf.ecore;bundle-version="2.5.0",
org.eclipse.emf;bundle-version="2.5.0",
au.com.langdale.cimutil;bundle-version="1.8.2",
au.com.langdale.rcputil;bundle-version="2.0.0",
au.com.langdale.rcputil;bundle-version="2.0.1",
org.eclipse.core.resources,
org.eclipse.core.runtime,
au.com.langdale.kena,
Expand Down
23 changes: 16 additions & 7 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,34 +9,43 @@ Download the latest binary release of **CIMTool** [here](https://github.com/cimu
Extracting to `D:\CIMTool-2.0.0` folder on a Windows system would result in a new `D:\CIMTool-2.0.0\CIMTool` folder containing **CIMTool** and it dependencies. The launchable executable would be located at `D:\CIMTool-2.0.0\CIMTool\CIMTool.exe`

## Step 2 - Install Java
In order to successfully run **CIMTool**, a 64-bit Java 20 or later JRE/JDK is required. If you do not already have a newer version of Java (>= Java 20) installed on your system it should be downloaded and installed before moving on to the next step. [Azul](https://www.azul.com) has a great freely available Windows 64-bit option available at the [Azul Zulu OpenJDK Downloads](https://www.azul.com/downloads/?package=jdk#zulu) site. Installation is straightforward if using the ```.msi``` installer and installation instructions are available on Azul's site of needed.
Starting with **CIMTool** release 2.0.0 and later you no longer need to download and install a Java runtime environment. Instead, the appropriate release of Java now comes bundled in the ZIP archive. All that is needed is to extract the ZIP file and then launch the CIMTool executable (i.e. `CIMTool.exe`). This greatly simplifies the installation process and if installing such a release you may skip over this step and proceed on to Step 3 below.

If installing a release prior to 2.0.0, in order to successfully run **CIMTool**, a 64-bit Java 8 JRE/JDK must be installed. New supported releases of Java 8 are currently available at either of the below locations. Note that you should review the relevant licensing requirements for these downloads. Oracle may be more restrictive than for your purposes in which case the Zulu OpenJDK release may be preferable:

- [Oracle JDK](https://www.java.com/en/download/)
- [Zulu OpenJDK](https://www.azul.com/downloads/?package=jdk#download-openjdk)

Once installed on your system you can execute `java -version` from a command prompt to determine what the default JRE/JDK is on your system:

!!! example

![cmdPromptJavaVersion.png](./images/cmdPromptJavaVersion.png "Check Java version using command prompt")
![cmd-prompt-java-version-results.png](./images/cmdPromptJavaVersion.png "Check Java version using command prompt")

In this example, we see from the results that on this system the default JRE/JDK is a version of Java 20 (i.e. build 20.0.2+9). There may be other versions of Java installed on the system but we know from the output that it will be the Java 20 installation that will be used to execute **CIMTool** by default if we double click the installed executable located at `D:\CIMTool-2.0.0\CIMTool\CIMTool.exe` in our example.
In this example, we see from the results that on this system the default JRE/JDK is a version of Java 8 (i.e. version 332). There may be other versions of Java installed on the system but we know from the output that it will be the Java 8 installation that will be used to execute **CIMTool** by default if we double click the installed executable located at `D:\CIMTool-1.11.1\CIMTool\CIMTool.exe` in our example.

### Setting up Alternate JVM
If the command line results indicate a different default Java version, then either a Windows shortcut or .bat script can be created so that an alternate (non-default) JVM can be used for launching **CIMTool**. These options can be configured in the following manner.

#### Option 1 - Windows Shortcut
Locate the directory containing the Java 20 JRE/JDK release you installed on your system (a 64-bit installation of Zulu for example will typically be located in either `C:\Program Files\Zulu\zulu-20-jre\bin\java.exe` or `C:\Program Files\Zulu\zulu-20\bin\java.exe` depending on whether you've downloaded a JRE or JDK release).
Locate the directory containing the Java 8 JRE/JDK release you installed on your system (a 64-bit installation of Zulu for example will typically be located in either `C:\Program Files\Zulu\zulu-8-jre\bin\java.exe` or `C:\Program Files\Zulu\zulu-8\bin\java.exe` depending on whether you've downloaded a JRE or JDK release).

In Windows right-click on the **CIMTool.exe** and select the menu option for creating a shortcut. Right-click on the new shortcut and select the Properties menu option. In the dialog that comes up explicitly specify as a command line parameter a 64-bit JVM to use at launch time. This change must be specified in the "Target:" field. In this working example, the resulting entry in that field would be: `D:\CIMTool-2.0.0\CIMTool.exe -vm "C:\Program Files\Zulu\zulu-20\bin\java.exe"`
In Windows right-click on the **CIMTool.exe** and select the menu option for creating a shortcut. Right-click on the new shortcut and select the Properties menu option. In the dialog that comes up explicitly specify as a command line parameter a 64-bit JVM to use at launch time. This change must be specified in the "Target:" field. In this working example, the resulting entry in that field would be: `D:\CIMTool-1.11.1\CIMTool.exe -vm "C:\Program Files\Zulu\zulu-8\bin\java.exe"`

![CIMToolShortcutForAltJava.png](./images/CIMToolShortcutForAltJava.png "Eclipse Shortcut for specifying alternate Java version")

#### Option 2 - Batch Script
An alternative approach is to create a `CIMTool.bat` script containing command line execution similar to that shown below but which correlates to the installation locations native to your own local file system:

```bat
rem Launch CIMTool using a 64-bit Java 20 JRE
C:\CIMTool-2.0.0\CIMTool\CIMTool.exe -vm "C:\Program Files\Zulu\zulu-20\bin\java.exe"
rem Launch CIMTool using a 64-bit Java JRE 8
C:\CIMTool-1.11.1\CIMTool\CIMTool.exe -vm "C:\Program Files\Zulu\zulu-8\bin\java.exe"
```

!!! bug

An [issue](https://github.com/cimug-org/CIMTool/issues/14) was reported whereby CIMTool-1.10.0.RC1 and earlier releases no longer launch cleanly using newer releases of Java 8. The fix for this was introduced in the CIMTool-1.10.0.RC2 release. Note that for users with older versions of **CIMTool** (e.g. 1.10.0.RC1, 1.9.7, or earlier) on their system those instances will no longer work if the Java 8 installation is upgraded to a newer release. To have co-existing instances of both old and new releases of **CIMTool** you will need to have both a new and older release of the Java 8 JRE/JDKs installed (in two distinct locations) and, in turn, distinct shortcuts and/or .bat files in order to specify the appropriate Java 8 JVM to use when launching **CIMTool**.

## Step 3 - Launch CIMTool
Upon a successful launch of **CIMTool** the following dialog is presented. A default workspace (as shown by the example in the screenshot) will be used or you can enter your own location and name for a workspace to be created.

Expand Down
6 changes: 6 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ 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.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]

Expand Down
Loading