Skip to main content
Jump to: navigation, search


Wiki Home

Work in Progress
This documentation is work in progress. It will become the necessary Docuware for the Scout Photon release.

Eclipse Scout DocuWare (Photon Release)

This page provides the required docuware for the Scout 8.0 Release Review as part of the upcoming Photon Simultaneous Release according to the Eclipse process documentation.

Contact: matthias(dot)zimmermann(at)bsi-software(dot)com

Communication Channels:

Release Review Dates and Links

Review Bug

This release review is tracked in Bugzilla TODO.

Review Dates

  • May 24/2017 - IP Log submission deadline
  • May 31/2017 - Review materials due
  • June 7/2017 - First round of release reviews (aim for this date if you can)
  • June 21/2017 - Second (final?) round of release reviews
  • June 28/2017 - Eclipse Photon GA

Original source is here

Additional Links


Eclipse Scout is a mature and open framework for modern, service oriented business applications.

  • Scout HTML5 client applications may run on the desktop, on tablets and on mobile phones without any changes in the source code
  • Scout substantially boosts developer productivity and is simple to learn.
  • User friendly applications are straight forward to implement with Scout’s comprehensive set of user interface components.
  • Completely based on Java, Scout Applications are easy to integrate in most IT environments.

Features and Roadmap

(Planned) Features

The current plan for the Scout 8.0 contains topics described below.

Scout JS

During the Oxygen release some initial steps under the name “Scout JS” were implemented to decouple the new Scout HTML5 widgets from the rest of the framework. The goal of these efforts is to provide a Scout JS widget library that can be used by classical Scout applications as well as other pure JavaScript consumers. The current State of Scout JS is focused on the requirements of individual customer projects and not intended for productive use outside of the scope of these specific projects.

In the context of the Photon release we expect to complete this refactoring to a point where Scout JS provides a production ready widget library for a more general class of JavaScript applications / web UIs.

Move to new service API

A PoC is planned to investigate a move from today’s service calls using Scout FormData/PageData objects to a new service API. The goal of the replacement is a more generic/powerful mechanism to deal with additional UI technologies/3rd party consumer in addition to the current Java client UI. Such a move requires careful analysis and discussions with the current user base. As of today, it is not yet clear if this initiative can be implemented in the context of the Photon release.

Alternatives to nested Java Classes for Scout UI Model?

Today, the Scout UI model for forms and pages is based on nested inner classes. While nested Java classes offer a very clear structuring of the Scout model code this mechanism is quite rigid regarding dynamically building UIs, for cases where the user needs to subclass a subset of components and in cases that would require multiple inheritance. For the Photon release we plan to investigate possible alternatives to this concept. As in the case of the new service API careful analysis will be required and it is not yet clear that any changes/new features will actually be implemented within the Photon release.

Improve Application Startup Performance

During development Scout applications need to be restarted frequently which is very time consuming. With the Scout Photon release restart times should be reduced significantly.

Roadmap Scout Version 9.0+


Milestone Installations

Please follow the steps below.

  1. Prior to the official Eclipse Release download the Scout EPP from the Developer Builds
  2. Download and Install the Scout SDK
  3. The Scout "Hello World!"

Non-Code Aspects

Scout Documentation/Tutorials etc. is written with Asciidoctor and hosted on Github.

The progress of the Scout book may be monitored in the following output directory

Status per communication channel

  • Forum: OK
  • Wiki: OK
  • Webpage: OK
  • Mailing list: OK for important info to all committers


We certify that the public Scout APIs in this release are production quality. As a significant amount of commercial customer applications are based on these APIs we evaluate/communicate changes accordingly.

Compatibility with Previous Releases

Scout 8.0 ist not compatible with Scout 7.0.

We try to make migration to new releases as easy as possible, however to keep our code clean and simple we need to change the API in new releases. There are no more API changes after milestone M6. API Compatibility rules are described in the contribution guidelines in more detail.

Migrating from Scout 7.0 to 8.0 Migration corresponds to a two-step approach. see the following Eclipse Scout Migration Guides



With Scout release 8.0 no significant components reach their end-of-life. Therefore, no substantial migration efforts are anticipated for migrating a Scout application from release 7.0 to release 8.0.

Ramp down Policy

We use daily builds. No API changes after M6, no new features after M7. In the RC phase only bugs marked P2 or higher or severity major or higher will be fixed.

Bugzilla Tickets


Target Environment



All of Eclipse Scout is "pure" Java code and has no direct dependence on the underlying operating system. The chief dependence is therefore on the Java Runtime (JRE) itself. The Scout 8.0 runtime is still compatible with Java SE 7. As the announced end of public updates for Java 7 is scheduled for April 2015, Scout projects working with Oracle products might want to consider moving to Java 8 as soon as possible.

The eclipse scout package only runs with Java >=8.

Java Version Support for Scout Runtime/SDK
8 recommended
9 experimental

Eclipse Platform

For Scout 8.0 we recommend developing Scout with Eclipse Photon (4.8).


The following Eclipse platforms are supported:

Eclipse Version Scout Runtime Scout SDK
Mars (4.5) - supported
Neon (4.6) - supported
Oxygen (4.7) - recommended

Browser Versions


The HTML5 UI for Scout only supports the following browsers and versions:

  • Microsoft Internet Explorer >= version 9 (10 or higher recommended)
  • Microsoft Edge (desktop pc, surface tablet) >= 12
  • Google Chrome >= version 36
  • Firefox >= version 36
  • Safari >= 7

Browser on mobile devices. Browsers are typically included in device OS. Therefore, our recommendations are linked to device OS versions as well:

  • iOS >= 8
  • Android >= 5
  • Windows Mobile >= 10

Tested Platforms

We focus our testing on a handful of popular combinations (OS, HW Arch, Java VM, Eclipse platform); these are our reference platforms.

Scout undoubtedly runs fine in many operating environments beyond the reference platforms we test. However, since we do not systematically test them we cannot vouch for them. Problems encountered when running Scout on a non-reference platform that cannot be recreated on any reference platform will be given lower priority than problems with running Scout on a reference platform.


Scout 8.0 will be tested and validated on the following reference platforms:

Operating System OS Version Hardware Java VM (vendor, version, arch) Eclipse Platform (version, arch)
Windows 7 x86 64-bit
Oracle JDK 7, 64-bit 4.6, 64-bit, EPP
Oracle JDK 8, 64-bit 4.6, 64-bit, EPP
10 Oracle JDK 8, 64-bit 4.6, 64-bit, EPP
Ubuntu Linux 15.10 OpenJDK 7, 64-bit 4.6, 64-bit, EPP
Apple Mac OS 10.8 Oracle JDK 7, 64-bit 4.6, 64-bit, EPP

Eclipse Scout is no longer explicitly tested on 32bit architectures.

Build Process

Scout is built on Hudson @ Eclipse.

Scout is using maven and tycho for building.

  • Gerrit Jobs run build against lowest target platform with runtime unit tests
  • Nightly Jobs run against all platforms with all unit tests
  • Release Jobs can be parameterized for a specific tag and deploy to a specific updatesite
  • Some tests currently still run only at BSI's infrastructure: Scout GUI tests using java.awt.Robot, because they need a fully-fledged desktop environment.

Scout Maven Artifacts uploaded to

Current Project Metrics

According to the Eclipse project dashboard Scout belongs to the most active repositories hosted at Eclipse.

Latest project metrics for Eclipse Scout are provided on openHub.

Community and Support

Activities 2017

  • Javaland
  • Eclipse Democamp Zurich
  • Eclipse Democamp Munich
  • Java Forum Stuttgart
  • 4th Eclipse Scout User Group Meeting (planned)
  • Eclipsecon Europe (planned)
  • Devoxx Antwerpen (planned)

Activities 2018


Current Status


IP Status

New Components


Dependency Upgrades


IP Log

The state of the IP log is tracked with TODO. Scout's IP Log for Scout has been generated according to the Wiki description.

To check the current state at any time, use the following link. To compare against potential issues use this IP Issues List. Caution: The link reporting potential issues contains many bogus links. See below for a partial list

Known bogus issues in IP issues list:

  • ant-*
  • derby*
  • junit.jar
  • servletbridge.jar

TODO: The Scout IP Log has been approved on [pending]. The component leadership verifies that:

  • The about files and use licenses are in place as per the Guidelines to Legal Documentation.
  • All contributions (code, documentation, images, etc) have been committed by individuals who are either Members of the Foundation, or have signed the appropriate Committer Agreement. In either case, these are individuals who have signed, and are abiding by, the Eclipse IP Policy.
  • All significant contributions have been reviewed by the Foundation's legal staff.
  • All non-Committer code contributions, including third-party libraries, have been documented in the release and reviewed by the Foundation's legal staff.
  • All Contribution Questionnaires have been completed.

Previous Release Documentation

Back to the top