New Scout Project Wizard

The New Scout Project wizard can be used to create a new Scout project from scratch.

To open the wizard press Ctrl+N or use File New Other… and type "Scout" into the Wizards search field. Then, select the entry "Scout Project" and click on Next. This leads to the initial dialog of the New Scout Project wizard as shown in Figure 1.

Figure 1. The new Project Wizard

A detailed description of the indiviudal wizard fields of Figure 1 is provided in the next section.

By clicking on the Finish button the wizard is started and a new Scout client server application is created in the form of a Maven multi-module project.

Wizard Fields and Default Values

All fields of the Figure 1 are initially filled with default values.

Group Id: Maven groupId used for all created projects. The default value is org.eclipse.scout.apps.
Artifact Id: Maven artifactId for the parent project. The additional projects are derived from this name. The default value is helloworld.
Display Name: The name of the application presented to the user. This name is shown in the Browser title bar. The default value is "My Application"

With the Project Location group box, you can control where the project will be created. Unchecked the Use default Workspace location checkbox to enter an other value in the Target Directory Field. The Browse… button can help you to find the appropriate path.

Created Components

With the Figure 1 wizard a complete Maven multi-module project is created. Using the default artifact Id helloworld the following Maven modules are created.

Maven module helloworld
- Contains the project’s parent pom.xml file
Maven module helloworld.client
- Contains model components of the client application in src/main/java and model tests in src/test/java.
- The class HelloWorldForm in package org.eclipse.scout.apps.helloworld.client.helloworld is an example of a model class.
Maven module helloworld.shared
- Contains components needed in both the client and the server application.
- For examples see the IHelloWorldService interface in src/main/java and class HelloWorldFormData in src/generated/java.
- The Texts.nls file that can be opened in the Scout NLS Editor.
Maven module helloworld.server
- Contains the model components of the server application in src/main/java and model tests in src/test/java.
- The class HelloWorldService in package org.eclipse.scout.apps.helloworld.server.helloworld is an example of such a model class.
Maven module helloworld.server.app.dev
- Contains all components to run the Scout server application from within the Eclipse IDE.
- The file config.properties in folder src/main/resources contains the development configuration for the Scout server application.
- The file pom.xml bundles the Jetty web server with the server application.
- The file [webapp] dev server.launch contains the launch configuration for the Eclipse IDE.
Maven module helloworld.server.app.war
- Contains all components to create a Scout server WAR file to deploy to an external web server.
- The file config.properties in folder src/main/resources contains the server configuration.
- The file pom.xml is used to build the Scout server WAR file.
Maven module helloworld.ui.html
- Contains servlet filters and the HTML pages as well as custom CSS and JavaScript files for the Scout UI Server.
- See class UiServletFilter in src/main/java and folder WebContent in source/main/resources.
- The file js build.launch contains the launch configuration for the Eclipse IDE that executes the JavaScript build.
Maven module helloworld.ui.html.app.dev
- Contains all components to run the Scout UI application from within the Eclipse IDE.
- The file config.properties in folder src/main/resources contains the development configuration for the application.
- The file web.xml in folder src/main/webapp contains the web configuration for the application.
- The file pom.xml bundles the Jetty web server with the application.
- The file [webapp] dev ui.launch contains the launch configuration for the Eclipse IDE.
Maven module helloworld.ui.html.app.war
- Contains all components to create a Scout UI WAR file to deploy to an external web server.
- The file config.properties in folder src/main/resources contains the application configuration.
- The file web.xml in folder src/main/webapp contains the web configuration.
- The file pom.xml is used to build the Scout UI WAR file.

Go back to the Scout Wizards.

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