| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"> |
| <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="generator" content="Asciidoctor 1.5.5"> |
| <title>New Scout Project Wizard</title> |
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"> |
| <link rel="stylesheet" href="css/eclipse.css"> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css"> |
| <link rel="stylesheet" href="css/coderay-eclipse.css"> |
| </head> |
| <body class="article"> |
| <table border="0" class="navigation" style="width: 100%;" summary="navigation"> |
| <tr> |
| <td align="left" colspan="1" rowspan="1" style="width: 30%"><a href="sdk_wizard.html" shape="rect" title="Scout Wizards"><img alt="Previous" border="0" src="images/prev.gif"></a></td> |
| <td align="center" colspan="1" rowspan="1" style="width: 40%"></td> |
| <td align="right" colspan="1" rowspan="1" style="width: 30%"><a href="sdk_wizard_form.html" shape="rect" title="New Form Wizard"><img alt="Next" border="0" src="images/next.gif"></a></td> |
| </tr> |
| <tr> |
| <td align="left" colspan="1" rowspan="1" style="width: 30%">Scout Wizards</td> |
| <td align="center" colspan="1" rowspan="1" style="width: 40%"></td> |
| <td align="right" colspan="1" rowspan="1" style="width: 30%">New Form Wizard</td> |
| </tr> |
| </table> |
| <div id="header"> |
| </div> |
| <div id="content"> |
| <div class="sect3"> |
| <h4 id="new-scout-project-wizard"><a class="anchor" href="#new-scout-project-wizard"></a>New Scout Project Wizard</h4> |
| <div class="paragraph"> |
| <p>The <em>New Scout Project</em> wizard can be used to create a new Scout project from scratch.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To open the wizard press <span class="keyseq"><kbd>Ctrl</kbd>+<kbd>N</kbd></span> or use <span class="menuseq"><span class="menu">File</span> ▸ <span class="submenu">New</span> ▸ <span class="menuitem">Other…​</span></span> and type "<em>Scout</em>" into the <strong>Wizards</strong> search field. Then, select the entry "<em>Scout Project</em>" and click on <b class="button">Next</b>. This leads to the initial dialog of the <em>New Scout Project</em> wizard as shown in <a href="#img-sdk_wizard_project">Figure 1</a>.</p> |
| </div> |
| <div id="img-sdk_wizard_project" class="imageblock"> |
| <div class="content"> |
| <img src="images/sdk_new_project.png" alt="sdk new project"> |
| </div> |
| <div class="title"> |
| Figure 1. The new Project Wizard |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>A detailed description of the indiviudal wizard fields of <a href="#img-sdk_wizard_project">Figure 1</a> is provided in the next section.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By clicking on the <b class="button">Finish</b> button the wizard is started and a new Scout client server application is created in the form of a Maven multi-module project.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="wizard-fields-and-default-values"><a class="anchor" href="#wizard-fields-and-default-values"></a>Wizard Fields and Default Values</h5> |
| <div class="paragraph"> |
| <p>All fields of the <a href="#img-sdk_wizard_project">Figure 1</a> are initially filled with default values.</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1"> |
| Group Id |
| </dt> |
| <dd> |
| <p>Maven groupId used for all created projects. The default value is <code>org.eclipse.scout.apps</code>.</p> |
| </dd> |
| <dt class="hdlist1"> |
| Artifact Id |
| </dt> |
| <dd> |
| <p>Maven artifactId for the parent project. The additional projects are derived from this name. The default value is <strong>helloworld</strong>.</p> |
| </dd> |
| <dt class="hdlist1"> |
| Display Name |
| </dt> |
| <dd> |
| <p>The name of the application presented to the user. This name is shown in the Browser title bar. The default value is <em>"My Application"</em></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>With the <em class="element">Project Location</em> group box, you can control where the project will be created. Unchecked the <em class="element">Use default Workspace location</em> checkbox to enter an other value in the <em class="element">Target Directory</em> Field. The <b class="button">Browse…​</b> button can help you to find the appropriate path.</p> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="created-components"><a class="anchor" href="#created-components"></a>Created Components</h5> |
| <div class="paragraph"> |
| <p>With the <a href="#img-sdk_wizard_project">Figure 1</a> wizard a complete Maven multi-module project is created. Using the default artifact Id <strong>helloworld</strong> the following Maven modules are created.</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Maven module <strong>helloworld</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Contains the project’s parent <code>pom.xml</code> file</p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>Maven module <strong>helloworld.client</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Contains model components of the client application in <code>src/main/java</code> and model tests in <code>src/test/java</code>.</p> </li> |
| <li> <p>The class <code>HelloWorldForm</code> in package <code>org.eclipse.scout.apps.helloworld.client.helloworld</code> is an example of a model class.</p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>Maven module <strong>helloworld.shared</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Contains components needed in both the client and the server application.</p> </li> |
| <li> <p>For examples see the <code>IHelloWorldService</code> interface in <code>src/main/java</code> and class <code>HelloWorldFormData</code> in <code>src/generated/java</code>.</p> </li> |
| <li> <p>The <code>Texts.nls</code> file that can be opened in the <a href="sdk_editor_nls.html">Scout NLS Editor</a>.</p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>Maven module <strong>helloworld.server</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Contains the model components of the server application in <code>src/main/java</code> and model tests in <code>src/test/java</code>.</p> </li> |
| <li> <p>The class <code>HelloWorldService</code> in package <code>org.eclipse.scout.apps.helloworld.server.helloworld</code> is an example of such a model class.</p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>Maven module <strong>helloworld.server.app.dev</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Contains all components to run the Scout server application from within the Eclipse IDE.</p> </li> |
| <li> <p>The file <code>config.properties</code> in folder <code>src/main/resources</code> contains the development configuration for the Scout server application.</p> </li> |
| <li> <p>The file <code>pom.xml</code> bundles the Jetty web server with the server application.</p> </li> |
| <li> <p>The file <code>[webapp] dev server.launch</code> contains the launch configuration for the Eclipse IDE.</p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>Maven module <strong>helloworld.server.app.war</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Contains all components to create a Scout server WAR file to deploy to an external web server.</p> </li> |
| <li> <p>The file <code>config.properties</code> in folder <code>src/main/resources</code> contains the server configuration.</p> </li> |
| <li> <p>The file <code>pom.xml</code> is used to build the Scout server WAR file.</p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>Maven module <strong>helloworld.ui.html</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Contains servlet filters and the HTML pages as well as custom CSS and JavaScript files for the Scout UI Server.</p> </li> |
| <li> <p>See class <code>UiServletFilter</code> in <code>src/main/java</code> and folder <code>WebContent</code> in <code>source/main/resources</code>.</p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>Maven module <strong>helloworld.ui.html.app.dev</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Contains all components to run the Scout UI application from within the Eclipse IDE.</p> </li> |
| <li> <p>The file <code>config.properties</code> in folder <code>src/main/resources</code> contains the development configuration for the application.</p> </li> |
| <li> <p>The file <code>web.xml</code> in folder <code>src/main/webapp</code> contains the web configuration for the application.</p> </li> |
| <li> <p>The file <code>pom.xml</code> bundles the Jetty web server with the application.</p> </li> |
| <li> <p>The file <code>[webapp] dev ui.launch</code> contains the launch configuration for the Eclipse IDE.</p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>Maven module <strong>helloworld.ui.html.app.war</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>Contains all components to create a Scout UI WAR file to deploy to an external web server.</p> </li> |
| <li> <p>The file <code>config.properties</code> in folder <code>src/main/resources</code> contains the application configuration.</p> </li> |
| <li> <p>The file <code>web.xml</code> in folder <code>src/main/webapp</code> contains the web configuration.</p> </li> |
| <li> <p>The file <code>pom.xml</code> is used to build the Scout UI WAR file.</p> </li> |
| </ul> |
| </div> </li> |
| </ul> |
| </div> |
| <hr> |
| <div class="paragraph"> |
| <p>Go back to the <a href="sdk_wizard.html">Scout Wizards</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Do you want to improve this document? Have a look at the <a href="https://github.com/BSI-Business-Systems-Integration-AG/org.eclipse.scout.docs/blob/releases/7.0.x/docs/build/eclipse_help/src/docs/sdk_wizard_project.adoc" target="_blank">sources</a> on GitHub.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <table border="0" class="navigation" style="width: 100%;" summary="navigation"> |
| <tr> |
| <td align="left" colspan="1" rowspan="1" style="width: 30%"><a href="sdk_wizard.html" shape="rect" title="Scout Wizards"><img alt="Previous" border="0" src="images/prev.gif"></a></td> |
| <td align="center" colspan="1" rowspan="1" style="width: 40%"><a href="scout_user_guide.html" shape="rect" title="Eclipse Scout User Guide"><img alt="Eclipse Scout User Guide" border="0" src="images/home.gif"></a></td> |
| <td align="right" colspan="1" rowspan="1" style="width: 30%"><a href="sdk_wizard_form.html" shape="rect" title="New Form Wizard"><img alt="Next" border="0" src="images/next.gif"></a></td> |
| </tr> |
| <tr> |
| <td align="left" colspan="1" rowspan="1" style="width: 30%">Scout Wizards</td> |
| <td align="center" colspan="1" rowspan="1" style="width: 40%"></td> |
| <td align="right" colspan="1" rowspan="1" style="width: 30%">New Form Wizard</td> |
| </tr> |
| </table> |
| <div id="footer"> |
| <div id="footer-text"> |
| Version 7.0 |
| <br> Last updated 2017-05-26 14:49:24 CEST |
| </div> |
| </div> |
| </body> |
| </html> |
