InstallEclipsePlugin

Introduction

Here you will find information to guide you in installing the Umple Eclipse Plug-in, in order to develop systems using Umple.

Eclipse is not the only way to use Umple. You can also use Umple Online or a plain text editor and a command-line version of Umple. However using the Eclipse editor will enable you to make fewer errors (because you will have syntax assist) and to compile large, complex Umple systems. The Eclipse-based Umple Editor does not yet, however have a graphical UML editor for Umple; for that capability, you will have to use Umple Online

Step 0: Prerequisite: Java

To compile code with Umple you need the Java Runtime Environment and Java Development Kit. On some operating systems, this comes already installed. On Mac OS X, if it is not installed, you will be prompted to install it when you attempt to run a Java application such as Eclipse:

If you do not yet have Java installed You can download the JRE and JDK from: http://www.oracle.com/technetwork/java/javase/downloads/index.html

It is recommended that regardless of what version of Java you currently have, you update to the latest Java SE 8. Simply download it and install.

Step 1: Downloading and running correct version of Eclipse

NOTE: It is possible to develop with Umple without Eclipse, and to do everything from the command line. If you want to do that, you can visit https://umple.org/dl and download only the command line compiler.

To set up Eclipse for Umple, download, install and run the latest version of Eclipse with modelling tools from http://eclipse.org/downloads/.

You will need to obtain 64 bit Eclipse if you have 64 bit Java, or 32 bit Eclipse if you have 32 bit Java.

The instructions below apply to the latest Eclipse as of October 2016, although they may still work in earlier Eclipse versions.

When you initially run eclipse you will be prompted to choose a workspace. This is simply the location at which you would like to save all your projects now and in the future. (If you are planning to modify umple itself, then see DevelopmentSetUp for suggestions regarding this)

Step 2: Using the Umple Update Site to install the Eclipse plugin automatically

PREREQUISITE: Eclipse Modeling tools running, as described above.

This option to install Umple allows you to automatically get Umple updates into your Eclipse installation.

• Open the Install New Software dialog (Help -> Install New Software)

• Add the Umple update site: http://cruise.eecs.uottawa.ca/org.cruise.umple.eclipse.plugin.update.site

• The dialog will prompt you to name the site; call it Umple Plugin

• Now that you have added the Umple update site, select the following features from the Umple update site: Umple Eclipse Plugins -> Umple plugin

• Click Next.

• Review the items to be installed, accept any agreements, and click Finish.

• Acknowledge that you trust the security certificate and Click OK.

• Accept to restart Eclipse to make the changes effective.

• Now, you should see Umple Menu

To try out Umple, here are some steps (this is largely for those new to Eclipse)

• When you first start Eclipse, you will see Package Explorer on your left. Bring up the contextual menu in this, and select 'New / Project...'

• Within the New Project dialog, select 'General', then under this 'Project', then 'Next>'

• Give the project a name and click finish.

• Now, in the contextual menu of the new project select 'Import...'

• Pick a source of Umple files from the dialog that appears. For example, if you want to pick them from the file system, use 'General' and 'File System' then browse to a directory and pick the directory. If you do not have any Umple files yet created, you can make one and call it Test.ump, and put the code "class X{}" inside it. There are many examples of Umple at https://umple.org/examples

• To edit Umple files, select a file and double-click, or choose Open With / Umple Editor. If you see a prompt 'Do you want to add the Xtext nature to the project' then indicate 'yes'.

• To compile Umple files, click on one of the .ump files, and select the red 'Compile Umple' icon (a little red 'U') in the toolbar. You will see Java code created in your project. If you get an error, create an empty '.classpath' file in your umple directory if none exists.

It should create a file called X.java

You want to become a developer of Umple?

If you want to contribute changes to Umple you would now want to look at page DevelopmentSetUp to learn how to edit and compile Umple itself.

Problems?

If you have problems, consult the Umple user manual and other pages in this wiki. You should also consult the list of issues to see if you have encountered a known problem. If all else fails, send a message to the Umple Help mailing list.

Manual Installation

Step 2 (Alternative) Manually installing the needed components for Umple

PREREQUISITE: latest Eclipse with Modeling tools running, as described above.

NOTE: We recommend installing the plugin through our update site. You will be able to get the latest version of the plugin automatically when it is available.

• Download the latest archive plugin here.

• Select Help -> Install New Software .. from your Eclipse IDE.

• Click on the Add button and then write Umple Plugin for the name and then select the file you just downloaded through the button Archive...

• Click OK and the check "Umple Eclipse Plugins" and "Umple Plugin".

• Click Next two times and then accept the license.

• Once you are done, restart the Eclipse and you should see the Umple menu in your Eclipse.

• Verify that little red U icons appear at the top of the main panel. If they do not appear, then the plugin must be incompatible. Please contact us for help, giving details of the Eclipse version, the Java version, and the operating system version.