This document describes how to install an Eclipse IDE ready to create Scout applications. The text below assumes that you are working with a windows box. The installation process does not differ much for other platforms.

Get the Package

Java and Maven

Before you download Scout make sure that you have a working Java Development Kit (JDK) and a working Maven installation. In case you first need to download and install a JDK we recommend to work with either the Oracle JDK or the Open JDK. For Maven, head over to the Maven project page.

To verify your Java installation use your command line.

C:\Users\mzi>java -version
java version "1.8.0_92"
Java(TM) SE Runtime Environment (build 1.8.0_92-b14)
Java HotSpot(TM) 64-Bit Server VM (build 25.92-b14, mixed mode)

We recommend to use a JDK version 8. Take note of the fact if your JDK is a 64-bit or a 32-bit installation. In case your version text does not explicitly mention a 64-bit version your JDK is 32-bit installation.

Now check your Maven installation on the command line as well.

C:\Users\mzi>mvn -version
Apache Maven 3.2.3 (33f8c3e1027c3ddde99d3cdebad2656a31e8fdf4; 2014-08-11T22:58:10+02:00)
Maven home: C:\maven\apache-maven-3.2.3
Java version: 1.8.0_92, vendor: Oracle Corporation
Java home: C:\java\jdk1.8.0_92\jre
Default locale: en_US, platform encoding: Cp1252
OS name: "windows 7", version: "6.1", arch: "amd64", family: "dos"

Having verified the above prerequisites it is now time to download the Scout package.

Download Scout

Download the Eclipse Scout package by visiting the official Eclipse download page.

The download page then looks as shown in Figure 1.

scout download
Figure 1. The Eclipse download page. The Scout package download can be accessed via the link shown in the red box.

Clicking on the link leads to a list of individual download packages as shown in Figure 2.

scout download package
Figure 2. The Scout download package.

As shown above, the Eclipse Scout package is available in the form of a 32 bit and a 64 bit package. To download the correct package, make sure to matche your JDK installation as described in the previous section.

After the package selection, confirm the suggested download mirror as shown in Figure 3.

scout download mirror
Figure 3. Downloading the selected Scout package from a mirror.

Install Scout

As the Scout package is a simple ZIP (or tar.gz) file, you may unpack its content to a folder of your choice such as C:\eclipse_scout on a Windows box. Inside the sub-folder eclipse you will find the eclipse.exe file. This is the Eclipse IDE executable file. Starting the Eclipse executable brings up the workspace launcher as shown in Figure 4.

scout startup select workspace
Figure 4. Starting the Eclipse Scout package and selecting an empty workspace.

Into the Workspace field you enter an empty target directory for your first Scout project. After clicking the Ok button, the Eclipse IDE creates any directories that do not yet exist and opens the specified workspace. When opening a new workspace for the first time, Eclipse then displays the welcome screen shown in Figure 5.

scout startup welcome
Figure 5. Eclipse welcome screen.

To close the welcome page click on the Workbench icon in the top right corner. As a result the empty Java perspective is displayed according to Figure 6.

scout startup scout explorer
Figure 6. Eclipse started in the Java perspective.

Congratulations, you just have successfully completed the Eclipse Scout installation!

What’s Next?

With your working Scout installation you are now ready to create your first Scout application. Go ahead and follow the ‘Hello World!’ tutorial.

Do you want to improve this document? Have a look at the sources on GitHub.