December 2009 - jbosstools-commits

JBoss Tools SVN: r19311 - branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-16 09:58:22 -0500 (Wed, 16 Dec 2009) New Revision: 19311 Modified: branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating master_output.xml; Modified: branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en/master_output.xml 2009-12-16 14:57:52 UTC (rev 19310) +++ branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en/master_output.xml 2009-12-16 14:58:22 UTC (rev 19311) @@ -20,455 +20,455 @@ <!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> <!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> -]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> - <bookinfo> - <title>Exadel Studio Migration Guide</title> - - <pubdate>April 2008</pubdate> - <copyright> - <year>2007</year> - <year>2009</year> - <holder><diffmk:wrapper diffmk:change="changed">JBoss by Red Hat</diffmk:wrapper></holder> - </copyright> - <releaseinfo><diffmk:wrapper diffmk:change="changed"> -Version: 2.1.0.GA -</diffmk:wrapper></releaseinfo> - -<abstract> - <title></title> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/Exadel-migration/pdf...">PDF version</ulink> - </para> -</abstract> - - - </bookinfo> - - <toc></toc> - -<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/introduction.xml" xreflabel="introduction"> - <?dbhtml filename="introduction.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>JBDS</keyword> - <keyword>Exadel Studio Pro</keyword> - </keywordset> - </chapterinfo> - - <title>Introduction </title> - <para>This document is intended to help you to migrate an existing Exadel JSF or Struts projects - into <property moreinfo="none">JBoss Developer Studio</property>. Preferences can be exported from Eclipse 3.2.0 - (3.2.1 or 3.2.2) and imported in Eclipse 3.4.x by the standard Eclipse means.</para> - - <section diffmk:change="added"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Features of Projects Migration to JBoss Developer Studio</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For a start, we propose you to look through the table of main features of migrating projects to JBoss Developer Studio:</diffmk:wrapper></para> - - <table diffmk:change="added"> - - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Features of Project Migration to JBoss Developer Studio</diffmk:wrapper></title> - <tgroup cols="3" diffmk:change="added"> - - <colspec align="left" colnum="1" colwidth="2*" diffmk:change="added"></colspec> - <colspec colnum="2" colwidth="4*" diffmk:change="added"></colspec> - <colspec align="left" colnum="3" colwidth="2*" diffmk:change="added"></colspec> - - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Feature</diffmk:wrapper></entry> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Benefit</diffmk:wrapper></entry> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Chapter</diffmk:wrapper></entry> - </row> - </thead> - - <tbody diffmk:change="added"> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Import JSF Project Wizard</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">It simplifies the process of bringing your existing JSF applications into your JBoss Developer Studio workspace as JSF projects. The import is possible with *.war files.</diffmk:wrapper></para></entry> - <entry diffmk:change="added"> - <link diffmk:change="added" linkend="import_jsf"><diffmk:wrapper diffmk:change="added">Migration of JSF project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><link diffmk:change="added" linkend="jsf_war"><diffmk:wrapper diffmk:change="added">Migration of JSF project from *.war file</diffmk:wrapper></link> - </entry> - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Import Struts Project Wizard</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">It simplifies the process of bringing your existing Struts applications into your JBoss Developer Studio workspace as Struts projects. The import is possible with *.war files.</diffmk:wrapper></para></entry> - <entry diffmk:change="added"> - <link diffmk:change="added" linkend="struts_import"><diffmk:wrapper diffmk:change="added">Migration of Struts project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><link diffmk:change="added" linkend="struts_war"><diffmk:wrapper diffmk:change="added">Migration of Struts project from *.war file</diffmk:wrapper></link> - </entry> - </row> - - </tbody> - - </tgroup> - </table> - - </section> - - <section> - <title>Other relevant resources on the topic</title> - <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> - <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> - - </section> - -</chapter> - - -<chapter id="workspace" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/workspace.xml" xreflabel="workspace"> - <?dbhtml filename="workspace.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>JBDS</keyword> - <keyword>Exadel Studio Pro</keyword> - </keywordset> - </chapterinfo> - - <title>Migrate workspace</title> - <para>You will not be able to run projects in JBoss Developer Studio - using <property moreinfo="none">Exadel Studio workspace</property>. In this case, project capabilities and settings specified in Exadel Studio will be lost. The simplest way to avoid this, is to copy your projects in <property moreinfo="none">JBoss Developer Studio workspace</property> and make an import as it is described in the following chapters.</para> -</chapter> - - -<chapter id="jsf_struts" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/jsf_struts.xml" xreflabel="jsf_struts"> - <?dbhtml filename="jsf_struts.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>JBDS</keyword> - <keyword>Exadel Studio Pro</keyword> - <keyword>Migration</keyword> - </keywordset> - </chapterinfo> - - <title>Migration of JSF and Struts Projects</title> - <para>In this chapter you can find concise description of migration of JSF and Struts Projects.</para> - <section id="import_jsf"> - <title>JSF</title> - <para>JBoss Developer Studio includes an Import <property moreinfo="none">JSF Project</property> Wizard that radically simplifies the process of bringing your existing JSF applications - into your JBoss Developer Studio workspace as JSF projects. You just need to follow these four steps:</para> - <itemizedlist> - <listitem><para><emphasis><property moreinfo="none">Select File > Import...</property></emphasis> from the menu bar, and then select <emphasis><property moreinfo="none">Other > JSF Project </property></emphasis>from the Import dialog box that appears.</para></listitem> - </itemizedlist> - - <figure float="0"> - <title>Selecting the Import Menu Item</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <figure float="0"> - <title>Selecting the Import JSF Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem><para>In the first screen of the wizard, select the <emphasis><property moreinfo="none">Change...</property></emphasis> button next to the <emphasis><property moreinfo="none">web.xml Location</property></emphasis> field. Browse to the location of the web.xml file for the application you - want to import as a <property moreinfo="none">JSF project</property>. Once you select it, you'll be returned to the dialog box to see a project name derived from the web.xml file you selected. - You can edit this project name, if you wish.</para></listitem> - </itemizedlist> - - <figure float="0"> - <title>Selecting the Web.xml File in the Project Location Screen</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist id="import_jsf_screen"> - <listitem><para>In the <emphasis><property moreinfo="none">Project Folders</property></emphasis> screen, you can configure the rest of your project. Afterwards click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para></listitem> - </itemizedlist> - <para>On this step JBoss Developer Studio will try to determine your project - structure and set the values for: <emphasis><property moreinfo="none">Web Root</property></emphasis>, <emphasis><property moreinfo="none">Source Folder</property></emphasis>, <emphasis><property moreinfo="none">Classes Folder</property></emphasis>, <emphasis><property moreinfo="none">Lib Folder</property></emphasis>. If your project has a custom structure, some values might not be - set. If this is the case, you can manually set those values by clicking the <emphasis><property moreinfo="none">Change...</property></emphasis> button.</para> - <para>After dealing with these settings, you have to work through a few more configuration settings. These settings deal primarily with how the project will be deployed within JBoss Developer Studio.</para> - <para>First, if the project you are importing is not already a JSF project, select the <emphasis><property moreinfo="none">Add Libraries</property></emphasis> check box to add all the JSF-related libraries to your project. </para> - <para>Then, you may select the JavaServer Faces implementation (<emphasis><property moreinfo="none">Environment</property></emphasis>) and <emphasis><property moreinfo="none">Servlet Version</property></emphasis>.</para> - <para>The <emphasis><property moreinfo="none">Context Path</property></emphasis> is the name under which the application will be deployed. </para> - <para>The <emphasis><property moreinfo="none">Runtime</property></emphasis> value tells Eclipse where to find Web libraries in order to build the project. It is not possible to finish the importing of a project without selecting a Runtime. If you don't have any choices displayed for this, select <emphasis><property moreinfo="none">New...</property></emphasis> to add a new Runtime.</para> - <para>Finally, <emphasis><property moreinfo="none">Target Server</property></emphasis> sets the server to deploy the application under. The Target Server corresponds to the Runtime value selected above. If you don't want to deploy the application, uncheck this value.</para> - - - <figure float="0"> - <title>The Project Folders Screen</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem><para>Once the project is imported, it will appear in the Package Explorer view.</para></listitem> - </itemizedlist> - - <figure float="0"> - <title>Imported Project in the Package Explorer View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - </section> - <section id="struts_import"> - <title>Struts</title> - <itemizedlist> - <listitem><para><emphasis><property moreinfo="none">Select File > Import...</property></emphasis> from the menu bar, and then select <emphasis><property moreinfo="none">Other > Struts Project</property></emphasis> from the Import dialog box that appears.</para></listitem> - </itemizedlist> - - <figure float="0"> - <title>Selecting the Import Menu Item</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <figure float="0"> - <title>Selecting the Import Struts Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem><para>In the Project Location screen of the wizard, select the <emphasis><property moreinfo="none">Change... </property></emphasis>button next to the <emphasis><property moreinfo="none">web.xml Location</property></emphasis> field. Browse the location of the web.xml file for the application you - want to import as a <property moreinfo="none">Struts project</property>. Once you select it, you'll be returned to the dialog box to see a project name derived from the web.xml file you selected. - You can edit this project name, if you wish.</para></listitem> - </itemizedlist> - - <figure float="0"> - <title>The Project Location Screen</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_10.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem><para>In the next screen, JBoss Developer Studio will try to determine your project structure. The upper pane shows the modules in this project. - The lower pane allows you to edit the details of the select module. If the project structure is non-standard, some values might be left blank. - You can edit any values by hand or by using the <emphasis><property moreinfo="none">Change...</property></emphasis> button.</para></listitem> - </itemizedlist> - - <figure float="0"> - <title>The Project Modules Screen</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_7.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem><para>In the <emphasis><property moreinfo="none">Project Folders</property></emphasis> screen, you can configure the rest of your project. Afterwards click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para> - </listitem> - </itemizedlist> - <para>On this step JBoss Developer Studio will try to determine your project structure and set the values for: <emphasis><property moreinfo="none">Classes Folder</property></emphasis>, <emphasis><property moreinfo="none">Lib Folder</property></emphasis>, and <emphasis><property moreinfo="none">Ant Build File</property></emphasis>. If your project has a custom structure, some values might not be set. If this is the case, you can manually set those values by clicking <emphasis><property moreinfo="none">Change</property></emphasis>.</para> - <para>After dealing with these settings, you have to work through a few more configuration settings. These settings deal primarily with how the project will be deployed within JBoss Developer Studio.</para> - <para>First, if the project you are importing is not already a Struts project, select the <emphasis><property moreinfo="none">Add Libraries</property></emphasis> check box to add all the Struts-related libraries to your project. </para> - <para>Then, you may select the Struts <emphasis><property moreinfo="none">Environment</property></emphasis> and <emphasis><property moreinfo="none">Servlet Version</property></emphasis>.</para> - <para>The <emphasis><property moreinfo="none">Context Path</property></emphasis> is the name under which the application will be deployed. </para> - <para>The <emphasis><property moreinfo="none">Runtime</property></emphasis> value tells Eclipse where to find Web libraries in order to build the project. It is not possible to finish the importing of a project without selecting a Runtime. If you don't have any choices displayed for this, select<emphasis><property moreinfo="none"> New...</property></emphasis> to add a new Runtime.</para> - <para>Finally, <emphasis><property moreinfo="none">Target Server</property></emphasis> sets the server to deploy the application under. The Target Server corresponds to the Runtime value selected above. If you don't want to deploy the application, uncheck this value.</para> - - - <figure float="0"> - <title>The Project Folders Screen</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_8.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem><para>Once the project is imported, it will appear in the Package Explorer view.</para></listitem> - </itemizedlist> - - <figure float="0"> - <title>Imported Project in the Package Explorer View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts/migration_9.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - </section> -</chapter> - - -<chapter id="jsf_struts_war" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/jsf_struts_war.xml" xreflabel="jsf_struts_war"> - <?dbhtml filename="jsf_struts_war.html"?> - - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - - <keyword>JBDS</keyword> - - <keyword>Exadel Studio Pro</keyword> - </keywordset> - </chapterinfo> - - <title>Migrate JSF and Struts projects from *.war file</title> - <para>After you familiarized oneself with last chapter you can read this chapter. It looks as if you read in last chapter.</para> - <section id="jsf_war"> - <title>JSF</title> - - <itemizedlist> - <listitem> - <para>Select <emphasis><property moreinfo="none">File > Import...</property></emphasis> from the menu bar, and then select - <emphasis><property moreinfo="none">Other > JSF Project From *.war</property></emphasis> from the Import dialog box that - appears.</para> - </listitem> - </itemizedlist> - - <figure float="0"> - <title>Selecting the Import Menu Item</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts_war/migration_war_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <figure float="0"> - <title>Selecting the JSF Project From *.war Import Wizard</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts_war/migration_war_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>In the wizard screen, select the <emphasis><property moreinfo="none">Change...</property></emphasis> button next to - the <emphasis><property moreinfo="none">*.war Location</property></emphasis> field. Browse to the location of the *.war file for - the application you want to import as a JSF project. Once you select - it, you'll be returned to the dialog box to see a project name - derived from the *.war file you selected. You can edit this name, if - you wish.</para> - - <para>Uncheck the <emphasis><property moreinfo="none">Use Default Path</property></emphasis> check box if you want to import - your project outside of the Eclipse workspace. In this case, you would - use <emphasis><property moreinfo="none"> Change... </property></emphasis> button next to the <emphasis><property moreinfo="none">Location</property></emphasis> field to choose a - location.</para> - - <para><emphasis><property moreinfo="none">Context Path</property></emphasis> is the name under which the application will be - deployed.</para> - - <para>The <emphasis><property moreinfo="none">Runtime</property></emphasis> value tells Eclipse where to find Web libraries in - order to build the project. It is not possible to finish project - import without selecting Runtime. If you don't have any options - here, select <emphasis><property moreinfo="none">New...</property></emphasis> to add a new Runtime.</para> - - <para>Finally, <emphasis><property moreinfo="none">Target Server</property></emphasis> sets the server to deploy the application - under. The Target Server corresponds to the Runtime value selected - above. If you don't want to deploy the application, uncheck this - value.</para> - </listitem> - </itemizedlist> - - <figure float="0"> - <title>The JSF Project From *.war Import Wizard</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts_war/migration_war_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para> - </listitem> - </itemizedlist> - </section> - - <section id="struts_war"> - <title>Struts</title> - - <itemizedlist> - <listitem> - <para>Select <emphasis><property moreinfo="none">File > Import...</property></emphasis> from the menu bar, and then select - <emphasis><property moreinfo="none">Other > Struts Project From *.war</property></emphasis> from the Import dialog box that - appears.</para> - </listitem> - </itemizedlist> - - <figure float="0"> - <title>Selecting the Import Menu Item</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts_war/migration_war_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <figure float="0"> - <title>Selecting the Struts Project From *.war Import Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts_war/migration_war_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Follow the same steps as with the JSF Project From <property moreinfo="none">*.war</property> import - wizard.</para> - </listitem> - </itemizedlist> - - <figure float="0"> - <title>The Struts Project From *.war Import Wizard</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_struts_war/migration_war_5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para> - </listitem> - </itemizedlist> - <para>The migration process is completed</para> - - <para>If there's anything we didn't cover or you can't figure - out, please feel free to visit our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=258">JBoss Developer Studio Users Forum</ulink> or <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users Forum</ulink> to ask questions. There we are also looking for - your suggestions and comments.</para> - </section> - -</chapter> - - -</book> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>Exadel Studio Migration Guide</title> + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> +Version: 3.1.0.CR1 +</diffmk:wrapper></releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/Exadel-migration/pdf...">PDF version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + +<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/documentation/guides/Exadel-migration/en/modules/introduction.xml" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Exadel Studio Pro</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction </title> + <para>This document is intended to help you to migrate an existing Exadel JSF or Struts projects + into <property moreinfo="none">JBoss Developer Studio</property>. Preferences can be exported from Eclipse 3.2.0 + (3.2.1 or 3.2.2) and imported in Eclipse 3.4.x by the standard Eclipse means.</para> + + <section> + <title>Key Features of Projects Migration to JBoss Developer Studio</title> + <para>For a start, we propose you to look through the table of main features of migrating projects to JBoss Developer Studio:</para> + + <table> + + <title>Key Features of Project Migration to JBoss Developer Studio</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec align="left" colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry><para>Import JSF Project Wizard</para></entry> + <entry><para>It simplifies the process of bringing your existing JSF applications into your JBoss Developer Studio workspace as JSF projects. The import is possible with *.war files.</para></entry> + <entry> + <link linkend="import_jsf">Migration of JSF project</link> and <link linkend="jsf_war">Migration of JSF project from *.war file</link> + </entry> + </row> + + <row> + <entry><para>Import Struts Project Wizard</para></entry> + <entry><para>It simplifies the process of bringing your existing Struts applications into your JBoss Developer Studio workspace as Struts projects. The import is possible with *.war files.</para></entry> + <entry> + <link linkend="struts_import">Migration of Struts project</link> and <link linkend="struts_war">Migration of Struts project from *.war file</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + </section> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> + + </section> + +</chapter> + + +<chapter id="workspace" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/documentation/guides/Exadel-migration/en/modules/workspace.xml" xreflabel="workspace"> + <?dbhtml filename="workspace.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Exadel Studio Pro</keyword> + </keywordset> + </chapterinfo> + + <title>Migrate workspace</title> + <para>You will not be able to run projects in JBoss Developer Studio + using <property moreinfo="none">Exadel Studio workspace</property>. In this case, project capabilities and settings specified in Exadel Studio will be lost. The simplest way to avoid this, is to copy your projects in <property moreinfo="none">JBoss Developer Studio workspace</property> and make an import as it is described in the following chapters.</para> +</chapter> + + +<chapter id="jsf_struts" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/documentation/guides/Exadel-migration/en/modules/jsf_struts.xml" xreflabel="jsf_struts"> + <?dbhtml filename="jsf_struts.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Exadel Studio Pro</keyword> + <keyword>Migration</keyword> + </keywordset> + </chapterinfo> + + <title>Migration of JSF and Struts Projects</title> + <para>In this chapter you can find concise description of migration of JSF and Struts Projects.</para> + <section id="import_jsf"> + <title>JSF</title> + <para>JBoss Developer Studio includes an Import <property moreinfo="none">JSF Project</property> Wizard that radically simplifies the process of bringing your existing JSF applications + into your JBoss Developer Studio workspace as JSF projects. You just need to follow these four steps:</para> + <itemizedlist> + <listitem><para><emphasis><property moreinfo="none">Select File > Import...</property></emphasis> from the menu bar, and then select <emphasis><property moreinfo="none">Other > JSF Project </property></emphasis>from the Import dialog box that appears.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Import Menu Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Selecting the Import JSF Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>In the first screen of the wizard, select the <emphasis><property moreinfo="none">Change...</property></emphasis> button next to the <emphasis><property moreinfo="none">web.xml Location</property></emphasis> field. Browse to the location of the web.xml file for the application you + want to import as a <property moreinfo="none">JSF project</property>. Once you select it, you'll be returned to the dialog box to see a project name derived from the web.xml file you selected. + You can edit this project name, if you wish.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Web.xml File in the Project Location Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist id="import_jsf_screen"> + <listitem><para>In the <emphasis><property moreinfo="none">Project Folders</property></emphasis> screen, you can configure the rest of your project. Afterwards click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para></listitem> + </itemizedlist> + <para>On this step JBoss Developer Studio will try to determine your project + structure and set the values for: <emphasis><property moreinfo="none">Web Root</property></emphasis>, <emphasis><property moreinfo="none">Source Folder</property></emphasis>, <emphasis><property moreinfo="none">Classes Folder</property></emphasis>, <emphasis><property moreinfo="none">Lib Folder</property></emphasis>. If your project has a custom structure, some values might not be + set. If this is the case, you can manually set those values by clicking the <emphasis><property moreinfo="none">Change...</property></emphasis> button.</para> + <para>After dealing with these settings, you have to work through a few more configuration settings. These settings deal primarily with how the project will be deployed within JBoss Developer Studio.</para> + <para>First, if the project you are importing is not already a JSF project, select the <emphasis><property moreinfo="none">Add Libraries</property></emphasis> check box to add all the JSF-related libraries to your project. </para> + <para>Then, you may select the JavaServer Faces implementation (<emphasis><property moreinfo="none">Environment</property></emphasis>) and <emphasis><property moreinfo="none">Servlet Version</property></emphasis>.</para> + <para>The <emphasis><property moreinfo="none">Context Path</property></emphasis> is the name under which the application will be deployed. </para> + <para>The <emphasis><property moreinfo="none">Runtime</property></emphasis> value tells Eclipse where to find Web libraries in order to build the project. It is not possible to finish the importing of a project without selecting a Runtime. If you don't have any choices displayed for this, select <emphasis><property moreinfo="none">New...</property></emphasis> to add a new Runtime.</para> + <para>Finally, <emphasis><property moreinfo="none">Target Server</property></emphasis> sets the server to deploy the application under. The Target Server corresponds to the Runtime value selected above. If you don't want to deploy the application, uncheck this value.</para> + + + <figure float="0"> + <title>The Project Folders Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>Once the project is imported, it will appear in the Package Explorer view.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Imported Project in the Package Explorer View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="struts_import"> + <title>Struts</title> + <itemizedlist> + <listitem><para><emphasis><property moreinfo="none">Select File > Import...</property></emphasis> from the menu bar, and then select <emphasis><property moreinfo="none">Other > Struts Project</property></emphasis> from the Import dialog box that appears.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Import Menu Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Selecting the Import Struts Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>In the Project Location screen of the wizard, select the <emphasis><property moreinfo="none">Change... </property></emphasis>button next to the <emphasis><property moreinfo="none">web.xml Location</property></emphasis> field. Browse the location of the web.xml file for the application you + want to import as a <property moreinfo="none">Struts project</property>. Once you select it, you'll be returned to the dialog box to see a project name derived from the web.xml file you selected. + You can edit this project name, if you wish.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>The Project Location Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>In the next screen, JBoss Developer Studio will try to determine your project structure. The upper pane shows the modules in this project. + The lower pane allows you to edit the details of the select module. If the project structure is non-standard, some values might be left blank. + You can edit any values by hand or by using the <emphasis><property moreinfo="none">Change...</property></emphasis> button.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>The Project Modules Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>In the <emphasis><property moreinfo="none">Project Folders</property></emphasis> screen, you can configure the rest of your project. Afterwards click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para> + </listitem> + </itemizedlist> + <para>On this step JBoss Developer Studio will try to determine your project structure and set the values for: <emphasis><property moreinfo="none">Classes Folder</property></emphasis>, <emphasis><property moreinfo="none">Lib Folder</property></emphasis>, and <emphasis><property moreinfo="none">Ant Build File</property></emphasis>. If your project has a custom structure, some values might not be set. If this is the case, you can manually set those values by clicking <emphasis><property moreinfo="none">Change</property></emphasis>.</para> + <para>After dealing with these settings, you have to work through a few more configuration settings. These settings deal primarily with how the project will be deployed within JBoss Developer Studio.</para> + <para>First, if the project you are importing is not already a Struts project, select the <emphasis><property moreinfo="none">Add Libraries</property></emphasis> check box to add all the Struts-related libraries to your project. </para> + <para>Then, you may select the Struts <emphasis><property moreinfo="none">Environment</property></emphasis> and <emphasis><property moreinfo="none">Servlet Version</property></emphasis>.</para> + <para>The <emphasis><property moreinfo="none">Context Path</property></emphasis> is the name under which the application will be deployed. </para> + <para>The <emphasis><property moreinfo="none">Runtime</property></emphasis> value tells Eclipse where to find Web libraries in order to build the project. It is not possible to finish the importing of a project without selecting a Runtime. If you don't have any choices displayed for this, select<emphasis><property moreinfo="none"> New...</property></emphasis> to add a new Runtime.</para> + <para>Finally, <emphasis><property moreinfo="none">Target Server</property></emphasis> sets the server to deploy the application under. The Target Server corresponds to the Runtime value selected above. If you don't want to deploy the application, uncheck this value.</para> + + + <figure float="0"> + <title>The Project Folders Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>Once the project is imported, it will appear in the Package Explorer view.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Imported Project in the Package Explorer View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> +</chapter> + + +<chapter id="jsf_struts_war" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/documentation/guides/Exadel-migration/en/modules/jsf_struts_war.xml" xreflabel="jsf_struts_war"> + <?dbhtml filename="jsf_struts_war.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + + <keyword>JBDS</keyword> + + <keyword>Exadel Studio Pro</keyword> + </keywordset> + </chapterinfo> + + <title>Migrate JSF and Struts projects from *.war file</title> + <para>After you familiarized oneself with last chapter you can read this chapter. It looks as if you read in last chapter.</para> + <section id="jsf_war"> + <title>JSF</title> + + <itemizedlist> + <listitem> + <para>Select <emphasis><property moreinfo="none">File > Import...</property></emphasis> from the menu bar, and then select + <emphasis><property moreinfo="none">Other > JSF Project From *.war</property></emphasis> from the Import dialog box that + appears.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Import Menu Item</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Selecting the JSF Project From *.war Import Wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>In the wizard screen, select the <emphasis><property moreinfo="none">Change...</property></emphasis> button next to + the <emphasis><property moreinfo="none">*.war Location</property></emphasis> field. Browse to the location of the *.war file for + the application you want to import as a JSF project. Once you select + it, you'll be returned to the dialog box to see a project name + derived from the *.war file you selected. You can edit this name, if + you wish.</para> + + <para>Uncheck the <emphasis><property moreinfo="none">Use Default Path</property></emphasis> check box if you want to import + your project outside of the Eclipse workspace. In this case, you would + use <emphasis><property moreinfo="none"> Change... </property></emphasis> button next to the <emphasis><property moreinfo="none">Location</property></emphasis> field to choose a + location.</para> + + <para><emphasis><property moreinfo="none">Context Path</property></emphasis> is the name under which the application will be + deployed.</para> + + <para>The <emphasis><property moreinfo="none">Runtime</property></emphasis> value tells Eclipse where to find Web libraries in + order to build the project. It is not possible to finish project + import without selecting Runtime. If you don't have any options + here, select <emphasis><property moreinfo="none">New...</property></emphasis> to add a new Runtime.</para> + + <para>Finally, <emphasis><property moreinfo="none">Target Server</property></emphasis> sets the server to deploy the application + under. The Target Server corresponds to the Runtime value selected + above. If you don't want to deploy the application, uncheck this + value.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>The JSF Project From *.war Import Wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para> + </listitem> + </itemizedlist> + </section> + + <section id="struts_war"> + <title>Struts</title> + + <itemizedlist> + <listitem> + <para>Select <emphasis><property moreinfo="none">File > Import...</property></emphasis> from the menu bar, and then select + <emphasis><property moreinfo="none">Other > Struts Project From *.war</property></emphasis> from the Import dialog box that + appears.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Import Menu Item</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Selecting the Struts Project From *.war Import Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Follow the same steps as with the JSF Project From <property moreinfo="none">*.war</property> import + wizard.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>The Struts Project From *.war Import Wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para> + </listitem> + </itemizedlist> + <para>The migration process is completed</para> + + <para>If there's anything we didn't cover or you can't figure + out, please feel free to visit our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=258">JBoss Developer Studio Users Forum</ulink> or <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users Forum</ulink> to ask questions. There we are also looking for + your suggestions and comments.</para> + </section> + +</chapter> + + +</book>

15 years

1
0
0 / 0

JBoss Tools SVN: r19310 - branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-16 09:57:52 -0500 (Wed, 16 Dec 2009) New Revision: 19310 Modified: branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en/master.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating the plugin version; Modified: branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en/master.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en/master.xml 2009-12-16 14:57:07 UTC (rev 19309) +++ branches/jbosstools-3.1.0.RC1/documentation/guides/Exadel-migration/en/master.xml 2009-12-16 14:57:52 UTC (rev 19310) @@ -33,7 +33,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> -Version: 2.1.0.GA +Version: 3.1.0.CR1 </releaseinfo> <abstract>

15 years

1
0
0 / 0

JBoss Tools SVN: r19309 - branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-16 09:57:07 -0500 (Wed, 16 Dec 2009) New Revision: 19309 Added: branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - adding master_output.xml; Added: branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en/master_output.xml (rev 0) +++ branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en/master_output.xml 2009-12-16 14:57:07 UTC (rev 19309) @@ -0,0 +1,510 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY overview SYSTEM "modules/overview.xml"> +<!ENTITY install SYSTEM "modules/install.xml"> +<!ENTITY detail SYSTEM "modules/detail.xml"> +<!ENTITY deploy SYSTEM "modules/deploy.xml"> + + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JBoss BPEL User Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author> + <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author> + <pubdate>August 2009</pubdate> + <copyright> + <year>2009</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.0.0.CR1 + </diffmk:wrapper></releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/bpel_ref_guide/pdf/B...">PDF version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + +<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/overview.xml"> + <title>JBoss BPEL project Overview</title> + + <para>JBoss BPEL project is a WS-BPEL 2.0 project that gives a way to create, edit, validate and deploy BPEL files to JBoss BPEL runtime. It is based on Eclipse + <ulink url="http://www.eclipse.org/bpel/">BPEL + project </ulink>. </para> + + <para>It improves the Eclipse BPEL project in the following way: </para> + <itemizedlist> + <listitem><para> Implements close integration with JBoss BPEL runtime. Adds a new project type for the deployment to JBoss BPEL runtime.</para></listitem> + <listitem><para> Supports two ways of deployment: one way is to deploy a bpel project directly to JBoss BPEL runtime. The other way is to deploy bpel files in JBoss ESB project to JBoss BPEL runtime. </para></listitem> + <listitem><para> Improves the BPEL validator and increases Eclipse BPEL editor's quality. </para></listitem> + </itemizedlist> + + <para> + <ulink url="http://docs.oasis-open.org/wsbpel/2.0/OS/wsbpel-v2.0-OS.html">WS-BPEL 2.0</ulink> + stands for Web Service Business Process Execution Language. Like EAI, BPEL is an XML-based language, + but BPEL is more specific and targeted. A programmer uses BPEL to join sometimes + disparate functions into an integrated process, resulting in a seamless use of the Internet to + conduct business transactions ranging from simple money exchanges to complex calculations and + asset reallocation. + </para> + +<section> + <title>Key Features of JBoss BPEL project</title> + <para>Let's start with looking through the table of the main features of JBoss BPEL editor project: </para> + + <table> + + <title>Key Functionality for JBoss BPEL editor project</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + + </row> + </thead> + <tbody> + <row> + <entry><para>WS-BPEL 2.0 support</para></entry> + <entry><para>JBoss BPEL project supports the newest WS-BPEL 2.0 specifications. </para></entry> + </row> + <row> + <entry><para>Close integration with JBoss BPEL runtime</para></entry> + <entry><para>There are two ways to deploy BPEL files to JBoss BPEL runtime. + The user can deploy a BPEL project as a whole and can deploy BPEL files in + JBoss ESB project to JBoss BPEL runtime. </para></entry> + </row> + <row> + <entry><para>BPEL file editor</para></entry> + <entry><para>The user can use the editor separately to edit a BPEL file. </para></entry> + </row> + <row> + <entry><para>BPEL file validator</para></entry> + <entry><para>The validator can give the error messages about BPEL files to the user. </para></entry> + </row> + </tbody> + </tgroup> + </table> + +</section> + +</chapter> + +<chapter id="install" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/install.xml"> + <title>Installation JBoss BPEL Tools</title> + <section id="installeclipse"> + <title>Installation JBoss BPEL editor</title> + <para>At first, you need Eclipse 3.5. You can get it from <ulink url="http://www.eclipse.org/downloads/download.php?file=/technology/epp/downlo...">Eclipse Web Site</ulink>. + </para> + <para>The JBoss BPEL editor is included into JBoss Tools. + You have some methods to install JBoss Tools. + See <ulink url="http://www.jboss.org/tools/download/installation.html">Installing JBoss Tools</ulink> for more information.</para> + <para>If you want to install only the JBoss BPEL editor, you can install it from <ulink url="http://jboss.org/tools/download/dev.html">JBoss Tools</ulink> page separately. + Please, note, that only JBoss Tools 3.1 or higher version includes JBoss BPEL editor. + </para> + </section> + <section id="installRuntime"> + <title>Installation JBoss BPEL Runtime</title> + <para>If you want to deploy a BPEL project to JBoss server, + you should download JBoss BPEL Runtime by yourself. The JBoss BPEL Runtime + is named RiftSaw. You can get it from <ulink url="http://jboss.org/riftsaw">JBoss RiftSaw page </ulink>. + </para> + </section> +</chapter> + +<chapter id="detail" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/detail.xml"> + <title>Creating and editing a BPEL project</title> + <para>In the chapter we describe the necessary steps to create a new BPEL project and edit the BPEL files. + First of all, you should create a BPEL project. + </para> + <section id="createproject"> + <title>Creating a BPEL project</title> + <para>Create the project by selecting + <emphasis><property moreinfo="none">New > Project... > BPEL 2.0 > BPEL Project</property></emphasis> from the menu bar. + Then click the <property moreinfo="none">Next</property> button. + </para> + <figure float="0"> + <title>New BPEL Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createproject_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this page of the <property moreinfo="none">New BPEL Project Wizard</property> enter a project name in the <property moreinfo="none">Project Name</property> + field,e.g enter <property moreinfo="none">HelloWorld</property>.</para> + + <figure float="0"> + <title>New BPEL Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createproject_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click the <property moreinfo="none">Finish</property> button. So you have created the BPEL project named <property moreinfo="none">HelloWorld</property>. Its structure is like this: </para> + <figure float="0"> + <title>The BPEL Project structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createproject_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="createprocess"> + <title>Creating a BPEL process</title> + <para>Now you should create a BPEL process. You can create it by selecting + <emphasis><property moreinfo="none">New > Others... > BPEL 2.0 > New BPEL Process File</property></emphasis>. + </para> + <figure float="0"> + <title>New BPEL Process File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createprocess_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click the <property moreinfo="none">Next</property> button. Enter the following information:</para> + <table> + + <title>Fields and values</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <thead> + <row> + <entry>Field</entry> + <entry>Value</entry> + + </row> + </thead> + <tbody> + <row> + <entry><para>BPEL Process Name</para></entry> + <entry><para>enter a process name. For example, <property moreinfo="none">HelloWorld</property>.</para></entry> + </row> + <row> + <entry><para>Namespace</para></entry> + <entry><para>enter or select a namespace for the BPEL process.</para></entry> + </row> + <row> + <entry><para>Template</para></entry> + <entry><para>select a template for the BPEL process. When you select the template, you will see the information about the template below on the page.</para></entry> + </row> + + </tbody> + </tgroup> + </table> + + <figure float="0"> + <title>New BPEL Process File Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createprocess_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click the <property moreinfo="none">Next</property> button. On the second page make sure that the folder <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">HelloWorld/bpelContent</diffmk:wrapper></property> is selected. + Click <property moreinfo="none">Finish</property>. + </para> + <note> + <para>All of your files that are used in your BPEL project must be under the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">bpelContent</diffmk:wrapper></property> folder. Only in this case + these files can be deployed to JBoss server. + </para> + </note> + + <para>Up to now, you have got a simple BPEL process as on the screen below.</para> + <figure float="0"> + <title>A simple BPEL Process File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createprocess_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The next step, you can do is to edit the BPEL process file and then deploy it to JBoss server. </para> + </section> + <section id="editprocess"> + <title>Editing a BPEL process file</title> + <para>If the <emphasis><property moreinfo="none">Properties view</property></emphasis> and <emphasis><property moreinfo="none">Palette view</property></emphasis> are not opened, you can open the views by right-clicking the BPEL editor and selecting + <property moreinfo="none">Show in Properties</property>, <property moreinfo="none">Show Palette in Palette view</property>. Then you should have the view like this: + </para> + <figure float="0"> + <title>The BPEL editor view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>In the <emphasis><property moreinfo="none">Palette view</property></emphasis>, you can drag a BPEL element to the BPEL editor and drop it in the place you want.</para> + <para>In the <emphasis><property moreinfo="none">Properties view</property></emphasis>, you can get the information about every element of the BPEL process. + In the BPEL editor select any element you want,and then + the element's properties will be shown in the Properties view.The table below describes the tabs of the Properties view: + </para> + <table> + + <title>Tabs of the Property view</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <thead> + <row> + <entry>Tab</entry> + <entry>Description</entry> + + </row> + </thead> + <tbody> + <row> + <entry><para>Description</para></entry> + <entry><para>Shows the descriptive information about the element,e.g. <property moreinfo="none">Name</property> of the element.</para></entry> + </row> + <row> + <entry><para>Details</para></entry> + <entry><para>Shows the detailed and important information about the element. + It is the most important section of an element. + Most of the properties of an element are set in this section.</para></entry> + </row> + <row> + <entry><para>Join Behavior</para></entry> + <entry><para>Shows the <property moreinfo="none">Join Failure</property> property of the element.</para></entry> + </row> + <row> + <entry><para>Documentation</para></entry> + <entry><para>Shows the <property moreinfo="none">documentation</property> sub-element of an element.</para></entry> + </row> + <row> + <entry><para>Other</para></entry> + <entry><para>Every BPEL element has its own sections: Correlation section, Message Exchange section, and so on. We will + introduce them while using them.</para></entry> + </row> + </tbody> + </tgroup> + </table> + <para>In order to see how a simple BPEL process works in action, you should do some steps as below: </para> + <itemizedlist> + <listitem> + <para>Add an <property moreinfo="none">Assign</property> element between the <property moreinfo="none">receiveInput</property> element and <property moreinfo="none">replyOutput</property> element.</para> + </listitem> + <listitem> + <para>Click the <property moreinfo="none">Assign</property> element in the BPEL editor in order to get the properties information of it in the Properties view. + </para> + </listitem> + <listitem> + <para>In the <property moreinfo="none">Details</property> section of Properties view, you should click the <property moreinfo="none">New</property> button to add a <property moreinfo="none">copy</property> sub-element to the element. + Assign "input->payload->input" to "output->payload->result". At this time, an "<property moreinfo="none">initializer</property>" popup dialog appears. Click on the <property moreinfo="none">Yes</property> button in the dialog. + </para> + <figure float="0"> + <title>Add <property moreinfo="none">Assign</property> to the process</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Open the file "<property moreinfo="none">HelloWorldArtifacts.wsdl</property>" in the "<property moreinfo="none">HelloWorld</property>" project by double-clicking the file. Right-click the WSDL editor and select + <property moreinfo="none">Add Service</property>. A new service should appear in the editor. Name it <property moreinfo="none">HelloWorldProcessService</property>. It has the Port + named <property moreinfo="none">NewPort</property>. Select it, right-click on it and rename it to <property moreinfo="none">HelloWorldProcessPort</property> in the Properties + view. + </para> + <figure float="0"> + <title>Add <property moreinfo="none">Service</property> to the WSDL file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Right-click somewhere in the whitespace of the WSDL editor and select + <property moreinfo="none">Add Binding</property>. A new Binding component will appear in the editor. Name it <property moreinfo="none">HelloWorldSOAPBinding</property>. Select it, in the + General tab of the Properties view and select <property moreinfo="none">HelloWorld</property> as a port type in the <property moreinfo="none">PortType</property>. Then click on the + <property moreinfo="none">Generate Binding Content...</property> button to open the <property moreinfo="none">Binding Wizard</property>. In the wizard, select <property moreinfo="none">SOAP </property> + as the <property moreinfo="none">Protocol</property>. Finally, click the <property moreinfo="none">Finish</property> button to close the wizard. + </para> + <figure float="0"> + <title>Add a <property moreinfo="none">Binding</property> to the WSDL file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Click the <property moreinfo="none">HelloWorldProcessPort</property> property in the General section of the Properties view, select <property moreinfo="none">HelloWorldSOAPBinding</property> in + the <property moreinfo="none">Binding</property> combobox. In the <property moreinfo="none">Address</property> field input <ulink url="http://localhost:8080/bpel/processes/HelloWorld?wsdl">http://localhost:8080/bpel/processes/HelloWorld?wsdl</ulink>. + </para> + <figure float="0"> + <title>Add the <property moreinfo="none">HelloWorldSOAPBinding</property> to the <property moreinfo="none">HelloWorldProcessPort</property></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>Now you have finished creating a simple BPEL process.As a next step, you can deploy the BPEL project to JBoss BPEL Runtime.</para> + + </section> +</chapter> + + +<chapter id="deploy" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/deploy.xml"> + <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime</title> + <section id="createdeploy"> + <title>Creating a bpel-deploy.xml file</title> + <para>If you want to deploy a BPEL project to JBoss BPEL Runtime, you should create a bpel-deploy.xml file. + JBoss tools can help you to create it: + </para> + <itemizedlist> + <listitem> + <para>Create the bpel-deploy.xml by selecting + <emphasis><property moreinfo="none">New > Other... > BPEL 2.0 > Apache ODE Deployment Descriptor</property></emphasis>. Click the <property moreinfo="none">Next</property> button. + </para> + <figure float="0"> + <title>New BPEL Deploy file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>On the next wizard page you should enter the following information:</para> + <para><emphasis><property moreinfo="none">BPEL Project</property></emphasis>: Click the <property moreinfo="none">Browse...</property> button to select the BPEL project in your workspace which you want to deploy to the runtime. + Please note, that you should select the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">bpelContent</diffmk:wrapper></property> folder in your new BPEL project as a value of <property moreinfo="none">BPEL Project</property> field because the bpel-deploy.xml should be created in this place. + </para> + <para><emphasis><property moreinfo="none">File name</property></emphasis>: The default value is bpel-deploy.xml. Please, don't change it.</para> + <para>Click on <property moreinfo="none">Finish</property> button to close the wizard and a new bpel-deploy.xml file will be created.</para> + <figure float="0"> + <title>New BPEL Deploy file Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Double-click the bpel-deploy.xml file to open it in ODE Descriptor Deployment Editor. + In the <property moreinfo="none">Inbound Interfaces</property> section, click the + <property moreinfo="none">Associated Port</property> column and select <property moreinfo="none">HelloWorldProcessPort</property> + in the dropdown box.The <property moreinfo="none">Related Service</property> and <property moreinfo="none">Binding Used</property> + columns should be automatically filled in. Save the <emphasis><property moreinfo="none">bpel-deploy.xml</property></emphasis>. + </para> + <figure float="0"> + <title>bpel-deploy.xml file editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + </section> + <section id="createruntime"> + <title>Creating JBoss BPEL Server</title> + <para>Suppose you have installed the <property moreinfo="none">JBoss BPEL Runtime-RiftSaw</property>, now you can create a server for JBoss BPEL runtime.</para> + <itemizedlist> + <listitem> + <para>Open the <property moreinfo="none">JBoss Server view</property> by selecting + <emphasis><property moreinfo="none">Windows > Show View > Other... > Server > JBoss Server view</property></emphasis>. + </para> + </listitem> + <listitem> + <para>Right-click the JBoss Server view and select + <emphasis><property moreinfo="none">New > Server</property></emphasis> to open the New Server Wizard: + </para> + <figure float="0"> + <title>New Server Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Select <property moreinfo="none">JBoss AS 5.1 </property>as a server type. </para> + <note> + <para>Please note, that only JBoss As 5.1 or higher version supports BPEL.</para> + </note> + </listitem> + <listitem> + + <para>Click the <property moreinfo="none">Next</property> button. On the next page, you should input your <emphasis><property moreinfo="none">JBoss As</property></emphasis> location. Then click the <property moreinfo="none">Next</property> button and + you will get the page like this: + </para> + <figure float="0"> + <title>Add resource to the server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Select <property moreinfo="none">HelloWorld</property>, then click the <property moreinfo="none">Add </property> button to add the project to the server. + Then click on the <property moreinfo="none">Finish</property> button. + </para> + <para>Start the server by right-clicking on the server and selecting the <property moreinfo="none">Start</property> item. </para> + + <figure float="0"> + <title>The started server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>If some aspects of server creation is not clear, please, read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html_single/index...">JBoss Server Manager Reference Guide</ulink> for more details.</para> + </listitem> + <listitem> + <para>You can enter the link <ulink url="http://localhost:8080/bpel/processes.html">http://localhost:8080/bpel/processes.html</ulink> to the browser to get the deployed processes.</para> + <figure float="0"> + <title>The BPEL console</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>If there's anything we didn't cover or you can't figure out, please feel free to visit our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users Forum</ulink> to ask questions. + There we are also waiting for your suggestions and comments.</para> + </section> +</chapter> +</book>

15 years

1
0
0 / 0

JBoss Tools SVN: r19308 - branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-16 09:54:54 -0500 (Wed, 16 Dec 2009) New Revision: 19308 Modified: branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en/master.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating the plugin version; Modified: branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en/master.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en/master.xml 2009-12-16 14:54:14 UTC (rev 19307) +++ branches/jbosstools-3.1.0.RC1/bpel/docs/reference/en/master.xml 2009-12-16 14:54:54 UTC (rev 19308) @@ -33,7 +33,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 1.0.0 + Version: 1.0.0.CR1 </releaseinfo> <abstract> <title/>

15 years

1
0
0 / 0

JBoss Tools SVN: r19307 - trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model.

by jbosstools-commits＠lists.jboss.org

Author: vyemialyanchyk Date: 2009-12-16 09:54:14 -0500 (Wed, 16 Dec 2009) New Revision: 19307 Modified: trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/BaseElement.java trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/Connection.java trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/OrmDiagram.java trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/OrmShape.java Log: https://jira.jboss.org/jira/browse/JBIDE-5341 - update fix Modified: trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/BaseElement.java =================================================================== --- trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/BaseElement.java 2009-12-16 14:51:40 UTC (rev 19306) +++ trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/BaseElement.java 2009-12-16 14:54:14 UTC (rev 19307) @@ -155,7 +155,7 @@ } public Object getEditableValue() { - return this; + return toString(); } /** Modified: trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/Connection.java =================================================================== --- trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/Connection.java 2009-12-16 14:51:40 UTC (rev 19306) +++ trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/Connection.java 2009-12-16 14:54:14 UTC (rev 19307) @@ -286,9 +286,9 @@ } } else if (PROPERTY_CLASS_FIELD_TYPE.equals(propertyId)) { if (source.getOrmElement() instanceof Property) { - res = ((Property)(source.getOrmElement())).getType(); + res = ((Property)(source.getOrmElement())).getType().toString(); } else if (target.getOrmElement() instanceof Property) { - res = ((Property)(target.getOrmElement())).getType(); + res = ((Property)(target.getOrmElement())).getType().toString(); } } else if (PROPERTY_TABLE_FIELD_TYPE.equals(propertyId)) { if (source.getOrmElement() instanceof Column) { @@ -298,9 +298,9 @@ } } else if (PROPERTY_ASSOCIATION_TYPE.equals(propertyId)) { if (source.getOrmElement() instanceof Property) { - res = ((Property)(source.getOrmElement())).getValue(); + res = ((Property)(source.getOrmElement())).getValue().toString(); } else if (target.getOrmElement() instanceof Property) { - res = ((Property)(target.getOrmElement())).getValue(); + res = ((Property)(target.getOrmElement())).getValue().toString(); } if (res instanceof OneToOne) { res = "OneToOne"; //$NON-NLS-1$ @@ -315,7 +315,7 @@ } } else if (PROPERTY_SOURCE_CLASS_FIELD_TYPE.equals(propertyId)) { if (source.getOrmElement() instanceof Property) { - res = ((Property)(source.getOrmElement())).getType(); + res = ((Property)(source.getOrmElement())).getType().toString(); } } else if (PROPERTY_SOURCE_TABLE_FIELD.equals(propertyId)) { if (source.getOrmElement() instanceof Column) { Modified: trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/OrmDiagram.java =================================================================== --- trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/OrmDiagram.java 2009-12-16 14:51:40 UTC (rev 19306) +++ trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/OrmDiagram.java 2009-12-16 14:54:14 UTC (rev 19307) @@ -1022,13 +1022,13 @@ if (PROPERTY_NAME.equals(propertyId)) { res = getDiagramName(); } else if (PROPERTY_WIDTH.equals(propertyId)) { - res = width; + res = Integer.valueOf(width).toString(); } else if (PROPERTY_HEIGHT.equals(propertyId)) { - res = height; + res = Integer.valueOf(height).toString(); } else if (PROPERTY_ZOOM.equals(propertyId)) { - res = zoom; + res = Double.valueOf(zoom).toString(); } else if (PROPERTY_ITEMS.equals(propertyId)) { - res = elements.size(); + res = Integer.valueOf(elements.size()).toString(); } else if (PROPERTY_ENTITIES.equals(propertyId)) { int nEntities = 0; Iterator<OrmShape> it = elements.values().iterator(); @@ -1039,7 +1039,7 @@ nEntities++; } } - res = nEntities; + res = Integer.valueOf(nEntities).toString(); } else if (PROPERTY_TABLES.equals(propertyId)) { int nTables = 0; Iterator<OrmShape> it = elements.values().iterator(); @@ -1050,7 +1050,7 @@ nTables++; } } - res = nTables; + res = Integer.valueOf(nTables).toString(); } else if (PROPERTY_INVISIBLE.equals(propertyId)) { int nInvisible = 0; Iterator<OrmShape> it = elements.values().iterator(); @@ -1060,7 +1060,7 @@ nInvisible++; } } - res = nInvisible; + res = Integer.valueOf(nInvisible).toString(); } if (res == null) { res = super.getPropertyValue(propertyId); Modified: trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/OrmShape.java =================================================================== --- trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/OrmShape.java 2009-12-16 14:51:40 UTC (rev 19306) +++ trunk/hibernatetools/plugins/org.jboss.tools.hibernate.ui/src/org/jboss/tools/hibernate/ui/diagram/editors/model/OrmShape.java 2009-12-16 14:54:14 UTC (rev 19307) @@ -473,39 +473,41 @@ } if (rootClass != null) { if (ENTITY_isAbstract.equals(propertyId)) { - res = rootClass.isAbstract(); + if (rootClass.isAbstract() != null) { + res = rootClass.isAbstract().toString(); + } } else if (ENTITY_isCustomDeleteCallable.equals(propertyId)) { - res = rootClass.isCustomDeleteCallable(); + res = Boolean.valueOf(rootClass.isCustomDeleteCallable()).toString(); } else if (ENTITY_isCustomInsertCallable.equals(propertyId)) { - res = rootClass.isCustomInsertCallable(); + res = Boolean.valueOf(rootClass.isCustomInsertCallable()).toString(); } else if (ENTITY_isCustomUpdateCallable.equals(propertyId)) { - res = rootClass.isCustomUpdateCallable(); + res = Boolean.valueOf(rootClass.isCustomUpdateCallable()).toString(); } else if (ENTITY_isDiscriminatorInsertable.equals(propertyId)) { - res = rootClass.isDiscriminatorInsertable(); + res = Boolean.valueOf(rootClass.isDiscriminatorInsertable()).toString(); } else if (ENTITY_isDiscriminatorValueNotNull.equals(propertyId)) { - res = rootClass.isDiscriminatorValueNotNull(); + res = Boolean.valueOf(rootClass.isDiscriminatorValueNotNull()).toString(); } else if (ENTITY_isDiscriminatorValueNull.equals(propertyId)) { - res = rootClass.isDiscriminatorValueNull(); + res = Boolean.valueOf(rootClass.isDiscriminatorValueNull()).toString(); } else if (ENTITY_isExplicitPolymorphism.equals(propertyId)) { - res = rootClass.isExplicitPolymorphism(); + res = Boolean.valueOf(rootClass.isExplicitPolymorphism()).toString(); } else if (ENTITY_isForceDiscriminator.equals(propertyId)) { - res = rootClass.isForceDiscriminator(); + res = Boolean.valueOf(rootClass.isForceDiscriminator()).toString(); } else if (ENTITY_isInherited.equals(propertyId)) { - res = rootClass.isInherited(); + res = Boolean.valueOf(rootClass.isInherited()).toString(); } else if (ENTITY_isJoinedSubclass.equals(propertyId)) { - res = rootClass.isJoinedSubclass(); + res = Boolean.valueOf(rootClass.isJoinedSubclass()).toString(); } else if (ENTITY_isLazy.equals(propertyId)) { - res = rootClass.isLazy(); + res = Boolean.valueOf(rootClass.isLazy()).toString(); } else if (ENTITY_isLazyPropertiesCacheable.equals(propertyId)) { - res = rootClass.isLazyPropertiesCacheable(); + res = Boolean.valueOf(rootClass.isLazyPropertiesCacheable()).toString(); } else if (ENTITY_isMutable.equals(propertyId)) { - res = rootClass.isMutable(); + res = Boolean.valueOf(rootClass.isMutable()).toString(); } else if (ENTITY_isPolymorphic.equals(propertyId)) { - res = rootClass.isPolymorphic(); + res = Boolean.valueOf(rootClass.isPolymorphic()).toString(); } else if (ENTITY_isVersioned.equals(propertyId)) { - res = rootClass.isVersioned(); + res = Boolean.valueOf(rootClass.isVersioned()).toString(); } else if (ENTITY_batchSize.equals(propertyId)) { - res = rootClass.getBatchSize(); + res = Integer.valueOf(rootClass.getBatchSize()).toString(); } else if (ENTITY_cacheConcurrencyStrategy.equals(propertyId)) { res = rootClass.getCacheConcurrencyStrategy(); } else if (ENTITY_className.equals(propertyId)) { @@ -525,9 +527,11 @@ } else if (ENTITY_nodeName.equals(propertyId)) { res = rootClass.getNodeName(); } else if (ENTITY_optimisticLockMode.equals(propertyId)) { - res = rootClass.getOptimisticLockMode(); + res = Integer.valueOf(rootClass.getOptimisticLockMode()).toString(); } else if (ENTITY_table.equals(propertyId)) { - res = rootClass.getTable(); + if (rootClass.getTable() != null) { + res = rootClass.getTable().getName(); + } } else if (ENTITY_temporaryIdTableDDL.equals(propertyId)) { res = rootClass.getTemporaryIdTableDDL(); } else if (ENTITY_temporaryIdTableName.equals(propertyId)) { @@ -544,7 +548,9 @@ } else if (TABLE_name.equals(propertyId)) { res = table.getName(); } else if (TABLE_primaryKey.equals(propertyId)) { - res = table.getPrimaryKey(); + if (table.getPrimaryKey() != null) { + res = table.getPrimaryKey().getName(); + } } else if (TABLE_rowId.equals(propertyId)) { res = table.getRowId(); } else if (TABLE_schema.equals(propertyId)) { @@ -552,13 +558,13 @@ } else if (TABLE_subselect.equals(propertyId)) { res = table.getSubselect(); } else if (TABLE_hasDenormalizedTables.equals(propertyId)) { - res = table.hasDenormalizedTables(); + res = Boolean.valueOf(table.hasDenormalizedTables()).toString(); } else if (TABLE_isAbstract.equals(propertyId)) { - res = table.isAbstract(); + res = Boolean.valueOf(table.isAbstract()).toString(); } else if (TABLE_isAbstractUnionTable.equals(propertyId)) { - res = table.isAbstractUnionTable(); + res = Boolean.valueOf(table.isAbstractUnionTable()).toString(); } else if (TABLE_isPhysicalTable.equals(propertyId)) { - res = table.isPhysicalTable(); + res = Boolean.valueOf(table.isPhysicalTable()).toString(); } } if (res == null) {

15 years

1
0
0 / 0

JBoss Tools SVN: r19306 - branches/jbosstools-3.1.0.RC1/birt/docs/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-16 09:51:40 -0500 (Wed, 16 Dec 2009) New Revision: 19306 Modified: branches/jbosstools-3.1.0.RC1/birt/docs/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating master_output.xml; Modified: branches/jbosstools-3.1.0.RC1/birt/docs/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/birt/docs/en/master_output.xml 2009-12-16 14:51:10 UTC (rev 19305) +++ branches/jbosstools-3.1.0.RC1/birt/docs/en/master_output.xml 2009-12-16 14:51:40 UTC (rev 19306) @@ -7,11 +7,14 @@ <!ENTITY birt_integration_with_seam SYSTEM "modules/birt_integration_with_seam.xml"> <!ENTITY hibernate_datasource SYSTEM "modules/hibernate_datasource.xml"> <!ENTITY birt_reports_deployment SYSTEM "modules/birt_reports_deployment.xml"> +<!ENTITY framework SYSTEM "modules/framework.xml"> +<!ENTITY tasks SYSTEM "modules/tasks.xml"> +<!ENTITY links SYSTEM "modules/links.xml"> <!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> ]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> <bookinfo> - <title>Birt Plugin Integration Reference Guide</title> + <title><diffmk:wrapper diffmk:change="changed">JBoss BIRT Integration User Guide</diffmk:wrapper></title> <corpauthor> <inlinemediaobject> @@ -23,18 +26,31 @@ </imageobject> </inlinemediaobject> </corpauthor> - + + <author diffmk:change="added"><firstname diffmk:change="added"><diffmk:wrapper diffmk:change="added">Michael</diffmk:wrapper></firstname><surname diffmk:change="added"><diffmk:wrapper diffmk:change="added">Sorokin</diffmk:wrapper></surname><email diffmk:change="added"><diffmk:wrapper diffmk:change="added">msorokin(a)exadel.com</diffmk:wrapper></email></author> <author><firstname>Anastasiya</firstname><surname>Bogachuk</surname><email>abogachuk(a)exadel.com</email></author> <author><firstname>Olga</firstname><surname>Chikvina</surname></author> - <pubdate>August 2008</pubdate> + <othercredit diffmk:change="added"> + + <contrib diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + Special thanks to Snjezana Peco + </diffmk:wrapper></contrib> + + + + + </othercredit> + <copyright> <year>2008</year> <year>2009</year> <holder>JBoss by Red Hat</holder> </copyright> + + <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 1.1.0.M2 + Version: 1.1.0.CR1 </diffmk:wrapper></releaseinfo> @@ -50,7 +66,7 @@ <toc></toc> -<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/birt/docs/en/modules/introduction.xml"> +<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/introduction.xml"> <?dbhtml filename="introduction.html"?> <chapterinfo> @@ -65,6 +81,9 @@ </chapterinfo> <title>Introduction</title> + + + <section> @@ -103,87 +122,32 @@ Eclipse BIRT you'll find out in the next sections.</para> </section> -<section id="BIRT_key_features"> - <title>Key Features of BIRT</title> - <para>For a start, we propose you to look through the table of main features of BIRT plugin:</para> - <table> - - <title>Key Functionality for BIRT Plugin</title> - <tgroup cols="3"> - - <colspec align="left" colnum="1" colwidth="2*"></colspec> - <colspec colnum="2" colwidth="4*"></colspec> - <colspec align="left" colnum="3" colwidth="2*"></colspec> - - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - <entry>Chapter</entry> - </row> - </thead> - - <tbody> - - <row> - <entry><para>Integration with Seam</para></entry> - <entry><para>You can add a BIRT report to an .xhtml file or embed it in some Seam .xhtml page.</para></entry> - <entry> - <link linkend="integration">integration with Seam</link> - </entry> - </row> - - <row> - <entry><para>Hibernate ODA Data Source</para></entry> - <entry><para>Hibernate ODA Data Source for the JBoss BIRT Integration feature is completely integrated with Hibernate Tools.</para></entry> - <entry> - <link linkend="hibernate_datasource">Hibernate ODA data source</link> - </entry> - </row> - - - </tbody> - - </tgroup> - </table> - - - - - - -</section> - <section> <title>JBoss BIRT Integration Functionality Overview</title> + + <para><diffmk:wrapper diffmk:change="added"> + The key feature of JBoss BIRT Integration is the JBoss BIRT Integration Framework, which allows to integrate a BIRT report into Seam/JSF container. + The framework API reference is in the + </diffmk:wrapper><link diffmk:change="added" linkend="framework"><diffmk:wrapper diffmk:change="added">JBoss BIRT Integraion Framework API Reference</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> chapter of the guide. + </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + + This guide also covers functionality of </diffmk:wrapper><property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="added"> module which assists in + integration with BIRT. + The integration plug-in allows you to visually configure </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Data Source</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (specify a Hibernate configuration or JNDI URL), + compose HQL queries with syntax-highlighting, content-assist, formatting as well as other functionalities available in the HQL editor. + + + </diffmk:wrapper></para> - <para>This reference guide describes the one module of the <property moreinfo="none">JBoss Tools</property> project which - performs the integration with BIRT. The integration includes the following functionalities:</para> + <para><diffmk:wrapper diffmk:change="changed"> + To enable </diffmk:wrapper><property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="changed"> integration with BIRT you are intended to + have the next: + </diffmk:wrapper></para> <itemizedlist> <listitem> - <para>Hibernate ODA driver that includes a dialog to create HQL queries with - syntax-highlighting, content-assist, formatting as well as other functionalities - available in the HQL editor. There is also a possibility to add - parameters.</para> - </listitem> - <listitem> - <para>possibility to add JBoss BIRT functionality to the standard Seam web - project</para> - </listitem> - <listitem> - <para>BIRT JSF/Seam control</para> - </listitem> - <listitem> - <para>deployment of BIRT reports within web projects (Seam, JSF, etc.)</para> - </listitem> - </itemizedlist> - - <para>To enable <property moreinfo="none">JBoss Tools</property> integration with BIRT you are intended to - have the next:</para> - <itemizedlist> - <listitem> <para>Eclipse with <property moreinfo="none">JBoss Tools</property> installed (how to install <property moreinfo="none">JBoss Tools</property> on Eclipse, what dependences and versions requirements are needed reed in the <ulink diffmk:change="added" url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">JBoss Tools Installation</ulink> section)</para> @@ -205,59 +169,71 @@ </note> </section> - <section id="birt_plugin_rel_resources"> - <title>Other Relevant Resources on the Topic</title> + - <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> - <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> - </section> - </chapter> -<chapter id="birt_integration_with_seam" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/birt/docs/en/modules/birt_integration_with_seam.xml" xreflabel="birt_integration_with_seam"> - - <?dbhtml filename="birt_integration_with_seam.html"?> + +<chapter diffmk:change="added" id="tasks" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/tasks.xml" xreflabel="tasks"> + <?dbhtml filename="tasks.html"?> <chapterinfo> <keywordset> + + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse</diffmk:wrapper></keyword> <keyword>JBoss</keyword> - <keyword>BIRT</keyword> - <keyword>Seam</keyword> + <keyword><diffmk:wrapper diffmk:change="changed">JBoss Tools</diffmk:wrapper></keyword> + <keyword><diffmk:wrapper diffmk:change="changed">BIRT Integration</diffmk:wrapper></keyword> </keywordset> </chapterinfo> + + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tasks</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> In this chapter of the guide you will find information on the tasks that you can perform integrating BIRT. The required version of BIRT is 2.3.2 or greater.</diffmk:wrapper></para> + + + + + +<section diffmk:change="added" id="birt_integration_with_seam" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/birt_integration_with_seam.xml"> <title>Adding BIRT Functionality to Standard Seam Web Project</title> - <para>In this chapter you'll know how to create a Seam web project with BIRT - capabilities included.</para> + <para><diffmk:wrapper diffmk:change="changed">In this section you'll know how to integrate BIRT into a Seam web project. </diffmk:wrapper></para> - <para>You are supposed to have Seam runtime and JBoss Application Server downloaded and - extracted somewhere on you hard drive.</para> + <para><diffmk:wrapper diffmk:change="added">You are supposed to have Seam runtime and JBoss Application Server downloaded and + extracted on your hard drive. + You can download Seam from the + </diffmk:wrapper><ulink diffmk:change="added" url="http://seamframework.org/Download"><diffmk:wrapper diffmk:change="added">Seam Framework</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> web page and + JBoss Application Server from </diffmk:wrapper><ulink diffmk:change="added" url="http://jboss.org/jbossas/downloads/"><diffmk:wrapper diffmk:change="added">JBoss Application Server</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> official site. + + </diffmk:wrapper></para> <tip> <title>Tip:</title> - <para>We used<ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i...">JBoss Seam 2.0.1 GA</ulink> and <ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i...">JBoss Application Server 4.2.2 GA</ulink> in examples of this guide.</para> + <para><diffmk:wrapper diffmk:change="changed">We used </diffmk:wrapper><ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i...">JBoss Seam 2.0.1 GA</ulink> and <ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i...">JBoss Application Server 4.2.2 GA</ulink> in examples of this guide.</para> </tip> <section id="creatin_project_with_birt"> <title>Creating Seam Web Project with Birt Facet</title> - <para>First, open <property moreinfo="none">Seam perspective</property> by going to <emphasis> - <property moreinfo="none">Window > Open Perspective > Other > Seam</property>. - </emphasis> To create a new Seam Web project follow to <emphasis> + <para><diffmk:wrapper diffmk:change="changed">We recommend to open </diffmk:wrapper><property moreinfo="none">Seam perspective</property> by going to <emphasis> + <property moreinfo="none">Window > Open Perspective > Other > Seam</property></emphasis><diffmk:wrapper diffmk:change="changed"> , this way you will have all the tools to work with Seam at hand. + To create a new Seam Web project navigate to </diffmk:wrapper><emphasis> <property moreinfo="none">File > New > Seam Web Project</property> - </emphasis> (or <emphasis> + </emphasis><diffmk:wrapper diffmk:change="changed">. Otherwise you should go to </diffmk:wrapper><emphasis> + <property moreinfo="none">File > New > Other > Seam > Seam Web Project</property> - </emphasis> if you are not in the <property moreinfo="none">Seam perspective</property>).</para> + </emphasis><diffmk:wrapper diffmk:change="changed"> if </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Seam</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> perspective is not active.</diffmk:wrapper></para> - <para>On the first wizard page enter the project name, then specify the target runtime and - target server. In the <emphasis> - <property moreinfo="none">Configuration</property> - </emphasis> section click <emphasis> - <property moreinfo="none">Modify</property> - </emphasis> to configure the project facets.</para> - - <figure float="0"> + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the first wizard page enter the project name, then specify the target runtime and + target server. We recommend to use JBoss AS server and runtime environment to ensure best performance. + </diffmk:wrapper></para> + + + <figure float="0" id="CreatingSeamWebProject"> <title>Creating Seam Web Project</title> <mediaobject> <imageobject> @@ -265,12 +241,17 @@ </imageobject> </mediaobject> </figure> - - <para>Choose the 2.0 version of the <emphasis> + </listitem> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Configuration</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> group choose the version of </diffmk:wrapper><emphasis> <property moreinfo="none">Seam</property> - </emphasis> facet and enable the <emphasis> + </emphasis><diffmk:wrapper diffmk:change="added"> framework you are planning to use in your application. In this guide we used Seam 2.2. </diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Modify</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> button + and enable the </diffmk:wrapper><emphasis> <property moreinfo="none">Birt Reporting Runtime Component</property> - </emphasis> facet.</para> + </emphasis><diffmk:wrapper diffmk:change="changed"> facet by checking the appropriate option.</diffmk:wrapper></para> <figure float="0"> <title>Adding the Birt Reporting Runtime Component Facet </title> @@ -280,582 +261,544 @@ </imageobject> </mediaobject> </figure> - - <para>Or you can just choose the <emphasis> - <property moreinfo="none">JBoss BIRT Integration Web Project</property> - </emphasis> configuration.</para> - - <figure float="0"> - <title>Choosing the JBoss BIRT Integration Web Project Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/projectBirtConfiguration.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Next three pages are filled out with defaults, just leave them through by pressing <emphasis> - <property moreinfo="none">Next</property>.</emphasis> On the <emphasis> - <property moreinfo="none">Seam Facet</property> - </emphasis> page you should specify the Seam runtime and Connection profile.</para> - - <figure float="0"> - <title>Configuring the Seam Facet settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/seamFacet.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - + <para><diffmk:wrapper diffmk:change="changed">Alternatively you can just choose the </diffmk:wrapper><emphasis> + <property moreinfo="none">JBoss BIRT Integration Web Project</property> + </emphasis><diffmk:wrapper diffmk:change="added"> configuration from the drop-down list in the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Configuration</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> group </diffmk:wrapper></para> + + <figure float="0"> + <title>Choosing the JBoss BIRT Integration Web Project Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/birt_integration_with_seam/projectBirtConfiguration.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </listitem> + + + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="changed">You may leave the next two pages with default values, just press </diffmk:wrapper><emphasis><property moreinfo="none">Next</property></emphasis><diffmk:wrapper diffmk:change="added"> to proceed. + </diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><emphasis><property moreinfo="none">Birt Configuration</property></emphasis><diffmk:wrapper diffmk:change="changed"> page you can modify the BIRT deployment settings, which you can edit afterwards in the web.xml of the generated project. Let's keep the default values for now. + </diffmk:wrapper></para> + + <figure float="0"> + <title>Configuring BIRT Deployment Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/birt_integration_with_seam/birtDeploymentSettings.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + + </listitem> + + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="changed">You can also leave the </diffmk:wrapper><emphasis><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JSF Capabilities</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page with default values. </diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none">Seam Facet</property> + </emphasis><diffmk:wrapper diffmk:change="added"> page you should specify the Seam runtime and Connection profile. Please note, that the Seam runtime must be of the version you initially specified in the project settings (See the </diffmk:wrapper><link diffmk:change="added" linkend="CreatingSeamWebProject"><diffmk:wrapper diffmk:change="added">Creating Seam Web Project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> figure). </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> When creating a Seam project with BIRT capabilities you can use the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">BIRT Classic Models Sample Database</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> connection profile to work with the BIRT sample database.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For more details on how to configure database connection for a Seam project please read the + </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/3.0.0.GA/en/seam/html_single/index.html#seamF..."><diffmk:wrapper diffmk:change="added">Configure Seam Facet Settings</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> chapter of Seam Dev Tools Reference Guide.</diffmk:wrapper></para> + <figure float="0"> + <title>Configuring the Seam Facet settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/birt_integration_with_seam/seamFacet.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </listitem> + + + <listitem diffmk:change="added"> <para>Hit <emphasis> <property moreinfo="none">Finish</property> - </emphasis> to create the project with Birt functionality enabled.</para> + </emphasis><diffmk:wrapper diffmk:change="changed"> to create the project with BIRT functionality enabled.</diffmk:wrapper></para> + </listitem> + </orderedlist> </section> <section id="integration"> <title>Integration with Seam</title> +<para><diffmk:wrapper diffmk:change="changed"> + In the previous section you have created a Seam project with BIRT capabilities. + Now you can create a simple kick start project to see that everything is configured correctly. +</diffmk:wrapper></para> + + + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="added">Now create a BIRT report file and insert test data into the file. + Name the report file </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.rptdesign</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, the report should print the data from the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> table of the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">BIRT Classic Models Sample Database</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, namely: customer number (</diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.CUSTOMERNAME</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">), + contact person first name ( </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.CONTACTFIRSTNAME</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">) , + contact person last name (</diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.CONTACTLASTNAME</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">) and + contact person phone number(</diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.PHONE</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">). + </diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="added">The title of the report should be set via </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">reportTitle</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> parameter</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="added"> + As this guide is primarily focused on the BIRT integration and not the BIRT technology itself we will not show the steps required to make the report. If you do not feel strong about creating a BIRT report file please read </diffmk:wrapper><ulink diffmk:change="added" url="http://eclipse.org/birt/phoenix/tutorial/"><diffmk:wrapper diffmk:change="added">BIRT documentation</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. + </diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="added">You can download the file </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.rptdesign</diffmk:wrapper></property> <ulink diffmk:change="added" url="files/helloBirt.rptdesign"><diffmk:wrapper diffmk:change="added">here</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> and copy it to the WebContent folder of your Seam project.</diffmk:wrapper></para> + + </listitem> + + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="added"> + When you are done with the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.rptdesign</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file, you should create a </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file that will contain the BIRT report you have just created. + </diffmk:wrapper></para> + + + <para><diffmk:wrapper diffmk:change="added"> + The JBoss BIRT Integration framework provides 2 components represented as </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:param></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> tags. The jboss-seam-birt.jar library implements the functionality of the components. To find more information about the framework pleas read the </diffmk:wrapper><link diffmk:change="added" linkend="framework"><diffmk:wrapper diffmk:change="added">JBoss BIRT Integraion Framework API Reference</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> chapter. + To use that tags on the page you need to declare the tag library and define the name space like this: + </diffmk:wrapper></para> - <para>The JBoss BIRT Integration feature contains the BIRT tag that allows the user to add a - BIRT report to an <emphasis> - <property moreinfo="none">.xhtml</property> - </emphasis> file:</para> - - <programlisting format="linespecific" role="XHTML"><![CDATA[<p:birt xmlns:ui="http://java.sun.com/jsf/facelets" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:p="http://jboss.com/products/seam/birt" - designType="run" - format="pdf" - designName="test.rptdesign" - title="JBoss Birt Test"> -</p:birt>]]></programlisting> + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + xmlns:b="http://jboss.com/products/seam/birt" + ]]></diffmk:wrapper></programlisting> - <para>Let's look how it works.</para> - <para>Create in the <emphasis> - <property moreinfo="none">Web Content</property> - </emphasis> folder three <emphasis> - <property moreinfo="none">.xhtml</property> - </emphasis> pages with the following content:</para> + <para><diffmk:wrapper diffmk:change="changed"> + The </diffmk:wrapper> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></para><diffmk:wrapper diffmk:change="added"> is a container for a BIRT report, that helps you integrate the report into Seam environment. + You can manage the properties of the report using the attributes of the </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> tag. + </diffmk:wrapper></listitem> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + + The </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:param></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> tag describes report parameters. To set a parameter you need to specify it's name the value you want to pass. + You can use EL expressions to bind the representation layer with back-end logic. + </diffmk:wrapper></para> + + </orderedlist> - <itemizedlist> - <listitem> - <para> - <emphasis> - <property moreinfo="none">birttests.xhtml</property>:</emphasis> - </para> - <programlisting format="linespecific" role="XHTML"><![CDATA[<!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - <ui:composition xmlns="http://www.w3.org/1999/xhtml" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:ui="http://java.sun.com/jsf/facelets" xmlns:f="http://java.sun.com/jsf/core" - xmlns:h="http://java.sun.com/jsf/html" - xmlns:rich="http://richfaces.org/rich" - template="layout/template.xhtml"> + - <ui:define name="body"> - <h:messages globalOnly="true" styleClass="message"/> - <rich:panel> - <f:facet name="header">Welcome to JBoss BIRT!</f:facet> - <ul> - <li><s:link view="/testbirt.xhtml" value="Test Birt" /></li> - <li><s:link view="/testbirt1.xhtml" value="Test Birt 1" /></li> - </ul> - </rich:panel> - </ui:define> - </ui:composition>]]></programlisting> - </listitem> - <listitem> - <para> - <emphasis> - <property moreinfo="none">testbirt.xhtml</property>:</emphasis> - </para> - <programlisting format="linespecific" role="XHTML"><![CDATA[<p:birt xmlns:ui="http://java.sun.com/jsf/facelets" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:p="http://jboss.com/products/seam/birt" - designType="run" - format="pdf" - designName="test.rptdesign" - title="JBoss Birt Test"> - - <p:param name="sample" value="sample param"/> -</p:birt>]]></programlisting> - </listitem> - <listitem> - <para> - <emphasis> - <property moreinfo="none">testbirt1.xhtml</property>:</emphasis> - </para> - <programlisting format="linespecific" role="XHTML"><![CDATA[<p:birt xmlns:ui="http://java.sun.com/jsf/facelets" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:p="http://jboss.com/products/seam/birt" - designType="frameset" - designName="test1.rptdesign" - title="JBoss Birt Test"> -</p:birt>]]></programlisting> - </listitem> - </itemizedlist> + + <listitem diffmk:change="added"> + + + <para><diffmk:wrapper diffmk:change="added">Create the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file in the WebContent with the following content: </diffmk:wrapper></para> + + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[... +<!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<ui:composition xmlns="http://www.w3.org/1999/xhtml" + xmlns:s="http://jboss.com/products/seam/taglib" + xmlns:ui="http://java.sun.com/jsf/facelets" + xmlns:rich="http://richfaces.org/rich" + xmlns:b="http://jboss.com/products/seam/birt" + template="layout/template.xhtml"> + <ui:define name="body"> + <rich:panel> + <b:birt designType="embed" designName="helloBirt.rptdesign" + embeddable="true"> + <b:param name="reportTitle" value="Customers Contacts" /> + </b:birt> + </rich:panel> + </ui:define> +</ui:composition> +...]]></diffmk:wrapper></programlisting> + + <para><diffmk:wrapper diffmk:change="changed">From this listing above you see that the title of the report is set via </diffmk:wrapper> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:param></diffmk:wrapper></property></para><diffmk:wrapper diffmk:change="added"> by setting the parameter name and defining the </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">"value"</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> attribute with the "Customers Contacts" value.</diffmk:wrapper></listitem> + <listitem> + <para><diffmk:wrapper diffmk:change="added">We have created a Seam project and inserted the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> report into the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view file.</diffmk:wrapper></para> - <para>Now start the application server by clicking the <emphasis> - <property moreinfo="none">Start</property> - </emphasis> option in the context menu of the server in the <property moreinfo="none">JBoss Server - View</property> (if the view isn't open go to <emphasis> - <property moreinfo="none">Window > Show View > Other > JBoss Server - View</property>)</emphasis>. Try the tests out by accessing <emphasis> - <property moreinfo="none">http://localhost:8080/hellobirt/birttests.seam</property> - </emphasis> in your web browser.</para> - <figure float="0"> - <title>Welcome Page in the Browser</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/birttestsPage.png"></imagedata> - </imageobject> - </mediaobject> - </figure> +<para><diffmk:wrapper diffmk:change="added">To see that the application works correctly and as you expect, you need to launch it on the server.</diffmk:wrapper></para> + </listitem> + <listitem><para><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Server View </diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (If it is not open navigate to </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Windows > Show View > Other > JBoss Server View </diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">), select the server the application is deployed to and hit the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Start</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. </diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="added">When the server is started, open your favourite browser and point it to </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/HelloBirt/helloBirt.seam</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> .</diffmk:wrapper></para> - <para>Now if you click <emphasis> - <property moreinfo="none">Test Birt</property> - </emphasis> you should see the following <emphasis> - <property moreinfo="none">.pdf</property> - </emphasis> file:</para> - <figure float="0"> - <title>After Clicking Test Birt</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/testbirtPage.png"></imagedata> - </imageobject> - </mediaobject> - </figure> +<figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Integrating BIRT into Seam Project</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata diffmk:change="added" fileref="images/birt_integration_with_seam/helloBirtproject.png"></imagedata> + </imageobject> + </mediaobject> +</figure> + </listitem> + </section> + </section> + <section id="hibernate_datasource"> - <para>After clicking <emphasis> - <property moreinfo="none">Test Birt 1</property> - </emphasis> the next page is displayed:</para> - <figure float="0"> - <title>After Clicking Test Birt 1</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/testbirt1Page1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <title>Using Hibernate ODA Data Source</title> - <para>Put the <emphasis> - <property moreinfo="none">test param</property> - </emphasis> as Sample Parameter value, specify the maximum possible Customer Number as - <emphasis> - <property moreinfo="none">1001</property>,</emphasis> for instance, and then press <emphasis> - <property moreinfo="none">Ok</property>.</emphasis> You'll see the following BIRT - report:</para> + <para>The JBoss BIRT Integration feature includes the Hibernate ODA Data Source which is completely + integrated with Hibernate Tools. You can use it the way as you would use any of BIRT ODA drivers. - <figure float="0"> - <title>BIRT Report in the Browser Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/testbirt1Page2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + </para> - <para>The BIRT tag recognizes most of the parameters described on <ulink url="http://www.eclipse.org/birt/phoenix/deploy/viewerUsage2.2.php#parameters">the - BIRT Report Viewer Parameters page</ulink>. The attributes of the BIRT tag - don't contain the <emphasis> - <property moreinfo="none">"__"</property> - </emphasis> prefix.</para> +<orderedlist> + <listitem> + <para>First, you need to reverse engineer from the database to generate Seam entities. You can perform this operation going to <emphasis> + <property>File > New > Seam Generate Entities</property> + </emphasis> in the <property>Seam perspective</property>. More details on the Seam Generate + Entities please read <ulink + url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind..." + >Seam Dev Tools Reference guide</ulink>). + In this guide we will use the <property>Employees</property> table of the <property>DATAMODELS</property> database. +</para> - <para>The <emphasis> - <property moreinfo="none">param</property> - </emphasis> tag describes report parameters (see the listing for the <emphasis> - <property moreinfo="none">testbirt.xhtml</property> - </emphasis> above). It supports the following attributes: </para> - <itemizedlist> - <listitem> - <para><emphasis> - <property moreinfo="none">name</property> - </emphasis> - the parameter name (required)</para> - </listitem> - <listitem> - <para><emphasis> - <property moreinfo="none">value</property> - </emphasis> - the parameter value (required)</para> - </listitem> - <listitem> - <para><emphasis> - <property moreinfo="none">isnull</property> - </emphasis> - specifies that a report parameter has a null value - (optional)</para> - </listitem> - <listitem> - <para><emphasis> - <property moreinfo="none">islocale</property> - </emphasis> - specifies whether the parameter is localized (optional)</para> - </listitem> - </itemizedlist> - - <para>These tags are defined in the <emphasis> - <property moreinfo="none">org.jboss.birt.core/resources/jboss-seam-birt.jar</property> - </emphasis> library that contains source. </para> - - <para>It is also possible to embed a BIRT report in some Seam <emphasis> - <property moreinfo="none">.xhtml</property> - </emphasis> page. See how it may be done:</para> - <para></para> - - <para> - <emphasis role="bold">Example:</emphasis> - </para> - <programlisting format="linespecific" role="XHTML"><![CDATA[<!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<ui:composition xmlns="http://www.w3.org/1999/xhtml" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:ui="http://java.sun.com/jsf/facelets" - xmlns:f="http://java.sun.com/jsf/core" - xmlns:h="http://java.sun.com/jsf/html" - xmlns:rich="http://richfaces.org/rich" - xmlns:b="http://jboss.com/products/seam/birt" - template="layout/template.xhtml"> - <ui:define name="body"> - <h:messages globalOnly="true" styleClass="message" id="globalMessages"/> - <rich:panel> - <f:facet name="header">Products</f:facet> - <b:birt designType="embed" designName="ProductCatalog.rptdesign" - embeddable="true" masterpage="false"/> - <div style="clear:both"/> - </rich:panel> - <div class="actionButtons"> - <s:button view="/ProductsEdit.xhtml" id="edit" value="Edit"/> - - <s:button view="/#{empty productsFrom ? 'ProductsList' : productsFrom}.xhtml" - id="done" value="Done"/> - </div> - </ui:define> -</ui:composition>]]></programlisting> - - <para>See the result in a Browser:</para> - - <figure float="0"> - <title>Embedding BIRT Report in Seam xhtml Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/embeddedReportInSeamPage.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - </section> -</chapter> - - -<chapter id="hibernate_datasource" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/birt/docs/en/modules/hibernate_datasource.xml" xreflabel="hibernate_datasource"> - - <?dbhtml filename="hibernate_datasource.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss</keyword> - <keyword>BIRT</keyword> - <keyword>Seam</keyword> - </keywordset> - </chapterinfo> - - <title>Hibernate ODA Data Source</title> - - <para>The JBoss BIRT Integration feature includes the Hibernate ODA Data Source completely - integrated with Hibernate Tools. You can use it in the way you use any of BIRT ODA drivers. - Let's perform simple actions that demonstrate it.</para> - - <para>First, run the <emphasis> - <property moreinfo="none">Seam Generate Entities</property> - </emphasis> action (You can access it from <emphasis> - <property moreinfo="none">File > New > Seam Generate Entities</property> - </emphasis> in the <property moreinfo="none">Seam perspective</property>. More details on the Seam Generate - Entities read in our <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind...">Seam Dev Tools Reference guide</ulink>). This action will create a Hibernate Console - configuration.</para> - <tip> <title>Tip:</title> <para>Before performing Seam Generate Entities, you should have a connection profile - adjusted and connected to a database. How to do this see in the <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind...">CRUD Database Application</ulink> chapter of the Seam Dev Tools Reference - guide.</para> + adjusted and connected to a database. How to do this see in the <ulink + url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind..." + >CRUD Database Application</ulink> chapter of the Seam Dev Tools Reference + guide.</para> + <para> + If you followed the steps described in the + <link linkend="birt_integration_with_seam">Adding BIRT Functionality to Standard Seam Web Project</link> chapter, + you would have a connection profile already configured. + </para> </tip> + </listitem> + <listitem> +<para> + Next you should create a new BIRT report file ( <emphasis>><property>File > New > Other > Business Intelligence and Reporting + Tools > Report</property></emphasis>) to represent the data from the <property>Employees</property> table. Call the file <property>employees.rptdesign</property>. +</para> + </listitem> - <para>Next add a new BIRT report. To do that navigate to <emphasis> - <property moreinfo="none">File > New > Other > Business Intelligence and Reporting - Tools > Report</property>.</emphasis> In the <property moreinfo="none">New Report - wizard</property> enter the report name, for instance <emphasis> - <property moreinfo="none">testHibernateOda.rptdesign</property>,</emphasis> then click <emphasis> - <property moreinfo="none">Finish</property>.</emphasis></para> +<listitem> - <figure float="0"> - <title>Creating a New BIRT Report </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/creatingNewBirtReport.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Now switch to the <property moreinfo="none">Report Design perspective</property>.</para> - - <para>In the <property moreinfo="none">Data Explorer View</property> right-click the <emphasis> - <property moreinfo="none">Data Source</property> + <para>Now switch to the <property>BIRT Report Design</property> perspective.</para> +</listitem> + <listitem> + <para>In the <property>Data Explorer</property> view right-click the <emphasis> + <property>Data Source</property> </emphasis> node and choose <emphasis> - <property moreinfo="none">New Data Source</property>.</emphasis></para> + <property>New Data Source</property>.</emphasis></para> - <figure float="0"> + <figure> <title>Creating a New Data Source</title> <mediaobject> <imageobject> - <imagedata fileref="images/hibernate_datasource/creatingDataSource.png"></imagedata> + <imagedata fileref="images/hibernate_datasource/creatingDataSource.png"/> </imageobject> </mediaobject> </figure> +</listitem> + <listitem> + <para>The wizard will prompt you to select data source type. Choose <emphasis> + <property>Hibernate Data Source</property> + </emphasis> and give it a meaningful name, for instance <emphasis> + <property>HibernateDataSource</property> + </emphasis>. Hit <emphasis> + <property>Next</property> to proceed.</emphasis></para> - <para>In the wizard select <emphasis> - <property moreinfo="none">Hibernate Data Source</property> - </emphasis> and give it a proper name, <emphasis> - <property moreinfo="none">HbDataSource</property> - </emphasis> for instance. Hit <emphasis> - <property moreinfo="none">Next</property>.</emphasis></para> - - <figure float="0"> + <figure> <title>Creating Hibernate Data Source</title> <mediaobject> <imageobject> - <imagedata fileref="images/hibernate_datasource/hibernateDataSource.png"></imagedata> + <imagedata fileref="images/hibernate_datasource/hibernateDataSource.png"/> </imageobject> </mediaobject> </figure> + </listitem> + <listitem> + <para>On the next wizard's dialog you can leave the everything with default values, press the <emphasis> + <property>Test Connection</property> + </emphasis> button to verify that the connection is established successfully.</para> - <para>On the next wizard page leave everything as it is, just press the <emphasis> - <property moreinfo="none">Test Connection</property> - </emphasis> button to verify the connection is successful.</para> + <para> + The <property>Hibernate Data Source</property> enables you to specify a Hibernate Configuration or JNDI URL. - <figure float="0"> + </para> + + <figure> <title>Hibernate Data Source Profile</title> <mediaobject> <imageobject> - <imagedata fileref="images/hibernate_datasource/connectionSuccessful.png"></imagedata> + <imagedata fileref="images/hibernate_datasource/connectionSuccessful.png"/> </imageobject> </mediaobject> </figure> + </listitem> + <listitem> + <para>Press <emphasis> + <property>Finish</property> + </emphasis> to complete <property>New Data Source</property> wizard.</para> + </listitem> - <para>Click <emphasis> - <property moreinfo="none">Ok</property> - </emphasis> and then <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> to complete.</para> - - <para>Now let's add a Hibernate ODA dataset. To do that you should bring up the - <property moreinfo="none">New Data Set wizard</property>. In the <property moreinfo="none">Data Explorer View</property> + <listitem> + <para>Now you need to configure a new Hibernate ODA data set. Launch the + <property>New Data Set</property> wizard. In the <property>Data Explorer View</property> right-click the <emphasis> - <property moreinfo="none">Data Set</property> + <property>Data Set</property> </emphasis> node and select <emphasis> - <property moreinfo="none">New Data Set</property>.</emphasis></para> + <property>New Data Set</property>.</emphasis></para> - <figure float="0"> - <title>Creating a New Data Set</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/creatingDataSet.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + </listitem> + <listitem> + <para>Select <property>HibernateDataSource</property> as target data source and type in the new data set name. + Call it <property>HibernateDataSet</property>.</para> - <para>In the <emphasis> - <property moreinfo="none">Data Set Name</property> - </emphasis> section specify the name. Let's it be <emphasis> - <property moreinfo="none">HbDataSet</property>.</emphasis></para> - <figure float="0"> + + + <figure> <title>Creating a Hibernate ODA Data Set</title> <mediaobject> <imageobject> - <imagedata fileref="images/hibernate_datasource/addingHibernateODADataset.png"></imagedata> + <imagedata fileref="images/hibernate_datasource/addingHibernateODADataset.png"/> </imageobject> </mediaobject> </figure> + </listitem> + <listitem> - <para>Next you'll be prompted to define the query for this data set. To validate the + <para>The next dialog of the wizard will help you compose a query for the new data set.</para> + <para>We will make a report that will print all employees in the database who has Sales Rep job title.</para> + + <programlisting role="SQL"><![CDATA[... +select jobtitle, firstname, lastname, email +from Employees as employees where employees.jobtitle = 'Sales Rep' +...]]></programlisting> + + + + <para> + + To validate the entered query you can press the <emphasis> - <property moreinfo="none">Test query</property> + <property>Test query</property> </emphasis> button. All the HQL features like syntax highlighting, content assist, - formatting, Drag and Drop, etc., are available to you here.</para> + formatting, drag-and-drop, etc., are available to facilitate query composing.</para> - <figure float="0"> - <title>Testing Query </title> + <figure> + <title>Composing query for Data Set</title> <mediaobject> <imageobject> - <imagedata fileref="images/hibernate_datasource/testingQuery.png"></imagedata> + <imagedata fileref="images/hibernate_datasource/testingQuery.png"/> </imageobject> </mediaobject> </figure> + </listitem> + <listitem> - <para>Next the output columns will be displayed. It's possible to edit them - here.</para> + <para>Pressing <property>Finish</property> will call the <property>Edit Data Set</property> dialog where you can adjust the parameters of the data set and preview the resulted set. + If everything looks good, hit <property>Ok</property> to generate a new data set. + </para> + </listitem> + <listitem> - <figure float="0"> - <title>HQL Features - Output Columns Section</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/hqlFeaturesOutputColumns.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <para>Now you can insert the data set items of <property>HibernateDataSet</property> into the <property>employees.rptdesign</property>.</para> - <para>To preview the results of the defined query click the <emphasis> - <property moreinfo="none">Preview Results</property> - </emphasis> item.</para> - <figure float="0"> - <title>HQL Features - Preview Results Section</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/hqlFeaturesPreviewResults.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>So far you have the Hibernate data source and data set defined. Now you can create a BIRT - report using this data source and data set.</para> - <tip> <title>Tip:</title> - <para>If you don't know how to do this we suggest that you refer to the <ulink url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT Tutorial</ulink>.</para> + <para>If you don't know how to do this we suggest that you refer to the <ulink + url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT Tutorial</ulink>.</para> </tip> - <figure float="0"> - <title>Creating a BIRT Report using Created Data Source and Data Set</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/BIRTReportUsingDataSourceAndSet.png "></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>If you switch to the <emphasis> - <property moreinfo="none">Preview</property></emphasis> tab, it will run your report and show the output.</para> - - <figure float="0"> - <title>BIRT Report -Preview Tab</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/BIRTReportPreviewTab.png"></imagedata> - </imageobject> - </mediaobject> - </figure> +<para>You can also use parameters in the query to add dynamics to your report. In the previous example we hardcoded the selection criterion in the <code>where</code> clause. </para> + <para>To specify the job title on-the-fly your query should look like this:</para> + <programlisting role="XML"><![CDATA[ +select jobtitle,firstname, lastname,email +from Employees as employees where employees.jobtitle = ? +]]></programlisting> - <para>You can also use parameters within the Hibernate ODA driver.</para> + <para>The question mark represents a data set input parameter, which is not the same as a report parameter. + Now you need to define an new report parameter to pass the data to the report, call it <code>JobTitle</code>. - <figure float="0"> - <title>Using Parameters within the Hibernate ODA Driver</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/parametersWithinHibernateODADriver.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <figure float="0"> - <title>Adding New Parameter</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/addingNewParameter.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + The dataset parameter can be linked to a report parameter. + In the <property>Data Explorer</property> view click the Data Set node to open it and right-click + on the data set you created previously( in our case it is <property>HibernateDataSet</property>), + choose <property>Edit</property> and navigate to the <property>Parameters</property> section. + Declare a new data set parameter, name it <code>jobtitle</code> and map it to the already existing <code>JobTitle</code> report parameter. + </para> + </listitem> + <listitem> + <para>You report is ready, you can view it by clicking on the <property>Preview</property> tab of the <property>BIRT Report Designer</property> editor. </para> - <para>Again, to preview the results switch to the <emphasis> - <property moreinfo="none">Preview Results</property> - </emphasis> item.</para> - <figure float="0"> - <title>Previewing the Results</title> + + <para>You will be prompted to assign a value to the report parameter. For instance you can enter "Sales Rep". </para> + + <figure> + <title>Resulted Dynamic Report</title> <mediaobject> <imageobject> - <imagedata fileref="images/hibernate_datasource/previewingResults.png"></imagedata> + <imagedata fileref="images/hibernate_datasource/finalReport.png"/> </imageobject> </mediaobject> </figure> + </listitem> +</orderedlist> +</section> + <section diffmk:change="added" id="birt_reports_deployment" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/birt_reports_deployment.xml"> + <title><diffmk:wrapper diffmk:change="changed">Creating a Dynamic BIRT Report</diffmk:wrapper></title> -</chapter> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><link diffmk:change="added" linkend="birt_integration_with_seam"><diffmk:wrapper diffmk:change="added">Adding BIRT Functionality to Standard Seam Web Project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> + and </diffmk:wrapper><link diffmk:change="added" linkend="hibernate_datasource"><diffmk:wrapper diffmk:change="added">Using Hibernate ODA Data Sourc</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> sections tell how to integrate a BIRT report into + a Seam web project and how to use Hibernate data source to generate a dynamic report. + In this section we will create a Seam web project that can make a dynamic report using the parameters that are defined on a web page.</diffmk:wrapper></para> - -<chapter id="birt_reports_deployment" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/birt/docs/en/modules/birt_reports_deployment.xml" xreflabel="birt_reports_deployment"> - <?dbhtml filename="birt_reports_deployment"?> - <chapterinfo> - <keywordset> - <keyword>JBoss</keyword> - <keyword>BIRT</keyword> - <keyword>Seam</keyword> - </keywordset> - </chapterinfo> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We will use the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">PRODUCTS</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> table of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">DATAMODELS</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> database for the purpose of this demo project. + In the first place, you need to generate Seam entities like we did in the previous chapter (</diffmk:wrapper><link diffmk:change="added" linkend="hibernate_datasource"><diffmk:wrapper diffmk:change="added">Hibernate ODA Data Source</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> ). The demo application will generate a report about the company's products, whereas it will allow to specify a product line. </diffmk:wrapper></para> - <title>BIRT Reports Deployment</title> +<orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The next step is to create a Java class that will store the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> variable and its assessors, register the class in faces.config.xml. + The variable will be needed to pass dynamic data to the report via report parameters, therefore it has to be of session scope.</diffmk:wrapper></para> + </listitem> - <para>When everything is configured correctly you will be able to view/render the designed - reports in your Seam (or any other) Web application.</para> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="added"> - <para>You can deploy a report by adding an action button to the Seam's CRUD <emphasis> - <property moreinfo="none">.xhtml</property> - </emphasis> file.</para> - <figure float="0"> - <title>Adding Action Button to the Seam file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_reports_deployment/addingActionButton.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + The report will print the data from the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">Products</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> table, hence you need to create a report file first. + You can use either the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">BIRT JDBC Data Source</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Data Source</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> data source to create the data set for this project. If you want to use the latter please read the previous chapter </diffmk:wrapper><link diffmk:change="added" linkend="hibernate_datasource"><diffmk:wrapper diffmk:change="added">Hibernate ODA Data Source</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">. +</diffmk:wrapper></para> - <para>As you can see on the figure you should have the <emphasis> - <property moreinfo="none">testHibernateOda.xhtml</property> - </emphasis> file. It's content should be the following:</para> - <programlisting format="linespecific" role="XHTML"><![CDATA[<p:birt xmlns:ui="http://java.sun.com/jsf/facelets" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:p="http://jboss.com/products/seam/birt" - designType="run" - format="pdf" - designName="testHibernateOda.rptdesign" - title="JBoss Birt Test"> - -</p:birt> -]]></programlisting> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + The data set should have at least the following data set items: product vendor, product name, quantity in stock and buy price. The data is retrieved from the database with this query : + </diffmk:wrapper></para> - <para>Next run the Seam page with embedded report on the server by right-clicking the file and - going to <emphasis> - <property moreinfo="none">Run > Run on Server</property>.</emphasis></para> - <figure float="0"> - <title>Opening Employees.xhtml Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_reports_deployment/openingArticlesPage.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ +SELECT productvedor, +productname, +quantityinstock, +buyprice +FROM Products as products - <para>After clicking the <emphasis> - <property moreinfo="none">BIRT PDF Report</property> - </emphasis> button, you should see the following report:</para> +]]></diffmk:wrapper></programlisting> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Make a table in the report and put each data set item into a column.</diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">As it was stated in the beginning of the chapter the report will be dynamic, therefore you need to declare a report parameter first, let it be </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> and to add the parameter to the query. BIRT offers rich JavaScript API, so you can modify the query programmatically like this:</diffmk:wrapper></para> +<programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"> - <figure float="0"> - <title>Birt PDF Report</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_reports_deployment/BirtPDFReport.png"></imagedata> - </imageobject> - </mediaobject> - </figure> +<xml-property name="queryText"><![CDATA[ +SELECT productvedor, +productname, +quantityinstock, +buyprice +FROM Products as products +]]></xml-property> + <method name="beforeOpen"><![CDATA[ +queryString = " ORDER BY products."+reportContext.getParameterValue("sortOrder")+" "+"DESC"; +this.queryText = this.queryText+queryString; +]]></method> - <para>Thus, a Seam project that includes the BIRT facet can be deployed as any project. If you - define the Hibernate ODA driver, the JBoss BIRT engine will use JNDI URL that has to be bind +</diffmk:wrapper></programlisting> + </listitem> + <listitem diffmk:change="added"> +<para><diffmk:wrapper diffmk:change="changed">The report is ready. You can preview it to make sure it works properly. </diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"> <para><diffmk:wrapper diffmk:change="added">To set the report parameter you should create an </diffmk:wrapper><property moreinfo="none">.xhtml</property><diffmk:wrapper diffmk:change="added"> view page, call it </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. On the page you can set the value of the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> Java bean variable and press the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Generate Report</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button to open another view page that will display the resulted report. + </diffmk:wrapper></para> + + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The source code of the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> should be the following:</diffmk:wrapper></para> + + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ +<!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<ui:composition xmlns="http://www.w3.org/1999/xhtml" + xmlns:s="http://jboss.com/products/seam/taglib" + xmlns:ui="http://java.sun.com/jsf/facelets" + xmlns:h="http://java.sun.com/jsf/html" + xmlns:f="http://java.sun.com/jsf/core" + xmlns:rich="http://richfaces.org/rich" + xmlns:a4j="http://richfaces.org/a4j" template="layout/template.xhtml"> + <ui:define name="body"> + <rich:panel> + <f:facet name="header">BIRT Report Generator</f:facet> + <a4j:form ajaxSubmit="true" reRender="criterion"> + <table> + <tr> + <td>Select sort order criterion:</td> + <td><h:selectOneMenu onchange="submit()" + value="#{yourJavaBean.sortOrder}">  + <f:selectItem itemValue="buyprice" itemLabel="buy price" /> + <f:selectItem itemValue="quantityinstock" itemLabel="quantity in stock" /> + </h:selectOneMenu> + </td> + </tr> + </table> + </a4j:form> + <s:button + view="/#{!empty reportParameters.order ? 'Products' : 'ProductsReport'}.xhtml" id="generate" value="Generate Report" />  + </rich:panel> + </ui:define> +</ui:composition> +]]></diffmk:wrapper></programlisting> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The logic of the file is quite simple, when the sort order criterion is select the value of </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">yourJavaBean.sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> + is set automatically via Ajax and the report is ready to be generated.</diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="added">Now you need to create the web page that will print the report, name the file </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">ProductsReport.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. + The file to output the report should have the following content:</diffmk:wrapper></para> + + + <para><diffmk:wrapper diffmk:change="added"> + As you know from the </diffmk:wrapper><link diffmk:change="added" linkend="birt_integration_with_seam"><diffmk:wrapper diffmk:change="added">Adding BIRT Functionality to Standard Seam Web Project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> chapter, before using the BIRT Integration framework tags on the page you need to declare the tag library and specify the name space with this line: + </diffmk:wrapper></para> + + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + xmlns:b="http://jboss.com/products/seam/birt" +]]></diffmk:wrapper></programlisting> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + The dynamics to the report adds this line: + </diffmk:wrapper></para> + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ +<b:param name="sortOrder" value="#{yourJavaBean.sortOrder}" /> +]]></diffmk:wrapper></programlisting> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We bound the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> report parameter to Java Bean variable </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">value="#{yourJavaBean.sortOrder}"</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> using EL expression, and the value to the variable is assigned in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file. </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">By default if you embed a report into HTML page the HTML-format report contains the <html>, + <head>, <body> etc., tags. However if your HTML page already has those tags, you can rid of them using the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">embeddable="true"</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> attribute of + + the </diffmk:wrapper><emphasis diffmk:change="added" role="bold"><property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> component.</diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="added">Deploy the project onto the server and open your browser to see the report is successfully generated. You should navigate to + + </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/yourProjectName/Products.seam</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> to select the criterion and press the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Generate Report</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. You will be redirected to the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/HelloBirt/ProductsReport.seam</diffmk:wrapper></code> + + </para> + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Dynamic Report</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/hibernate_datasource/finalReport.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> +</orderedlist> + <para><diffmk:wrapper diffmk:change="changed">Thus, a Seam project that includes the BIRT facet can be deployed as any project. If you + define the Hibernate ODA driver, the JBoss BIRT engine will use JNDI URL that has to be bound to either Hibernate Session Factory or Hibernate Entity Manager Factory. If you don't specify the JNDI URL property, our engine will try the following JNDI - URLs:</para> + URLs:</diffmk:wrapper></para> <itemizedlist> <listitem> <para> @@ -870,13 +813,13 @@ </itemizedlist> <para>When creating a Seam EAR project, Hibernate Entity Manager Factory is bound to - <emphasis>java:/{projectName}EntityManagerFactory</emphasis>. All you need to do is - using the Hibernate Configuration created automatically. You can use default values for the - Hibernate Configuration and JNDI URL within the BIRT Hibernate Data Source.</para> + <emphasis>java:/{projectName}EntityManagerFactory</emphasis><diffmk:wrapper diffmk:change="changed">. All you need to do is + to use the Hibernate Configuration created automatically. You can use default values for the + Hibernate Configuration and JNDI URL within the BIRT Hibernate Data Source.</diffmk:wrapper></para> - <para>When using a Seam WAR project, neither HSF nor HEMF aren't binded to JNDI by - default. You has to do this manually. For instance, HSF can be bound to JNDI by adding the - following property to the <emphasis> + <para><diffmk:wrapper diffmk:change="changed">When using a Seam WAR project, neither HSF nor HEMF aren't bound to JNDI by + default. You have to do this manually. For instance, HSF can be bound to JNDI by adding the + following property to the </diffmk:wrapper><emphasis> <property moreinfo="none">persistence.xml</property></emphasis> file:</para> <programlisting format="linespecific" role="XHTML"><![CDATA[<property name="hibernate.session_factory_name" value="java:/projectname"/> @@ -893,13 +836,293 @@ <property moreinfo="none">WebContent/WEB-INF/platform/configuration/config.ini</property> </emphasis> file.</para> </note> - <para>In conclusion, the main goal of this document is to get you know with a full featureset - that <property moreinfo="none">JBoss BIRT Tools</property> provide. Thus if you have some questions, + + <para><diffmk:wrapper diffmk:change="changed">In conclusion, the main goal of this document is to get you to know with a full feature set + that </diffmk:wrapper><property moreinfo="none">JBoss BIRT Tools</property> provide. Thus if you have some questions, comments or suggestions on the topic, please feel free to ask in the <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in - future leaving your vote on our page <ulink url="http://www.jboss.org/community/docs/DOC-10795">here</ulink>.</para> + future leaving your vote on the article <ulink url="http://www.jboss.org/community/docs/DOC-10795">Overview of the improvements required by JBossTools/JBDS Docs users</ulink>.</para> +</section> + </chapter> + + +<chapter diffmk:change="added" id="framework" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/tasks.xml" xreflabel="framework"> + <?dbhtml filename="framework.html"?> + + <chapterinfo> + <keywordset> + + <keyword>Eclipse</keyword> + <keyword>JBoss</keyword> + <keyword>JBoss Tools</keyword> + <keyword>BIRT Integration</keyword> + </keywordset> + </chapterinfo> + + <title>JBoss BIRT Integraion Framework API Reference</title> + + +<section> + + <title> + <emphasis role="bold"> <property><b:birt></property></emphasis> Component + </title> + + + +<para> + The <emphasis role="bold"> <property><b:birt></property></emphasis> component servers to integrate a BIRT report into Seam/JSF container. + The <emphasis role="bold"> <property><b:birt></property></emphasis> tag recognizes most of the parameters described on the BIRT + <ulink url="http://www.eclipse.org/birt/phoenix/deploy/viewerUsage2.2.php#parameters">Report Viewer Parameters</ulink> page, though it has attributes of its own. + +</para> + + + <table> + <title><emphasis role="bold"> <property><b:birt></property></emphasis> Component Reference</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Attribute</entry> + <entry>Correspondance to BIRT Report Viewer parameters</entry> + <entry>Description/</entry> + + </row> + </thead> + <tbody> + <row> + <entry>designType</entry> + <entry> - </entry> + <entry>Corresponds to the BIRT servlet mappings. Possible values are run, frameset, preview and embed. + If the attribute is set to embed the component is used for + embeddable html. This type ignores all the attributes except designName + and masterpage. + </entry> + </row> + <row> + <entry>embeddable</entry> + <entry> - </entry> + <entry>A BIRT report occupies the whole page by default. It contains the <html>, + <head>, <body> etc., tags. Embedded report can be a part of another page. + It doesn't contain the above mentioned tags. Only HTML report can be embedded.</entry> + </row> + <row> + <entry>designName</entry> + <entry>__report</entry> + <entry>Sets the name of the report design to process. This can be an absolute path or relative to the working folder. Valid values are run, frameset and preview</entry> + </row> + + <row> + <entry>format</entry> + <entry>__format</entry> + <entry>Specifies the desired output format, such as pdf, html, doc, ppt, or xls.</entry> + </row> + + <row> + <entry>title</entry> + <entry>__title</entry> + <entry>Sets the report title.</entry> + </row> + + <row> + <entry>showtitle</entry> + <entry>__showtitle</entry> + <entry>Determines if the report title is shown in the frameset viewer. Defaults to true.</entry> + </row> + + <row> + <entry>toolbar</entry> + <entry>__toolbar</entry> + <entry> + + Determines if the report toolbar is shown in the frameset viewer.Defaults to true. Valid values are true and false.</entry> + </row> + + + + <row> + <entry>navigationbar</entry> + <entry>__navigationbar</entry> + <entry> + + Determines if the navigation bar is shown in the frameset viewer. Defaults to true. Valid values are true and false.</entry> + </row> + + + <row> + <entry>document</entry> + <entry>__document</entry> + <entry> + Sets the name for the rptdocument. The document is created when the report engine separates run and render tasks, and + is used to support features like table of contents and pagination. + This setting can be an absolute path or relative to the working folder. If no document parameter is used, a unique document is created in the document folder. + </entry> + </row> + + <row> + <entry>locale</entry> + <entry>__locale</entry> + <entry> + Specifies the locale for the specific operation. Note that this will override the default locale. + </entry> + </row> + <row> + <entry>svg</entry> + <entry>__svg</entry> + <entry> + Specifies whether SVG is supported. + </entry> + </row> + + + + <row> + <entry>page</entry> + <entry>__page</entry> + <entry> + Specifies specific page to render. + </entry> + </row> + + + <row> + <entry>pagerange</entry> + <entry>__pagerange</entry> + <entry> + Specifies page range to render. Eg 1-4,7. + </entry> + </row> + + + <row> + <entry>masterpage</entry> + <entry>__masterpage</entry> + <entry> + + Indicates that the report master page should be used or not. Validvalues are true and false. + </entry> + </row> + + + <row> + <entry>overwrite</entry> + <entry>__overwrite</entry> + <entry> + + This setting if set to true will force an overwrite of the existing report document. + </entry> + </row> + + <row> + <entry>bookmark</entry> + <entry>__bookmark</entry> + <entry> + + Specifies a specific bookmark within the report to load. The viewer will automatically load the appropriate page. + </entry> + </row> + + + + <row> + <entry>rtl</entry> + <entry>__rtl</entry> + <entry> + Specifies whether to display the report in right to left format. This setting defaults to false. + </entry> + </row> + + + + <row> + <entry>fittopage</entry> + <entry>__fittopage</entry> + <entry> + Specifies whether PDF generation should fit content to a page. Valid values are true and false. + </entry> + </row> + + + <row> + <entry>resourceFolder</entry> + <entry>__resourceFolder</entry> + <entry> + Specifies the resource folder to use. This setting will override the default setting in the web.xml. The resource folder is used to locate libraries, images, and resource files. + </entry> + </row> + + </tbody> + </tgroup> + </table> + +</section> + + <section> + <title><emphasis role="bold"> <property><b:param></property></emphasis> Component</title> + <para> + The <emphasis role="bold"> <property><b:param></property></emphasis> tag describes report parameter. + </para> + + <table> + <title><emphasis role="bold"> <property><b:param></property></emphasis> Component</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Attribute</entry> + + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>name</entry> + <entry>The parameter name. Required.</entry> + </row> + <row> + <entry>value</entry> + <entry>The parameter value. Required.</entry> + </row> + + <row> + <entry>isnull</entry> + <entry>Specifies that a report parameter has a null value</entry> + </row> + <row> + <entry>islocale</entry> + <entry>Specifies whether the parameter is localized</entry> + </row> + + </tbody> + + </tgroup> + </table> + </section> + </chapter> +<chapter diffmk:change="added" id="birt_plugin_rel_resources" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/links.xml" xreflabel="birt_plugin_rel_resources"> + <?dbhtml filename="links.html"?> + <chapterinfo diffmk:change="added"> + <keywordset diffmk:change="added"> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse</diffmk:wrapper></keyword> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss</diffmk:wrapper></keyword> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></keyword> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">BIRT Integration</diffmk:wrapper></keyword> + </keywordset> + </chapterinfo> + + + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Other Relevant Resources on the Topic</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All JBoss Developer Studio/JBoss Tools release documentation you can find at </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/"><diffmk:wrapper diffmk:change="added">http://docs.jboss.org/tools</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> in the corresponding release directory.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The latest documentation builds are available at </diffmk:wrapper><ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs/"><diffmk:wrapper diffmk:change="added">http://download.jboss.org/jbosstools/nightly-docs</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. + +</diffmk:wrapper></para> + +</chapter> + + + </book>

15 years

1
0
0 / 0

JBoss Tools SVN: r19305 - branches/jbosstools-3.1.0.RC1/birt/docs/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-16 09:51:10 -0500 (Wed, 16 Dec 2009) New Revision: 19305 Modified: branches/jbosstools-3.1.0.RC1/birt/docs/en/master.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating the plugin version; Modified: branches/jbosstools-3.1.0.RC1/birt/docs/en/master.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/birt/docs/en/master.xml 2009-12-16 14:50:39 UTC (rev 19304) +++ branches/jbosstools-3.1.0.RC1/birt/docs/en/master.xml 2009-12-16 14:51:10 UTC (rev 19305) @@ -59,7 +59,7 @@ <releaseinfo> - Version: 1.1.0.M2 + Version: 1.1.0.CR1 </releaseinfo>

15 years

1
0
0 / 0

JBoss Tools SVN: r19304 - branches/jbosstools-3.1.0.RC1/birt/docs/en/modules.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-16 09:50:39 -0500 (Wed, 16 Dec 2009) New Revision: 19304 Modified: branches/jbosstools-3.1.0.RC1/birt/docs/en/modules/hibernate_datasource.xml branches/jbosstools-3.1.0.RC1/birt/docs/en/modules/introduction.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - correcting validation errors; Modified: branches/jbosstools-3.1.0.RC1/birt/docs/en/modules/hibernate_datasource.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/birt/docs/en/modules/hibernate_datasource.xml 2009-12-16 14:49:47 UTC (rev 19303) +++ branches/jbosstools-3.1.0.RC1/birt/docs/en/modules/hibernate_datasource.xml 2009-12-16 14:50:39 UTC (rev 19304) @@ -29,7 +29,7 @@ guide.</para> <para> If you followed the steps described in the - <link linkend="birt_integration">Adding BIRT Functionality to Standard Seam Web Project</link> chapter, + <link linkend="birt_integration_with_seam">Adding BIRT Functionality to Standard Seam Web Project</link> chapter, you would have a connection profile already configured. </para> </tip> Modified: branches/jbosstools-3.1.0.RC1/birt/docs/en/modules/introduction.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/birt/docs/en/modules/introduction.xml 2009-12-16 14:49:47 UTC (rev 19303) +++ branches/jbosstools-3.1.0.RC1/birt/docs/en/modules/introduction.xml 2009-12-16 14:50:39 UTC (rev 19304) @@ -83,9 +83,9 @@ <listitem> <para>Eclipse with <property>JBoss Tools</property> installed (how to install <property>JBoss Tools</property> on Eclipse, what - dependences and versions requirements are needed reed in the <link - linkend="http://download.jboss.org/jbosstools/nightly-docs/en/GettingStartedGuide/..." - >JBoss Tools Installation</link> section)</para> + dependences and versions requirements are needed reed in the <ulink + url="&gsglink;#JBossToolsInstall" + >JBoss Tools Installation</ulink> section)</para> </listitem> <listitem> <para>BIRT Report Designer (BIRT Report Designer 2.3.2

15 years

1
0
0 / 0

JBoss Tools SVN: r19303 - branches/jbosstools-3.1.0.RC1/as/docs/reference/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-16 09:49:47 -0500 (Wed, 16 Dec 2009) New Revision: 19303 Modified: branches/jbosstools-3.1.0.RC1/as/docs/reference/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating master_output.xml; Modified: branches/jbosstools-3.1.0.RC1/as/docs/reference/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/as/docs/reference/en/master_output.xml 2009-12-16 14:46:22 UTC (rev 19302) +++ branches/jbosstools-3.1.0.RC1/as/docs/reference/en/master_output.xml 2009-12-16 14:49:47 UTC (rev 19303) @@ -22,2259 +22,2329 @@ <!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> -]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> - - <bookinfo> - <title>JBoss Server Manager Reference Guide</title> - <corpauthor diffmk:change="added"> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> - <imagedata diffmk:change="added" fileref="images/jbosstools_logo.png" format="PNG"></imagedata> - </imageobject> - <imageobject diffmk:change="added" role="html"> - <imagedata diffmk:change="added"></imagedata> - </imageobject> - </inlinemediaobject> - </corpauthor> - - <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> - <author><firstname>Olga</firstname><surname>Chikvina</surname></author> - <author><firstname>Rob</firstname><surname>Stryker</surname><email>rob.stryker(a)jboss.com</email></author> - <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> - - <pubdate>April 2008</pubdate> - <copyright> - <year>2007</year> - <year>2009</year> - <holder><diffmk:wrapper diffmk:change="changed">JBoss by Red Hat</diffmk:wrapper></holder> - </copyright> - <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 2.1.0.M2 - </diffmk:wrapper></releaseinfo> -<abstract> - <title></title> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_Reference_...">PDF version</ulink> - </para> -</abstract> - - </bookinfo> - - - <toc></toc> - -<chapter id="quick_start" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/quick_start.xml"> - <title>Quick Start with JBoss Server</title> - - <para>This chapter covers the basics of working with the <property moreinfo="none">JBoss Server</property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> - - <section diffmk:change="added" id="JBoss_server_key_features"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Features of JBoss Server</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For a start, we propose you to look through the table of main features of JBoss Server:</diffmk:wrapper></para> - - <table diffmk:change="added"> - - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Functionality for JBoss Server</diffmk:wrapper></title> - <tgroup cols="3" diffmk:change="added"> - - <colspec align="left" colnum="1" colwidth="2*" diffmk:change="added"></colspec> - <colspec colnum="2" colwidth="4*" diffmk:change="added"></colspec> - <colspec align="left" colnum="3" colwidth="2*" diffmk:change="added"></colspec> - - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Feature</diffmk:wrapper></entry> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Benefit</diffmk:wrapper></entry> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Chapter</diffmk:wrapper></entry> - </row> - </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss AS plugin</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Using WTP, JBoss AS plugin allows working with the server in run or debug mode. You can easily install runtimes and servers, copy the existing runtime configuration or configure it up to your needs.</diffmk:wrapper></para></entry> - <entry diffmk:change="added"> - <link diffmk:change="added" linkend="runtimes_servers"><diffmk:wrapper diffmk:change="added">runtimes and servers</diffmk:wrapper></link> - </entry> - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss AS Perspective</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">It makes managing installed JBoss Server quite easy and includes the standard Console and Properties views, and specially added Project archives View and JBoss Server View for that purpose. </diffmk:wrapper></para></entry> - <entry diffmk:change="added"> - <link diffmk:change="added" linkend="perspective"><diffmk:wrapper diffmk:change="added">JBoss AS perspective</diffmk:wrapper></link> - </entry> - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Modules Deployment</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">A number of ways, provided by WTP and JBoss Tools, to deploy either a project or a single file on the server.</diffmk:wrapper></para></entry> - <entry diffmk:change="added"> - <link diffmk:change="added" linkend="modules"><diffmk:wrapper diffmk:change="added">deploying modules</diffmk:wrapper></link> - </entry> - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">TPTP Support</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Test and Performance Tools Platform (TPTP) profiling.</diffmk:wrapper></para></entry> - <entry diffmk:change="added"> - <link diffmk:change="added" linkend="tptp_support"><diffmk:wrapper diffmk:change="added">TPTP support</diffmk:wrapper></link> - </entry> - </row> - - </tbody> - - </tgroup> - </table> - - </section> - - - - - - - - - - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> If you - already have installed JBoss server and runtime you can quickly learn how to configure, start, - stop the server, to know deployment and archiving processes. How to install runtimes and servers - read in the </diffmk:wrapper><link linkend="runtimes_servers">Runtimes and Servers in the JBoss AS plugin</link> - chapter.</para> - - <para>To start working with JBoss AS, select a <property moreinfo="none">JBoss AS Perspective</property> via - <emphasis><property moreinfo="none">Window > Open Perspective > Other > JBoss - AS</property>.</emphasis></para> - - <section id="starting"> - <title>Starting JBoss Server</title> - - <para>Starting <property moreinfo="none">JBoss Server</property> is quite simple. You can control the server - behaviour with the help of a special toolbar in the <property moreinfo="none">JBoss Server View</property> - where you could <emphasis> - <property moreinfo="none">start</property> - </emphasis> it in a regular or debug mode, <emphasis> - <property moreinfo="none">stop</property> - </emphasis> it or <emphasis> - <property moreinfo="none">restart</property> - </emphasis> it and <emphasis> - <property moreinfo="none">publish</property> - </emphasis> to the server.</para> - - <figure float="0"> - <title>JBoss Server Toolbar</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>To launch the server click the green-with-white-arrow icon on the <property moreinfo="none">JBoss Server - View </property>or right click server name in this view and select <emphasis> - <property moreinfo="none">Start</property>. </emphasis> If this view is not open, select - <emphasis><property moreinfo="none">Window > Show View > Other > Server > - JBoss Server View</property>.</emphasis></para> - - <figure float="0"> - <title>Start JBoss Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section id="stopping"> - <title>Stopping JBoss Server</title> - - <para>To stop the server, click the <emphasis> - <property moreinfo="none">Stop</property> - </emphasis> icon in the <property moreinfo="none">JBoss Server View</property> or right click the server name - and press <emphasis><property moreinfo="none">Stop</property>.</emphasis></para> - - <figure float="0"> - <title>Stop JBoss Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>When the server is stopped you will see <emphasis> - <property moreinfo="none">Stopped</property> - </emphasis> state next to its name in the square brackets.</para> - <para>Learn more about the <property moreinfo="none">JBoss Server View</property> - <link linkend="JBossServerView">here</link>.</para> - </section> - - <section id="archiving"> - - <title>Project Archiving</title> - - <para><property moreinfo="none">JBoss Tools</property> comes with our own archives tool. The Project Archives - plugin consists primarily of a view to set up each packaging configuration <emphasis>( - <property moreinfo="none">Window > Show View > Other > JBoss Tools > Project archives</property>). - </emphasis></para> - <para>Right clicking in the <property moreinfo="none">Project archives view</property> you can create War, - EJB War, EAR or JAR archive.</para> - - <figure float="0"> - <title>Archive Creating</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_7.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Using the context menu on the item you can initiate a <emphasis><property moreinfo="none">full build</property></emphasis> on - archive, <emphasis><property moreinfo="none">edit</property>,</emphasis> <emphasis><property moreinfo="none">delete</property></emphasis> or - <emphasis><property moreinfo="none">publish</property></emphasis> it.</para> - - <figure float="0"> - <title>Context Menu on the Item</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_8.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Learn more about the <property moreinfo="none">Project Archives View</property> - <link linkend="Project_archivesView">here</link>.</para> - - </section> - <section id="deployment"> - <title>Deploying an Application to a Server</title> - - <para>There are two times to deploy your application:</para> - <itemizedlist> - <listitem> - <para>While creating it</para> - </listitem> - <listitem> - <para>After it already exists</para> - </listitem> - </itemizedlist> - - <para>When you create a new project (Seam, JSF or Struts) with the New Project or Import Project - wizards, the one of wizards steps has a <emphasis> - <property moreinfo="none">Target Runtime</property> - </emphasis> and <emphasis> - <property moreinfo="none">Target Server</property> - </emphasis> sections. You can deploy the application through the appropriate selection in - these sections.</para> - - <figure float="0"> - <title>Runtime and Server Sections in the New Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_4a.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <figure float="0"> - <title>Runtime and Server Sections in the Import Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_4b.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>You can deploy an existing application to a server by right-clicking the target defined - server in the <property moreinfo="none">JBoss Servers View</property> and then selecting <emphasis><property moreinfo="none">Add and - Remove Projects</property></emphasis> from the context menu.</para> - - <figure float="0"> - <title>Add and Remove Projects From the Context Menu.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>If this application is not assigned to a server, it will be in the left-hand available - projects list. Clicking on the <property moreinfo="none">Add ></property> button will add it to the right-hand - configured projects list and deploy the application to this server.</para> - - <figure float="0"> - <title>Modifying The Projects that are Configured on the Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Here, we have just performed the basic steps you should know to quick start with JBoss - server. In fact, there are more functionalities which you can make use of. Further we will - talk about them in detail.</para> - </section> - - - <section> - <title>Other relevant resources on the topic</title> - - <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/2.1.0.GA"><diffmk:wrapper diffmk:change="changed">on JBoss Tools release documentation page</diffmk:wrapper></ulink>.</para> - <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/"><diffmk:wrapper diffmk:change="changed"> JBoss Tools nightly builds documentation page</diffmk:wrapper></ulink>.</para> - - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Find out the answers on the frequently asked questions about JBoss AS 5 usage in the - </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/community/wiki/jboss5faq"><diffmk:wrapper diffmk:change="added">JBoss5FAQ</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. - </diffmk:wrapper></para> - </section> - -</chapter> - - -<chapter id="runtimes_servers" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/runtimes_servers.xml" xreflabel="runtimes_servers"> - <?dbhtml filename="runtimes_servers.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>Deploy</keyword> - <keyword>Deployment</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> - <title>Runtimes and Servers in the JBoss AS plugin</title> - - <para>In this chapter we will discuss how to install runtimes and servers.</para> - - <para>First of all it's necessary to mention that the JBoss AS plugin makes use of WTP. - This includes starting and stopping servers in run or debug mode. It also includes targeting WTP - projects, such as Dynamic Web Projects, to certain server runtimes in order to ensure that the - proper jars from a specific server are added to the project's classpath - properly.</para> - <para>In order to get started creating, running, and debugging J2EE applications, we should create - our <property moreinfo="none">runtime</property> and <property moreinfo="none">server</property> instances.</para> - - <section> - <title>Runtimes</title> - <para>In <property moreinfo="none">JBoss Tools</property>, the main purpose of Server Runtimes is to point to a - server installation somewhere on disk. In our case, this will be a JBoss installation, and it - can then be used for two primary purposes:</para> - <itemizedlist> - <listitem> - <para>it provides classpath additions to WTP projects that require them.</para> - </listitem> - <listitem> - <para>for <property moreinfo="none">JBoss server</property> at least, it provides information necessary for - the starting and stopping of the server, it tells which jars to run and which - configuration to use.</para> - </listitem> - </itemizedlist> - - <section id="InstNewRuntime"> - <title>Installing a New Runtime</title> - <para>You can install runtimes into eclipse from the <emphasis> - <property moreinfo="none">Window > Preferences </property> - </emphasis> menu, and then select <emphasis> - <property moreinfo="none">Server > Runtime Environments</property> - </emphasis> from the categories available on the left.</para> - <figure float="0"> - <title>Installed Runtimes</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>From this preference page you can see all declared runtimes and their types as well. - Here, it's possible to edit or remove existing runtimes as well as add a new - one.</para> - - <para>To create a JBoss runtime click <emphasis> - <property moreinfo="none">Add</property> - </emphasis> button and choose a necessary type of runtime from the <emphasis> - <property moreinfo="none">JBoss Community</property> - </emphasis> category.</para> - - <figure float="0"> - <title>Adding a Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - - <para>Now there is a separation between .org servers (the <emphasis> - <property moreinfo="none">JBoss Community</property> - </emphasis> category) and product server that comes with JBoss EAP in JBDS ( the <emphasis> - <property moreinfo="none">JBoss Enterprise Middleware</property> - </emphasis> category).</para> - </note> - - <para>As you can see, <property moreinfo="none">JBoss Tools</property> provide its own adapters such as JBoss - 3.2, 4.0, 4.2 and 5.0 as well. The last one comes with its own new feature, that is a safer - incremental deployment, which prevents partial deployments to be picked up by the server. It - means that scanning for auto-deployment is suspended while files are being copied to the - deployment location and resumed when the copy is completed.</para> - - <note> - <title>Note:</title> - <para>Currently we recommend you to use a fully supported JBoss 4.2 server adapter.</para> - </note> - - <para>You'll also note a Deploy-Only Runtime type. This type provides no classpath - for WTP projects. It is used solely by its server type for the purpose of setting up a - deploy directory for users who don't wish to make use of starting, stopping, or - debugging their projects inside eclipse.</para> - - <figure float="0" id="add_runtime_figure"> - <title>Adding a JBoss 4.2 Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The following table describes all the available options of the currant wizard - page.</para> - <table> - <title>Server Runtime Wizard Parameters</title> - <tgroup cols="2"> - <colspec align="left" colnum="1" colwidth="1*"></colspec> - <colspec colnum="2" colwidth="3*"></colspec> - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> - - <tbody> - <row> - <entry> - <para>Name</para> - </entry> - <entry> - <para>The name of a new Runtime for a chosen server. We suggest that you - don't leave a default value. It's better to give descriptive - names that will help to distinguish one runtime from another.</para> - </entry> - </row> - - <row> - <entry> - <para>Home directory</para> - </entry> - <entry> - <para>The path to a directory where the runtime is installed.</para> - </entry> - </row> - - <row> - <entry> - <para>JRE</para> - </entry> - <entry> - <para>The proper Java Runtime Environment. Because of the open-source nature of - JBoss, a user is likely to want to modify and repackage some of the - configuration-specific jboss jars and create their own configuration. Thus, rather - than forcing you to copy his entire JBoss installation, the structure of the - wizard allows to create only a new configuration instead.</para> - </entry> - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Directory</diffmk:wrapper></para> - </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The path to a directory where the configurations are installed.</diffmk:wrapper></para> - </entry> - </row> - <row> - <entry> - <para>Configuration</para> - </entry> - <entry> - <para><diffmk:wrapper diffmk:change="changed">The list of configurations (all, default, minimal) that is updated as soon as - you browse to a valid runtime installation folder.</diffmk:wrapper></para> - </entry> - </row> - - </tbody> - </tgroup> - </table> - - <para><diffmk:wrapper diffmk:change="changed">As a result of having each runtime represent a specific configuration rather than the - server installation as a whole, it is very likely you'll create several different - runtimes to test each of your configurations. It becomes important to ensure your runtimes, - and later your servers, are given descriptive names that help you to remember which is - which.</diffmk:wrapper></para> - - <para>Press <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> to see your new runtime in the list.</para> - <note diffmk:change="added"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you edit the configuration of a runtime, the changes don't affect the settings of the servers that currently use the runtime. - To apply the changes to them also,you should double right click the server, </diffmk:wrapper><emphasis diffmk:change="added"> - <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Overview>Runtime Environment</diffmk:wrapper></property> </emphasis><diffmk:wrapper diffmk:change="added"> - ,make sure that necessary configuration is chosen,click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property> </emphasis><diffmk:wrapper diffmk:change="added"> and then </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Save</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> button.</diffmk:wrapper></para> - </note> - </section> - <section diffmk:change="added" id="CopyRuntime"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Copying the existing runtime configuration</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">While installing a new runtime you can copy the configuration from the existing one. - To do this you should perform all the steps in the </diffmk:wrapper><link diffmk:change="added" linkend="InstNewRuntime"><diffmk:wrapper diffmk:change="added">previous</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> section except pressing </diffmk:wrapper><emphasis diffmk:change="added"> - <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> - in the New Server Runtime Environment menu . - </diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Make sure that you browse to a valid runtime folder and can see the list of configurations (all, default, minimal) in the Configuration section . - Then choose necessary Configuration from the list and click </diffmk:wrapper><emphasis diffmk:change="added"> - <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Copy</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">.The next dialog should appear. - </diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Copy the existing configuration</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/runtimes_servers/runtimes_servers_4a.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Change the name Click on </diffmk:wrapper><emphasis diffmk:change="added"> - <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Browse</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and select your configuration location or leave as it's if you want it to be located together with other runtime configurations. - </diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Copy the existing configuration</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/runtimes_servers/runtimes_servers_4b.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click</diffmk:wrapper><emphasis diffmk:change="added"> - <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"> Ok </diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">and you should see the next wizard with the just added copied configuration. - - </diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Runtime with copied configuration</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/runtimes_servers/runtimes_servers_4c.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Press </diffmk:wrapper><emphasis diffmk:change="added"> - <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property> - </emphasis><diffmk:wrapper diffmk:change="added"> and you will see your new runtime in the list. - </diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can also change a configuration of existing runtime to a copied one in the same way from the </diffmk:wrapper><emphasis diffmk:change="added"> - <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"> Window > Preferences </diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> - menu </diffmk:wrapper><emphasis diffmk:change="added"> - <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Server > Runtime Environments </diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> - and clicking </diffmk:wrapper><emphasis diffmk:change="added"> - <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Edit</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">. - </diffmk:wrapper></para> - </section> - </section> - <section> - <title>Servers</title> - <para>WTP servers are eclipse-representations of a backing server installation. They are used to - start or stop servers, deploy to servers, or debug code that will run on the server. They keep - track of the modules (jars, wars, etc) you deploy to the server and also allow you to undeploy - those modules (see <link linkend="run_on_server_wizard">Deploying with Run On Server - Wizard</link> section). </para> - <para>Servers can be started or stopped with different <link linkend="com_line_arg">command-line - arguments</link>. They are often backed by a runtime object representing that server's - location.</para> - - <section> - <title>Creating a New Server</title> - - <para>There are many ways to get to the new server wizard. One way is to use the old standard <emphasis> - <property moreinfo="none">File > New > Other... </property> - </emphasis> and then <emphasis> - <property moreinfo="none">Server</property> - </emphasis>. This should show the wizard like below.</para> - <figure float="0"> - <title>Adding a JBoss Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>A server object is that keeps track of things like command line arguments when starting - or stopping, and runtimes keep track of the location of the installation. Thus, each server - instance must be backed by an appropriate runtime. </para> - - <para> <emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"> New server wizard </diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> allows to name the server appropriately in the </diffmk:wrapper><emphasis><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Server name field </diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">or you can use a generated default name.If it's nessecary to restore the default name,after you defined yours, click the Reset default button(</diffmk:wrapper><inlinemediaobject diffmk:change="added"> <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/runtimes_servers/runtimes_servers_4d.png"></imagedata> - </imageobject></inlinemediaobject><diffmk:wrapper diffmk:change="added">). - From the list of already declared runtimes in the combo box below the view it's - possible to select which runtime you want your server to be backed by. If there is no - runtime that matches your needs just press the </diffmk:wrapper><emphasis diffmk:change="added"> - <property moreinfo="none">Add...</property> - </emphasis> link nearby to bring up the wizard for creating a new runtime (see the <link linkend="add_runtime_figure"><diffmk:wrapper diffmk:change="changed">Installing a New Runtime section</diffmk:wrapper></link>). To configure the already installed - runtimes you should go to server preferences that you can easily do by pressing the <emphasis> - <property moreinfo="none">Configure runtime environments...</property></emphasis> link.</para> - - <para>If the server you want to create doesn't have any installed runtime yet, the combo box - and the links are absent.</para> - - <figure float="0"> - <title>Installed Server Runtime Environments</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>In this case the next page in the wizard which has the same form as in <link linkend="add_runtime_figure">the previous section</link> will ask you to create the - associated runtime.</para> - <para><diffmk:wrapper diffmk:change="changed">Either way, after targeting your server to a runtime, the final screen in this wizard is - largely confirmational, giving you a chance to verify that you've selected the - appropriate runtime. </diffmk:wrapper></para> - - <figure float="0"> - <title>Installed Server Runtime Environments</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_7.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Press <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> to complete the process of the server creation.</para> - <para>Now that we've created our runtimes and servers, we can dwell on all services - and tools that JBoss Server Manager provides.</para> - - <para>We hope, this guide helped you to get started with the JBoss Tools server manager. Besides, for additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> - </section> - </section> - - -</chapter> - - -<chapter id="perspective" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/perspective.xml" xreflabel="perspective"> - <?dbhtml filename="perspective.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>Deploy</keyword> - <keyword>Deployment</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> - - <title>JBoss AS Perspective</title> - - <para>This chapter tells how to manage installed <property moreinfo="none">JBoss Server</property> via - <property moreinfo="none">JBoss AS perspective</property>.</para> - - <para>The <property moreinfo="none">JBoss AS perspective</property> is similar to the <property moreinfo="none">Java - perspective</property>, but it contains a few additional views. Two of the additional - views are standard views, specifically the <property moreinfo="none">Console view</property> and the - <property moreinfo="none">Properties view</property>. The other two views that are added are the - <property moreinfo="none">Project archives view</property> and the <property moreinfo="none">JBoss Server - View</property>.</para> - - <section id="JBossServerView" role="updated"> - <?dbhtml filename="JBossServerView.html"?> - <title>The JBoss Server View</title> - - <para>The <property moreinfo="none">JBoss Server View</property> is built on Common Navigator Framework - allowing extensions and is using label decorators what makes the UI enough compact - without loosing the vital information.</para> - - <para>Let's have a look at the <property moreinfo="none">JBoss Server View</property> and inspect - in detail all parts it consists of. </para> - <figure float="0"> - <title>The JBoss Server View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <section id="jbossserver_view_toolbar"> - <title>JBoss Server View Toolbar</title> - <para>In the right top corner of the <property moreinfo="none">JBoss Server View</property><diffmk:wrapper diffmk:change="changed"> there is a - special toolbar which provides a quick access to starting a server (in the debug - mode, run mode, or profile mode), restarting a server, stopping a server and a - possibility to publish to a server.</diffmk:wrapper></para> - - <figure float="0"> - <title>The JBoss Server View Toolbar</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>In order to debug your applications or EJB's that are deployed to the server, you - must start the server in debug mode. By starting the server in debug mode, eclipse - will allow you to set breakpoints on code in your workspace and step through the - code.</para> - - <para><emphasis> - <property moreinfo="none">Start the server in profiling mode</property> - </emphasis> button allows to enable profiling actions for your application. For more - details on how to start using TPTP profiling with <property moreinfo="none">JBoss Tools</property> - refer to <link linkend="tptp_support">TPTP Support</link> chapter.</para> - - <para><emphasis> - <property moreinfo="none">Publish to the server</property> - </emphasis> button will republish any modules where it has determined the workspace - is out of sync with the server. It will attempt to do an incremental publish if it - turns out that the module in question is capable of doing one.</para> - - </section> - - <section id="jbossserver_view_structure"> - <title>JBoss Server View Structure</title> - <para>The <property moreinfo="none">JBoss Server View</property> displays all declared servers as well - as their current states (that is whether they are started or stopped) and statuses - in the square brackets next to a server name.</para> - - <figure float="0"> - <title>The JBoss Server View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The following table lists possible server statuses.</para> - - <table> - <title>Server Publish Status</title> - <tgroup cols="2"> - <colspec align="left" colnum="1" colwidth="1*"></colspec> - <colspec colnum="2" colwidth="3*"></colspec> - - - <thead> - <row> - <entry align="center">Status</entry> - - <entry align="center">Description</entry> - </row> - </thead> - - <tbody> - <row> - <entry align="center"> - <para>Republish</para> - </entry> - - <entry align="center"> - <para>The status which allows you to see if changes are - awaiting</para> - </entry> - </row> - <row> - <entry align="center"> - <para>Publishing...</para> - </entry> - - <entry align="center"> - <para>The status which shows if changes are being updated</para> - </entry> - </row> - <row> - <entry align="center"> - <para>Synchronized</para> - </entry> - - <entry align="center"> - <para>The status which allows you to see if changes are - in-sync</para> - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>You can control a server behavior as well as adjust some server preferences with - the help of the context menu commands.</para> - - <figure float="0"> - <title>Context Menu Commands</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_8.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>All available context menu commands are described in the following table.</para> - <table> - <title>Server Properties through the Context Menu</title> - <tgroup cols="2"> - <colspec align="left" colnum="1" colwidth="1*"></colspec> - <colspec colnum="2" colwidth="3*"></colspec> - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> - - <tbody> - <row> - <entry> - <para>New Server</para> - </entry> - <entry> - <para>The option allows to define a new server</para> - </entry> - </row> - - <row> - <entry> - <para>Open</para> - </entry> - <entry> - <para>The option opens the Server editor</para> - </entry> - </row> - - <row> - <entry> - <para>Show in</para> - </entry> - <entry> - <para>This option gives an easy access to the next views: Console, - Debug view, Server Log or MBean Explorer</para> - </entry> - </row> - - <row> - <entry> - <para>Delete</para> - </entry> - <entry> - <para>Standard option that allows to delete the chosen server</para> - </entry> - </row> - - <row> - <entry> - <para>Start</para> - </entry> - <entry> - <para>The action for stating a server in a run mode</para> - </entry> - </row> - - <row> - <entry> - <para>Debug</para> - </entry> - <entry> - <para>The action for stating a server in a debug mode</para> - </entry> - </row> - - <row> - <entry> - <para>Stop</para> - </entry> - <entry> - <para>The action for stopping a declared server</para> - </entry> - </row> - - <row> - <entry> - <para>Publish</para> - </entry> - <entry> - <para>The action for synchronizing the publish information between - the server and workspace</para> - </entry> - </row> - - <row> - <entry> - <para>Explore</para> - </entry> - <entry> - <para>This action uses the native OS file explorer to browse the - deploy destination. Note: The option is also available for - deployed resources/projects (see the figure below).</para> - </entry> - </row> - - <row> - <entry> - <para>Add and Remove Projects</para> - </entry> - <entry> - <para>The option allows to publish a new project to the server (if - its type is supported)</para> - </entry> - </row> - - <row> - <entry> - <para>Monitoring</para> - </entry> - <entry> - <para>Possibility to add ports to be monitored on the current - server</para> - </entry> - </row> - - <row> - <entry> - <para>Properties</para> - </entry> - <entry> - <para>Opens the window to adjust the current server - preferences</para> - </entry> - </row> - - </tbody> - </tgroup> - </table> - - <para>Under the server element in the <property moreinfo="none">JBoss Server View</property>, you can - see currently deployed to the server modules and some server extensions which - provide the additional information on the server.</para> - - <para>The context menu for any module allows you to remove it from the server, force a - full or incremental republish upon it.</para> - - <figure float="0"> - <title>Modules Action</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_11.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <section id="filesets"> - <title>Filesets</title> - - <para>The <emphasis> - <property moreinfo="none">Filesets</property> - </emphasis> category in the <property moreinfo="none">JBoss Server View</property> is intended - for files filtering.</para> - - <para>To add a new file filter, right-click the <emphasis> - <property moreinfo="none">Filesets</property> - </emphasis> category and select <emphasis> - <property moreinfo="none">Create File Filter</property>.</emphasis></para> - <para diffmk:change="added" id="filefilterWiz">The <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New File - Filter wizard</diffmk:wrapper></property> should appear.</para> - - <figure float="0"> - <title>Creating a New File Filter</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The wizard asks you to enter the filter name and add includes and excludes - patterns. The preview box underneath gives a list of files matched to the - defined patterns.</para> - - <figure float="0"> - <title>New File Filter Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>After the filter is created, you can observe it by expanding the <emphasis> - <property moreinfo="none">Filesets</property> - </emphasis> category in the <property moreinfo="none">JBoss Server View</property>.</para> - - <para>It's possible now to edit files directly from the <emphasis> - <property moreinfo="none">Filesets</property> - </emphasis> category. Double clicking on a file from <emphasis> - <property moreinfo="none">Filesets</property> - </emphasis> opens up the editor automatically or you can use the <emphasis> - <property moreinfo="none">Edit File</property> - </emphasis> context menu command.</para> - - <figure float="0"> - <title>Direct Editing from the Filesets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>To delete a file filter (or just a file) from the <emphasis> - <property moreinfo="none">Filesets</property>,</emphasis> right-click a file filter (or the - unnecessary file) and select the <emphasis> - <property moreinfo="none">Delete File Filter</property> - </emphasis> - <emphasis>(<property moreinfo="none">Delete File</property>)</emphasis> command.</para> - - <figure float="0"> - <title>Deleting the File from the Filesets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you want to set filesets for some server types, you should open - </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window>Preferences</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> - and then select </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Server > Default Filesets</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> - from the categories available on the left.</diffmk:wrapper></para> - - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Deleting the File from the Filesets</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/perspective/filesets5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On this preference page you can add a fileset - to any server type or to all servers at once.To do this you should select the server type in the combo box and click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add fileset...</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> button. - In the opened </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New File - Filter wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> follow the steps described </diffmk:wrapper><link diffmk:change="added" linkend="filefilterWiz"><diffmk:wrapper diffmk:change="added">before</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> and finally click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> button on the preference page.</diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The defined file filter will be automatically added to new servers during creation.</diffmk:wrapper></para> - - - </section> - - <section id="xml_configuration"> - <title>XML Configuration</title> - <para>The <emphasis> - <property moreinfo="none">XML Configuration</property> - </emphasis> category allows you to quickly browse to descriptor files in your - server's deploy directory and check or change the values. Basically, <emphasis> - <property moreinfo="none">XML Configuration</property> - </emphasis> includes XML XPaths where an xpath is a path used to access some - specific part of an xml document. </para> - - <note> - <title>Note:</title> - <para>You are assumed to be familiar with XPath. If not, we highly suggested - that you look through an appropriate manual or tutorial on the topic.</para> - </note> - - <para>The <emphasis> - <property moreinfo="none">XML Configuration</property> - </emphasis> category itself contains only a list of categories. <emphasis> - <property moreinfo="none">Ports</property> - </emphasis> are provided by default and is filled with many of the most commonly - used ports in the <property moreinfo="none">JBoss Server</property>.</para> - - <figure float="0"> - <title>XML Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_14.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - -  - - <para>By right-clicking on <emphasis> - <property moreinfo="none">XML Configuration</property>, </emphasis> you can create a new - category. Besides, context menu for <emphasis> - <property moreinfo="none">XML Configuration</property> - </emphasis> category makes possible to disable it. You can disable any category - in the bottom part of the <emphasis> - <property moreinfo="none">JBoss Server View</property>.</emphasis> Look for them in the <emphasis> - <property moreinfo="none">Inactive Categories</property> - </emphasis> afterwards to re-enable.</para> - - <figure float="0"> - <title>Adding New Category</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_15.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>By right-clicking on <emphasis> - <property moreinfo="none">Ports</property> - </emphasis> or any other category in <emphasis> - <property moreinfo="none">XML Configuration</property> - </emphasis>, you can create a new xpath.</para> - - <figure float="0"> - <title>Adding New XPath</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_16.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>After that, the dialog shown below will appear.</para> - - <figure float="0"> - <title>Adding New XPath</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_17.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The goal here is to get an end result where the XPath matches up with a - necessary property. With that in mind, let's look how it works. If the - property you want to reach is the value of the <emphasis>name</emphasis> - attribute in the element <code><mbean></code>, then your <emphasis> - <property moreinfo="none">XPath Patten</property> - </emphasis>should end with <emphasis>mbean</emphasis> and your <emphasis> - <property moreinfo="none">Attribute Name</property> - </emphasis> should be <emphasis>name</emphasis> like on the next figure.</para> - - <programlisting format="linespecific" role="XML"><![CDATA[... -<server> -... - <mbean code="org.jboss.ejb.EJBDeployer" - name="jboss.ejb:service=EJBDeployer" xmbean-dd=""> - -  - <xmbean> - <description> - The EJBDeployer responsible for ejb jar deployment</description> - ... - </xmbean> - </mbean> -</server> -]]></programlisting> - - <figure float="0"> - <title>XPath Preview</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_18.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - <para>Notice, when you type the fields autocomplete to help you locate exactly - what xpath you're looking for.</para> - </tip> - - <para>Then, on the other hand, if your desired field is the text of an element - <code><description></code>, your <emphasis> - <property moreinfo="none">XPath Patten</property> - </emphasis> should end with <emphasis>description</emphasis> and <emphasis> - <property moreinfo="none">Attribute Name</property> - </emphasis> field should be left blank. When finished, click <emphasis> - <property moreinfo="none">Preview</property> - </emphasis> to see how many matches you have for that particular XPath.</para> - - <figure float="0"> - <title>XPath Preview</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_19.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - </section> - </section> - - <section id="dragndrop_to_jboss_server_view"> - <title>Drag-n-Drop to JBoss Server View</title> - - <para>Starting from 2.0.0.CR2 version of <property moreinfo="none">JBoss AS Tools</property> the - <property moreinfo="none">JBoss Server View</property> supports drag-n-drop of deployable and - runnable projects/resources.</para> - - <figure float="0"> - <title>Dragging to the JBoss Server View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/dnd_toJBossServerView.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>With drag-n-drop the following actions can be performed:</para> - - <itemizedlist> - <listitem> - <para>dragging a project to a server will deploy it to the server and run it by - showing the main page in a browser</para> - </listitem> - - <listitem> - <para>dragging an <emphasis> - <property moreinfo="none">.xhtml</property> - </emphasis> file from <emphasis> - <property moreinfo="none">WebContent</property> - </emphasis> will do the same and show the corresponding page in a - browser</para> - </listitem> - - <listitem> - <para>dragging a deployable resource (i.e. a datasource (<emphasis> - <property moreinfo="none">-ds.xml</property> - </emphasis>) file that has been made deployable) will simply deploy that - resource directly to the server</para> - </listitem> - </itemizedlist> - - <para>In short, the feature does the same thing as if you used the <emphasis> - <property moreinfo="none">Run On Server</property> - </emphasis> option or <emphasis> - <property moreinfo="none">Add and Remove Projects</property> - </emphasis> option in the context menu of the server.</para> - </section> - - <section id="server_log"> - <title>Server Log View</title> - - <para>You can monitor the current server behavior with the help of the <property moreinfo="none">Server - Log</property>. To open a server in the <property moreinfo="none">Server Log view</property> you - should right-click on the server and follow to <emphasis> - <property moreinfo="none">Open in > Server Log</property>.</emphasis></para> - - <para>The <emphasis> - <property moreinfo="none">Server Log</property> - </emphasis> shows relevant information to your server's startup, shutdown, - and publish processes. This allows you to keep an eye on what's going on - (such as automatic incremental deployment if you have it enabled).</para> - - <figure float="0"> - <title>Event Log Actions</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_12.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The <property moreinfo="none">Server Log</property> toolbar contains several icons that perform - the following actions:</para> - - <table> - <title>Server Log Toolbar Icons</title> - <tgroup cols="2"> - <colspec align="left" colnum="1" colwidth="1*"></colspec> - <colspec colnum="2" colwidth="3*"></colspec> - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> - - <tbody> - <row> - <entry> - <para>Export Log</para> - </entry> - <entry> - <para>Possibility to export the log into a text file</para> - </entry> - </row> - - <row> - <entry> - <para>Clear Log Viewer</para> - </entry> - <entry> - <para>The option clears the current server log</para> - </entry> - </row> - - <row> - <entry> - <para>Delete Log</para> - </entry> - <entry> - <para>Click to delete the server log</para> - </entry> - </row> - - <row> - <entry> - <para>Open Log</para> - </entry> - <entry> - <para>Click to open the server log text file</para> - </entry> - </row> - - <row> - <entry> - <para>Restore Log</para> - </entry> - <entry> - <para>Click to restore the server log</para> - </entry> - </row> - - </tbody> - </tgroup> - </table> - - </section> - - <section id="server_editor"> - <title>Server Editor</title> - <para>By double-clicking on any server, an editor window will appear allowing you to - edit parts of that server.</para> - - <figure float="0"> - <title>Preferences Page for the Chosen Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - <para>On the figure you can see that a username/password is available in the UI when - configuring the server. If you get a SecurityException when trying to launch the - server, it is most likely because your server is protected and hence you need to - fill the username/password fields with appropriate values.</para> - </tip> - - <para>It should be pointed out that our server adapter by default tries to automatically - detect the ports it needs for integrating with a <property moreinfo="none">JBoss Server</property>. - Sometimes it can though be relevant to override this automatic detection if you are - using some custom configuration. For this purposes the <emphasis> - <property moreinfo="none">Server Ports</property> - </emphasis> section in the <property moreinfo="none">Server editor</property> is provided where the - port settings are configurable. Click the <emphasis> - <property moreinfo="none">Configure...</property> - </emphasis> link to bring up the wizard for adjusting the settings for the - ports.</para> - - <figure float="0"> - <title>Server Ports Preferences</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Press <emphasis> - <property moreinfo="none">Edit XPath</property> - </emphasis> button for the chosen port to configure its XPath's values.</para> - - <figure float="0"> - <title>XPath Pattern for a Server Port</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Server editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you are able to edit the timeouts and the server pollers to use.</diffmk:wrapper></para> - - <note diffmk:change="added"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">By default, the Startup poller is set to JMX Poller (see the </diffmk:wrapper><emphasis> - <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Server Polling</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> section). If you change the Startup poller - to Timeout Poller (it may need in case, for example, you're using the minimal configuration for your server), this will do no polling at all and will only set the server - state to </diffmk:wrapper><emphasis> - <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">"Started"</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> after your startup timeout is reached.</diffmk:wrapper></para> - </note> - - <para id="com_line_arg"><property moreinfo="none">Server editor</property> makes it also possible to - modify the server's launch configuration. It's just after clicking <emphasis> - <property moreinfo="none">Open launch configuration</property> - </emphasis> link. In the open window there are the tabs for setting command line - arguments, classpaths and other things that are relevant to launching the - server.</para> - - <figure float="0"> - <title>Launch Configuration Properties</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_7.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Look up <ulink url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/start-stop.html"><diffmk:wrapper diffmk:change="changed">AS Installation Guide </diffmk:wrapper></ulink> to find parameters which can be specified for <property moreinfo="none">JBoss - Server</property>.</para> - - <note> - <title>Note:</title> - <para>Please note, that the Launch Configurations for JBoss Servers are enough - strict in enforcing the configured values in the server in order to avoid - inconsistencies between server's and their configured runtime.</para> - - <para>For example, if you change the launch configuration program arguments to - <emphasis>"-c myConfig"</emphasis> but do not change the - targeted runtime configuration, then your program arguments will be ignored. The - server runtime "wins" so to speak. This ensures consistency - and if you change the location of the runtime, your launch configurations will - automatically pick that up.</para> - - <para>Values are not controlled by the server and its runtime setup will be passed - on unaltered.</para> - </note> - - <para>Until 3.0.0.GA release of <property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="changed">, the servers classpath - was readonly, but that caused problems for users wanting to add their own jars in - the startup classpath. That is relevant if you need to patch the server, add a - custom charset or other tweaks that require early access to the classpath.</diffmk:wrapper></para> - - <para>Now all servers have a custom 'server runtime classpath - container', which is there by default and point to the default jars in - JBoss. You can now adjust the classpath. Then just make sure this container is there - if you want the classpath to be picked up.</para> - - <figure float="0"> - <title>Server Classpaths</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/server_classpaths.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>If for some reason you have a launch configuration without this container, <emphasis> - <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Restore Default Entries</diffmk:wrapper></property> - </emphasis> should add it properly. Also, <emphasis> - <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Restore Default Entries</diffmk:wrapper></property> - </emphasis><diffmk:wrapper diffmk:change="changed"> will also remove any extra entries you added yourself.</diffmk:wrapper></para> - </section> - - <section> - <title>Relevant Resources Links</title> - <para>Find more about XPath in the <ulink url="http://www.w3.org/TR/xpath20/">XPath - Documentation</ulink>.</para> - </section> - </section> - - <section id="Project_archivesView" role="updated"> - <title>Project Archives View</title> - <para>Every application, whether Plain Old Java, J2EE, or some other language altogether, - needs to be packaged in some way. In Java-related projects, many people use ANT. </para> - <note> - <title>Note:</title> - <para>Those who use ANT will appreciate how the Project Archives Ant task is now - improved: it supports variables and gives more informative error/logging messages - when something goes wrong.</para> - </note> - - <para>But <property moreinfo="none">JBoss Tools</property> come with our own Archives tool with a bit easier - and less-verbose XML and a handy user interface. The Project Archives plugin consists - primarily of a view, that is <property moreinfo="none">Project Archives view</property>, to set up each - packaging configuration.</para> - <para>So far, let's look through all functionality that the <property moreinfo="none">Project - Archives view</property> provides.</para> - - <section id="archives_overview"> - <title>Overview</title> - - <para>The packaging configuration for each project is stored in the project's root - folder, and is in a file named <emphasis> - <property moreinfo="none">.packages</property> - </emphasis>, which has a fairly simple XML structure. Modifying the file by hand is - neither required nor recommended, and using the UI is the official way of modifying - your packaging structure.</para> - - <figure float="0"> - <title>Archives View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_21.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>A project's configuration contains archives. As you can see on the image - above a project can contain more than one archive. Internal archives and filesets - can be directly inside of an archive, or in some sub-folder of that archive.</para> - - <para>In the upper right corner of the view you can see an icon which, when clicked, - will build the selected top-level archive. Additionally, you can select <emphasis> - <property moreinfo="none">Project > Build Packages</property> - </emphasis> when a project is selected in the <property moreinfo="none">Packages View</property> to - build all declared packages in that project's <emphasis> - <property moreinfo="none">.packages</property> - </emphasis> file. This will execute a full build on all declared archives.</para> - </section> - - <section id="Creating_Archive"> - <title>Creating an Archive</title> - - <para>When you open the <property moreinfo="none">Project archives view</property> for the first time, - it asks you to select the project for what you want to create an archive.</para> - - <figure float="0"> - <title>Archives View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_21a.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>When creating a new archive for selected project, you have some different options - at your disposal. You need right-click inside the view and select <emphasis> - <property moreinfo="none">New Archive</property> - </emphasis> to see your archive type options.</para> - - <figure float="0"> - <title>Create an Archive</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_22.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - <para>If you see only JAR from the list of available archive types, you should - verify whether AS Tools plugins/features are in place. EAR, EJB JAR and WAR - options are contributed by the AS Tools independently from webtools and the - virtual project model. Thus, without them only JAR will show up.</para> - </note> - - <para><property moreinfo="none">JAR</property> is the standard archive type, and does very little - configuration, leaving most of the work up to you. You can customize the name, add - folders, filesets, and inner jars to it.</para> - - <para>The other types, for the most part, simply start off with a default setting, - usually the jar with some specific children based on an expected structure of the - project. For example, if the project is a Dynamic Web Project, and you create a - <property moreinfo="none">WAR</property> archive, the archive will be created with a few - filesets relevant to the known structure of the project.</para> - - <para>Here is the first page of all New archive wizards. It is the same for any archive - type and the only page in the <property moreinfo="none">New Jar wizard</property>.</para> - <figure float="0"> - <title>New WAR Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_23.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The page is pretty simple. First it asks to set the name of your new archive and a - destination.</para> - - <para>The destination of an archive can be anywhere on the file system, anywhere in the - workspace, inside some other archive, or inside a folder declared inside an archive. - Select the necessary checkbox (either <emphasis> - <property moreinfo="none">workspace</property> - </emphasis> or <emphasis> - <property moreinfo="none"> file system</property> - </emphasis>) for marking the destination as related to either workspace or file - system. You can browse to workspace or filesystem destinations by clicking on their - respective buttons. To select a destination inside some other archive, you'll need - to press the <emphasis> - <property moreinfo="none">Workspace</property> - </emphasis> button. At the bottom of the list, you'll see archives that - have been declared in the workspace.</para> - - <figure float="0"> - <title>Selecting the destination in the workspace</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_23a.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Also in the wizard for creating a new archive you can choose whether an archive to - be compressed or exploded into a folder (without compression). You need just select - proper chechbox in the <emphasis> - <property moreinfo="none">Archive type</property> - </emphasis> section.</para> - <para>If a build or incremental update fails Project Archives will show an error - dialog:</para> - <figure float="0"> - <title>Selecting the destination in the workspace</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/projectarchives_error.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click in <emphasis> - <property moreinfo="none">Details</property> - </emphasis> to see detailed information about what caused the error.</para> - - <para>In the <property moreinfo="none">Package Explorer</property> you can observe the created - archive.</para> - <figure float="0"> - <title>The Archive in the Package Explorer</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_23b.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>If you use the exploded type of archiving, instead of a single file archive the - result put into a folder is displayed in the <property moreinfo="none">Package - Explorer</property>.</para> - <figure float="0"> - <title>The Exploded Archive in the Package Explorer</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_23c.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <section id="CreatingaFolder"> - <title>Creating a Folder</title> - <para>Creating a folder is much easier. You simply right-click on an archive or - folder you want your new folder to be a child under. The only piece of required - information is naming the file.</para> - </section> - <section id="CreatingaFileSet"> - <title>Creating a FileSet</title> - <para>To create a new fileset, you click on an available target location such as an - archive, a nested archive, or a folder within an archive, and select <emphasis> - <property moreinfo="none">New Fileset</property>. </emphasis></para> - <para>The <property moreinfo="none">New Fileset wizard</property> requires a destination (where the - files will go), and a root directory (or where the files are coming from). The - source can be anywhere in the workspace or from the filesystem at large.</para> - - <figure float="0"> - <title>Adding a New FileSet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_24.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Below that, the fileset requires only an includes pattern and an excludes - pattern. As you type in either of these fields, the preview viewer should update - itself with which files are matched.</para> - - <para>You can create a Fileset with flattening or without it. Look at the difference - on the figure below.</para> - - <figure float="0"> - <title>The FileSet with flattening and without it</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_24a.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - </section> - </section> - - <section id="View_Actions"> - <title>Archive Actions</title> - <figure float="0"> - <title>Context Menu on the Item</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_25.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>The context menu on the items in the view is extendable, but there are several - that come standard.</para> - - <table> - <title>Context Menu on the Item</title> - <tgroup cols="2"> - <colspec align="left" colnum="1" colwidth="1*"></colspec> - <colspec colnum="2" colwidth="3*"></colspec> - - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> - - <tbody> - - <row> - <entry> - <para>Build Archive (Full)</para> - </entry> - - <entry> - <para>The action enabled only on top-level archives, which initiates - a full build on that archive</para> - </entry> - </row> - - <row> - <entry> - <para>Edit Archive</para> - </entry> - - <entry> - <para>Standard action that brings up the wizard associated with that - particular node type and allows the details to be changed</para> - </entry> - </row> - - <row> - <entry> - <para>Delete Archive</para> - </entry> - - <entry> - <para>Deleting node is standard action with deletion not needing an - explanation</para> - </entry> - </row> - - <row> - <entry> - <para>Publish To Server</para> - </entry> - - <entry> - <para>The action means the ability to publish to a declared - server</para> - </entry> - </row> - - <row> - <entry> - <para>Edit publish settings</para> - </entry> - - <entry> - <para>Gives possibility to edit an archive publish settings</para> - </entry> - </row> - - </tbody> - </tgroup> - </table> - </section> - - <section id="PublishToServer"> - <title>Publishing to Server</title> - <para>Finally, you'll need to publish your application to a server. Here, we - show you how to do it with the help of <emphasis> - <property moreinfo="none">Archives View</property>. </emphasis></para> - - <figure float="0"> - <title>Context Menu on the Item</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_26.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>The dialog above appears after selecting <emphasis> - <property moreinfo="none">Publish To Server</property>. </emphasis> To simply publish once, you - just select the server(s) that you want, and finish. If you want the <emphasis> - <property moreinfo="none">Publish to Server</property> - </emphasis> action on that particular Archive to publish always to that set of - servers, then check the appropriate checkbox. And finally, to enable automatic - publishing upon build events, check the last checkbox.</para> - <para>The automatic publishing feature is nice if, for example, your package's - destination (where it is built) is a temporary folder and you want the archive - published to several servers. If you only really want your archive published to one - server, it might be easier to have the archive's destination folder be the deploy - folder of the server.</para> - </section> - <section id="rel_res_links_archiving"> - <title>Relevant Resources Links</title> - <para>Refer to <ulink url="http://ant.apache.org/manual/index.html">Ant manual</ulink> - to find more on how to build your applications with help of Ant.</para> - - <para>We also recommend you to watch the <ulink url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.htm">movie</ulink> which demonstrates a powerful archiving functionality in - <property moreinfo="none">JBoss Tools</property>.</para> - - <para>At this point, you are guessed to be familiar with <property moreinfo="none">JBoss AS - perspective</property> and your next step now is to explore how to work with - different kinds of projects.</para> - </section> - - </section> - - -</chapter> - - -<chapter id="webtools" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/webtools.xml"> - <title>Projects</title> - <para>The most popular of the projects we deal with are the J2EE ones, such as Dynamic Web - Project, EJB Project, or EAR project. Web projects of <property moreinfo="none">JBoss Tools</property> are - Struts, JSF and Seam projects. All of them are called faceted projects. Thus, in this - chapter we are going to tell you about facets the main benefit of which to provide proper - structuring and packaging for any type of project.</para> - - <section> - <title>Faceted Projects Overview</title> - <para>The idea behind faceted projects is that each project can accept units of - functionality, or facets, which can be added or removed by the user. Most often, these - facets either add to the project's classpath, enable a builder, or watch the project in - some other fashion. Generally, every project concerned has at least one facet when - it's created. As an example, a Web project has a WebDoclet facet, or an EJB - Project has an EJB Module facet as prerequisites.</para> - - <para> WTP projects have undergone some criticism as being - <emphasis>over-engineered</emphasis> or too restrictive in their design. WTP projects - are set up in a tree-relationship to each other, where one project can be a child of - another. For example, an EAR project may have a Web Project child, an EJB project child, - or other types.</para> - - <para> However, the benefit of this is that the structure of your projects is then known, - and packaging it up *should* be trivial. Apparently, if your project is non-standard, or - you feel too confined by such rigid structural requirements, you can still choose to - package your project using the <link linkend="Project_archivesView">Archives - plugin</link>.</para> - </section> - - - <section> - <title>Adding Facets to a Project</title> - - <para>In this section we're going to consider the facets added by <property moreinfo="none">JBoss - Tools</property> and show how you can configure them in a project: add new ones or - modify already existing configuration of the facets.</para> - - <para>One way to configure the facets is doing it while organizing a new project. To - demonstrate this let's create a new <property moreinfo="none">Dynamic Web Project</property> by - selecting <emphasis> - <property moreinfo="none">File > New > Other...</property> - </emphasis> and then <emphasis> - <property moreinfo="none">Web > Dynamic Web Project</property>. </emphasis></para> - <figure float="0"> - <title>New Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/webtools/webtools_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click <emphasis> - <property moreinfo="none">Next</property> - </emphasis> and you will see Dynamic Web Project page like on the figure below.</para> - - <para> The first page of most WTP projects allows you to target a specific runtime, - representing a server's library location. It will also provide you the ability to add - this project to an EAR project, and select a preselected default set of facets, called - a configuration, rather than manually select each facet you might want.</para> - <para> Selecting the runtime, again, allows the project to install the proper classpaths to - the project so it knows what code to compile against.</para> - - <figure float="0" id="dyn_web_project"> - <title>New Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/webtools/webtools_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click on the <emphasis> - <property moreinfo="none">Modify</property> - </emphasis> button next to <property moreinfo="none">Configuration</property> section in order to open - the wizard which allows you to modify a chosen configuration. The wizard looks as - follows.</para> - - <figure float="0" id="project_facets"> - <title>Project Facets Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/webtools/webtools_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Here part of the listed facets are those which are provided by WTP. Some of them are - added by <property moreinfo="none">JBoss Tools</property>. They are:</para> - <itemizedlist> - <listitem> - <para>BIRT Charting Runtime Component</para> - </listitem> - <listitem> - <para>BIRT Reporting Runtime Component</para> - </listitem> - <listitem> - <para>JBoss ESB</para> - </listitem> - <listitem> - <para>JBoss Portlets</para> - </listitem> - <listitem> - <para>JBoss Web Services</para> - </listitem> - <listitem> - <para>Seam</para> - </listitem> - </itemizedlist> - - <para>On this wizard page you can enable or disable any facet as well as change it version. - What you should note here is that some facets or facets versions may conflict with each - other. In case of incompatibility you'll be prompted about this in the combo - box underneath.</para> - <figure float="0"> - <title>Facet Constraints</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/webtools/webtools_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>When switching on the <emphasis> - <property moreinfo="none">Runtimes</property> - </emphasis> tab on the right you'll see the current server Runtime.</para> - <figure float="0"> - <title>Runtimes on the Project Facets Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/webtools/webtools_5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>On this tab you can also create a new Server Runtime and make it primary by pressing <emphasis> - <property moreinfo="none">Make Primary</property> - </emphasis> button after enabling it.</para> - - <para>Clicking on <emphasis> - <property moreinfo="none">OK</property> - </emphasis> will save the chosen configuration of the facets and return you to the <link linkend="dyn_web_project">Dynamic Web Project wizard</link>. Further pages in the - wizard are specific to either the project type or the facets selected.</para> - - - <para>If you need to configure the facets for the existing project, you should bring up the - context menu for selected project and click <emphasis> - <property moreinfo="none">Properties</property> - </emphasis> and then <emphasis> - <property moreinfo="none">Project Facets</property>. </emphasis> This will bring up the familiar - <link linkend="project_facets">Project Facets wizard</link>, where you can create - your own custom facets configuration.</para> - - <para></para> - - </section> - <section id="rel_resources_links"> - <title>Relevant Resources Links</title> - - <para>More on the WTP facets you can read in the <ulink url="http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.jst.j2ee.do...">eclipse help</ulink>.</para> - </section> -</chapter> - - -<chapter id="modules" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/modules.xml"> - <title>Deploying Modules</title> - - <para>In this chapter it will be described how to deploy modules onto the server.</para> - <para> First of all it is necessary to say that deploying to a server is mostly painless. There - are several ways to do it provided by WTP, and some additional methods provided by JBoss - Tools. These methods are described further in this chapter.</para> - - <section> - <title>Deploying on the Package Explorer</title> - - <para>On the package explorer it is possible to publish either a project to a server or just - a single file. Let's look at how to do this.</para> - <section id="run_on_server_wizard"> - <title>Deploying with Run On Server Wizard</title> - <para> The first WTP method is to right-click on a project, such as a Dynamic Web - project, EJB project, or EAR project and then select <emphasis> - <property moreinfo="none">Run As > Run on Server</property> - </emphasis>. The resulting dialog allows you to select which supporting server the - project can be published to.</para> - <figure float="0"> - <title>Define a New Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/modules/modules_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click <emphasis> - <property moreinfo="none">Next</property> - </emphasis> button to see add or remove projects page where you can choose projects - to configure them on server.</para> - <figure float="0" id="add_rem_proj"> - <title>Add or Remove Projects</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/modules/modules_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>This page of the wizard also allows to undeploy modules from the server. For that - choose proper module(s) from the right and click <emphasis> - <property moreinfo="none"> < Remove</property> - </emphasis>. The modules will be completely undeployed after restarting your server - or republishing.</para> - <para>Generally, for the JBoss AS Server Adapters, publishing using this method will - force a default, best-guess, packaging configuration for your project. This - best-guess does not publish incrementally, but instead repackages your entire - project into a <emphasis> - <property moreinfo="none">.war</property> - </emphasis>, <emphasis> - <property moreinfo="none">.jar</property> - </emphasis>, or <emphasis> - <property moreinfo="none">.ear</property> - </emphasis> as appropriate, and then copies that file into the proper deploy - directory. For quicker smarter deployment, you will need to create archives using - the <link linkend="Project_archivesView">Project Archives view</link> and customize - packaging yourself.</para> - - - - </section> - - <section id="single_file_deployment"> - <?dbhtml filename="DeployToServer.html"?> - <title>Deploying single files</title> - - <para>Sometimes it becomes necessary to deploy one or more files to a server. For - that in order not to do a full republish in the context menu of files a <emphasis><property moreinfo="none">Deploy To Server</property></emphasis> - option is provided that allows a single file deployment. To deploy these non-WTP files/projects - right click on the file (<emphasis> - <property moreinfo="none">-ds.xml</property></emphasis>, <emphasis> - <property moreinfo="none">.ear</property></emphasis>, <emphasis> - <property moreinfo="none">.jar</property></emphasis> etc.) and select <emphasis> - <property moreinfo="none">Deploy To Server</property> - </emphasis> and it will be automatically deployed.</para> - <figure float="0"> - <title>Deploy to Sever</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/modules/modules_6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>The deployed files are listed side-by-side with other modules that are deployed to - the server.</para> - - <figure float="0"> - <title>Deployed files on the Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/modules/modules_7.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - </section> - - </section> - <section> - <title>Deploying with JBoss Server View</title> - <para>As it has been already mentioned <property moreinfo="none">JBoss Server View</property> contains two - parts: the top part that displays all defined servers and the bottom part which provides - categories with additional information. Thus, in this section we suggest two more ways - to deploy resources onto the server.</para> - <section> - <title>Top part of JBoss Server View</title> - <para>In the top part of the <property moreinfo="none">JBoss Servers View</property> like in the Servers - View you should right click on a server and select the <emphasis> - <property moreinfo="none">Add and Remove Projects</property> - </emphasis> menu item.</para> - <figure float="0"> - <title>Add and Remove Projects</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/modules/modules_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>This will bring up a <link linkend="add_rem_proj">familiar dialog</link> allowing - you to either publish projects or modules to a server, or remove them from the - server. If the selected module is a project like a Dynamic Web project, EJB project, - or EAR project, it will be published as through <emphasis> - <property moreinfo="none">Run on Server</property> - </emphasis> wizard, with a best-guess full package. If, however, the selected - element is an archive from the <link linkend="Project_archivesView">Project Archives - view</link>, it will be published according to the rules of that module - type.</para> - </section> - - <section> - <title>Bottom part of JBoss Server View</title> - <para>In the bottom part of <emphasis> - <property moreinfo="none">JBoss Server View</property> - </emphasis> there is a category called <emphasis> - <property moreinfo="none">Modules</property> - </emphasis> which should display all currently-published modules on the server. - Right-clicking on the desired module and selecting <emphasis> - <property moreinfo="none">Full Publish</property> - </emphasis> will force a full rebuild of the entire module.</para> - <figure float="0"> - <title>Full Publish</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/modules/modules_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Here, <emphasis> - <property moreinfo="none">Incremental Publish</property> - </emphasis> is meant to enable publishing of only those parts where changes have - been made.</para> - </section> - </section> - <section> - <title>Deploying with Project Archives View</title> - <para>In the <property moreinfo="none">Project Archives View</property> you can right-click on any declared - archive and select the <emphasis> - <property moreinfo="none">Publish To Server</property> - </emphasis> element. For more on this subject, see <link linkend="PublishToServer">Publishing to Server</link> in the Project Archives View section.</para> - <figure float="0"> - <title>Publish to Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/modules/modules_5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para> The only way to ensure an <emphasis> - <property moreinfo="none">Incremental Build</property> - </emphasis>, such as changes to one <emphasis> - <property moreinfo="none">.jsp</property>, </emphasis> - <emphasis> - <property moreinfo="none">.html</property>, </emphasis> or <emphasis> - <property moreinfo="none">.class</property> - </emphasis> file, is to enable the builder for that project. This is done by either - changing the global preferences for the <property moreinfo="none">Archives View</property>, or by - enabling project-specific preferences and ensuring the builder is on.</para> - - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can also use the "Finger touch" button for a quick restart of the project without restarting the server:</diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Finger Touch button</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/modules/modules_8_finger_touch.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR, jboss-esb.xml in ESB projects).</diffmk:wrapper></para> - - - <para>The last chapter covers a variety of methods on how you can deploy needed modules onto a - server.</para> - </section> -</chapter> - - -<chapter id="tptp_support" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/tptp_support.xml"> - <title>TPTP Support</title> - <para>This chapter provides an overview on how to enable TPTP Profiling for <property moreinfo="none">JBoss - AS</property> adapters in <property moreinfo="none">JBoss Tools</property>.</para> - - <section> - <title>TPTP Profiling</title> - - <para>To get TPTP profiling work on <property moreinfo="none">JBoss Application Server</property> you should - first download <ulink url="http://www.eclipse.org/downloads/download.php?file=/tptp/4.5.0/TPTP-4.5.0...">TPTP 4.5.0 Runtime</ulink> and install it, i. e. just add the content of <emphasis> - <property moreinfo="none">plugins/features</property> - </emphasis> folders from downloaded directory to the same folders in your eclipse - installation directory.</para> - - <para>And now all profile actions should work for you. To start <property moreinfo="none">JBoss - AS</property> in profiling mode use <emphasis> - <property moreinfo="none">Start the server in profiling mode</property> - </emphasis> button or <emphasis> - <property moreinfo="none">Profile As > Profile on Server</property> - </emphasis> option in the context menu of the project.</para> - - <figure float="0"> - <title>Start the Server in Profiling mode</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/tptp_support/tptp_support_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>To enable TPTP features in your workbench use <property moreinfo="none">Profiling and Logging - Perspective</property> that you can find in the list of proposed perspectives: <emphasis> - <property moreinfo="none">Window > Open Perspective > Other…</property> - </emphasis> - </para> - - <figure float="0"> - <title>Profiling and Logging Perspective</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/tptp_support/tptp_support_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </section> - - <section> - <title>Relevant Resources Links</title> - <para>All additional information on TPTP(Test and Performance Tools Platform) you can find - in <ulink url="http://www.eclipse.org/tptp/home/downloads/4.5.0/documents/quicktour/quic...">eclipse documentation</ulink>.</para> - <para>In summary, this reference should help you to start with <ulink url="http://www.jboss.org/jbossas">JBoss AS</ulink> and get to know with functionality - for work with it.</para> - </section> -</chapter> - - -</book> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JBoss Server Manager Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author><firstname>Rob</firstname><surname>Stryker</surname><email>rob.stryker(a)jboss.com</email></author> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 2.1.0.CR1 + </diffmk:wrapper></releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_Reference_...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + + <toc></toc> + +<chapter id="quick_start" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/as/docs/reference/en/modules/quick_start.xml"> + <title>Quick Start with JBoss Server</title> + + <para>This chapter covers the basics of working with the <property moreinfo="none">JBoss Server</property>.</para> + + <section id="JBoss_server_key_features"> + <title>Key Features of JBoss Server</title> + <para>For a start, we propose you to look through the table of main features of JBoss Server:</para> + + <table> + + <title><diffmk:wrapper diffmk:change="changed">Key Functionality for JBoss AS and Archive Tools</diffmk:wrapper></title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec align="left" colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + <tbody> + <row> + <entry><para>JBoss AS plugin</para></entry> + <entry><para>Using WTP, JBoss AS plugin allows working with the server in run or debug mode. You can easily install runtimes and servers, copy the existing runtime configuration or configure it up to your needs.</para></entry> + <entry> + <link linkend="runtimes_servers">runtimes and servers</link> + </entry> + </row> + + <row> + <entry><para>JBoss AS Perspective</para></entry> + <entry><para>It makes managing installed JBoss Server quite easy and includes the standard Console and Properties views, and specially added Project archives View and JBoss Server View for that purpose. </para></entry> + <entry> + <link linkend="perspective">JBoss AS perspective</link> + </entry> + </row> + + <row> + <entry><para>Modules Deployment</para></entry> + <entry><para>A number of ways, provided by WTP and JBoss Tools, to deploy either a project or a single file on the server.</para></entry> + <entry> + <link linkend="modules">deploying modules</link> + </entry> + </row> + + <row> + <entry><para>TPTP Support</para></entry> + <entry><para>Test and Performance Tools Platform (TPTP) profiling.</para></entry> + <entry> + <link linkend="tptp_support">TPTP support</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + <para><diffmk:wrapper diffmk:change="changed">If you + already have installed JBoss server and runtime you can quickly learn how to configure, start, + stop the server, to know deployment and archiving processes. How to install runtimes and servers + read in the </diffmk:wrapper><link linkend="runtimes_servers">Runtimes and Servers in the JBoss AS plugin</link><diffmk:wrapper diffmk:change="changed"> + chapter.</diffmk:wrapper></para> + + <para>To start working with JBoss AS, select a <property moreinfo="none">JBoss AS Perspective</property><diffmk:wrapper diffmk:change="changed"> via + </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Open Perspective > Other > JBoss + AS</diffmk:wrapper></property>.</emphasis></para> + </section> + + <section id="starting"> + <title>Starting JBoss Server</title> + + <para>Starting <property moreinfo="none">JBoss Server</property> is quite simple. You can control the server + behaviour with the help of a special toolbar in the <property moreinfo="none">JBoss Server View</property> + where you could <emphasis> + <property moreinfo="none">start</property> + </emphasis> it in a regular or debug mode, <emphasis> + <property moreinfo="none">stop</property> + </emphasis> it or <emphasis> + <property moreinfo="none">restart</property> + </emphasis> it and <emphasis> + <property moreinfo="none">publish</property> + </emphasis> to the server.</para> + + <figure float="0"> + <title>JBoss Server Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To launch the server click the green-with-white-arrow icon on the <property moreinfo="none">JBoss Server + View </property>or right click server name in this view and select <emphasis> + <property moreinfo="none">Start</property>. </emphasis> If this view is not open, select + <emphasis><property moreinfo="none">Window > Show View > Other > Server > + JBoss Server View</property>.</emphasis></para> + + <figure float="0"> + <title>Start JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="stopping"> + <title>Stopping JBoss Server</title> + + <para>To stop the server, click the <emphasis> + <property moreinfo="none">Stop</property> + </emphasis> icon in the <property moreinfo="none">JBoss Server View</property> or right click the server name + and press <emphasis><property moreinfo="none">Stop</property>.</emphasis></para> + + <figure float="0"> + <title>Stop JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When the server is stopped you will see <emphasis> + <property moreinfo="none">Stopped</property> + </emphasis> state next to its name in the square brackets.</para> + <para>Learn more about the <property moreinfo="none">JBoss Server View</property> + <link linkend="JBossServerView">here</link>.</para> + </section> + + <section id="archiving"> + + <title>Project Archiving</title> + + <para><property moreinfo="none">JBoss Tools</property> comes with our own archives tool. The Project Archives + plugin consists primarily of a view to set up each packaging configuration <emphasis>( + <property moreinfo="none">Window > Show View > Other > JBoss Tools > Project archives</property>). + </emphasis></para> + <para>Right clicking in the <property moreinfo="none">Project archives view</property> you can create War, + EJB War, EAR or JAR archive.</para> + + <figure float="0"> + <title>Archive Creating</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Using the context menu on the item you can initiate a <emphasis><property moreinfo="none">full build</property></emphasis> on + archive, <emphasis><property moreinfo="none">edit</property>,</emphasis> <emphasis><property moreinfo="none">delete</property></emphasis> or + <emphasis><property moreinfo="none">publish</property></emphasis> it.</para> + + <figure float="0"> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you wish, you can assign a hotkey for the Build Project Archive action. A key binding can be added + by navigating to <emphasis> + <property moreinfo="none">Window > Preferences > General > Keys</property>.</emphasis></para> + + <figure float="0"> + <title>Setting the Hotkey for Build Project Archive Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/hotkeys.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To perform the building of the project archives, select the project in the <property moreinfo="none">Package Explorer</property> view and execute the hotkey combination + you assigned for this action.</para> + + <para>Learn more about the <property moreinfo="none">Project Archives View</property> + <link linkend="Project_archivesView">here</link>.</para> + </section> + + <section id="deployment"> + <title>Deploying an Application to a Server</title> + + <para>There are two times to deploy your application:</para> + <itemizedlist> + <listitem> + <para>While creating it</para> + </listitem> + <listitem> + <para>After it already exists</para> + </listitem> + </itemizedlist> + + <para>When you create a new project (Seam, JSF or Struts) with the New Project or Import Project + wizards, the one of wizards steps has a <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> and <emphasis> + <property moreinfo="none">Target Server</property> + </emphasis> sections. You can deploy the application through the appropriate selection in + these sections.</para> + + <figure float="0"> + <title>Runtime and Server Sections in the New Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Runtime and Server Sections in the Import Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can deploy an existing application to a server by right-clicking the target defined + server in the <property moreinfo="none">JBoss Servers View</property> and then selecting <emphasis><property moreinfo="none">Add and + Remove Projects</property></emphasis> from the context menu.</para> + + <figure float="0"> + <title>Add and Remove Projects From the Context Menu.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If this application is not assigned to a server, it will be in the left-hand available + projects list. Clicking on the <property moreinfo="none">Add ></property> button will add it to the right-hand + configured projects list and deploy the application to this server.</para> + + <figure float="0"> + <title>Modifying The Projects that are Configured on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section diffmk:change="added" id="publishing"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Publishing to JBoss Server</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The publishing of all the modules added to a Server is performed automatically when starting a Server.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The automatic publish of the changes made to the workspace is turned on by default in order to permanently keep + the workspace in sync with the publish folder. If you need to control when to publish the changes, + just disable the automatic publish in the </diffmk:wrapper><link diffmk:change="added" linkend="server_editor"><diffmk:wrapper diffmk:change="added">Server Editor</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> and use the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Publish to Server</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> (</diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/quick_start/publish_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added">) button which initiates an incremental publish. + </diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Here, we have just performed the basic steps you should know to quick start with JBoss + server. In fact, there are more functionalities which you can make use of. Further we will + talk about them in detail.</diffmk:wrapper></para> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/2.1.0.GA">on JBoss Tools release documentation page</ulink>.</para> + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools nightly builds documentation page</ulink>.</para> + + <para>Find out the answers on the frequently asked questions about JBoss AS 5 usage in the + <ulink url="http://www.jboss.org/community/wiki/jboss5faq">JBoss5FAQ</ulink>. + </para> + + <para>The information on how to monitor a remote JBoss Server from Eclipse you can find in the following + <ulink url="http://www.jboss.org/community/wiki/MonitorARemoteJbossServerFromEclipse">wiki article</ulink>.</para> + </section> + +</chapter> + + +<chapter id="runtimes_servers" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/as/docs/reference/en/modules/runtimes_servers.xml" xreflabel="runtimes_servers"> + <?dbhtml filename="runtimes_servers.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Runtimes and Servers in the JBoss AS plugin</title> + + <para>In this chapter we will discuss how to install runtimes and servers.</para> + + <para>First of all it's necessary to mention that the JBoss AS plugin makes use of WTP. + This includes starting and stopping servers in run or debug mode. It also includes targeting WTP + projects, such as Dynamic Web Projects, to certain server runtimes in order to ensure that the + proper jars from a specific server are added to the project's classpath + properly.</para> + <para>In order to get started creating, running, and debugging J2EE applications, we should create + our <property moreinfo="none">runtime</property> and <property moreinfo="none">server</property> instances.</para> + + <section> + <title>Runtimes</title> + <para>In <property moreinfo="none">JBoss Tools</property>, the main purpose of Server Runtimes is to point to a + server installation somewhere on disk. In our case, this will be a JBoss installation, and it + can then be used for two primary purposes:</para> + <itemizedlist> + <listitem> + <para>it provides classpath additions to WTP projects that require them.</para> + </listitem> + <listitem> + <para>for <property moreinfo="none">JBoss server</property> at least, it provides information necessary for + the starting and stopping of the server, it tells which jars to run and which + configuration to use.</para> + </listitem> + </itemizedlist> + + <section id="InstNewRuntime"> + <title>Installing a New Runtime</title> + <para>You can install runtimes into eclipse from the <emphasis> + <property moreinfo="none">Window > Preferences </property> + </emphasis> menu, and then select <emphasis> + <property moreinfo="none">Server > Runtime Environments</property> + </emphasis> from the categories available on the left.</para> + <figure float="0"> + <title>Installed Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>From this preference page you can see all declared runtimes and their types as well. + Here, it's possible to edit or remove existing runtimes as well as add a new + one.</para> + + <para>To create a JBoss runtime click <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button and choose a necessary type of runtime from the <emphasis> + <property moreinfo="none">JBoss Community</property> + </emphasis> category.</para> + + <figure float="0"> + <title>Adding a Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>Now there is a separation between .org servers (the <emphasis> + <property moreinfo="none">JBoss Community</property> + </emphasis> category) and product server that comes with JBoss EAP in JBDS ( the <emphasis> + <property moreinfo="none">JBoss Enterprise Middleware</property> + </emphasis> category).</para> + </note> + + <para>As you can see, <property moreinfo="none">JBoss Tools</property> provide its own adapters such as JBoss + 3.2, 4.0, 4.2 and 5.0 as well. The last one comes with its own new feature, that is a safer + incremental deployment, which prevents partial deployments to be picked up by the server. It + means that scanning for auto-deployment is suspended while files are being copied to the + deployment location and resumed when the copy is completed.</para> + + <note> + <title>Note:</title> + <para>Currently we recommend you to use a fully supported JBoss 4.2 server adapter.</para> + </note> + + <para>You'll also note a Deploy-Only Runtime type. This type provides no classpath + for WTP projects. It is used solely by its server type for the purpose of setting up a + deploy directory for users who don't wish to make use of starting, stopping, or + debugging their projects inside eclipse.</para> + + <figure float="0" id="add_runtime_figure"> + <title>Adding a JBoss 4.2 Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The following table describes all the available options of the currant wizard + page.</para> + <table> + <title>Server Runtime Wizard Parameters</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Name</para> + </entry> + <entry> + <para>The name of a new Runtime for a chosen server. We suggest that you + don't leave a default value. It's better to give descriptive + names that will help to distinguish one runtime from another.</para> + </entry> + </row> + + <row> + <entry> + <para>Home directory</para> + </entry> + <entry> + <para>The path to a directory where the runtime is installed.</para> + </entry> + </row> + + <row> + <entry> + <para>JRE</para> + </entry> + <entry> + <para>The proper Java Runtime Environment. Because of the open-source nature of + JBoss, a user is likely to want to modify and repackage some of the + configuration-specific jboss jars and create their own configuration. Thus, rather + than forcing you to copy his entire JBoss installation, the structure of the + wizard allows to create only a new configuration instead.</para> + </entry> + </row> + + <row> + <entry> + <para>Directory</para> + </entry> + <entry> + <para>The path to a directory where the configurations are installed.</para> + </entry> + </row> + <row> + <entry> + <para>Configuration</para> + </entry> + <entry> + <para>The list of configurations (all, default, minimal) that is updated as soon as + you browse to a valid runtime installation folder.</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>As a result of having each runtime represent a specific configuration rather than the + server installation as a whole, it is very likely you'll create several different + runtimes to test each of your configurations. It becomes important to ensure your runtimes, + and later your servers, are given descriptive names that help you to remember which is + which.</para> + + <para>Press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to see your new runtime in the list.</para> + <note> + <title>Note:</title> + <para>If you edit the configuration of a runtime, the changes don't affect the settings of the servers that currently use the runtime. + To apply the changes to them also,you should double right click the server, <emphasis> + <property moreinfo="none">Overview>Runtime Environment</property> </emphasis> + ,make sure that necessary configuration is chosen,click <emphasis><property moreinfo="none">Finish</property> </emphasis> and then <emphasis><property moreinfo="none">Save</property></emphasis> button.</para> + </note> + </section> + <section id="CopyRuntime"> + <title>Copying the existing runtime configuration</title> + <para>While installing a new runtime you can copy the configuration from the existing one. + To do this you should perform all the steps in the <link linkend="InstNewRuntime">previous</link> section except pressing <emphasis> + <property moreinfo="none">Finish</property></emphasis> + in the New Server Runtime Environment menu . + </para> + <para>Make sure that you browse to a valid runtime folder and can see the list of configurations (all, default, minimal) in the Configuration section . + Then choose necessary Configuration from the list and click <emphasis> + <property moreinfo="none">Copy</property></emphasis>.The next dialog should appear. + </para> + <figure float="0"> + <title>Copy the existing configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Change the name Click on <emphasis> + <property moreinfo="none">Browse</property></emphasis> and select your configuration location or leave as it's if you want it to be located together with other runtime configurations. + </para> + <figure float="0"> + <title>Copy the existing configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click<emphasis> + <property moreinfo="none"> Ok </property></emphasis>and you should see the next wizard with the just added copied configuration. + + </para> + <figure float="0"> + <title>Runtime with copied configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> Press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> and you will see your new runtime in the list. + </para> + <para>You can also change a configuration of existing runtime to a copied one in the same way from the <emphasis> + <property moreinfo="none"> Window > Preferences </property></emphasis> + menu <emphasis> + <property moreinfo="none">Server > Runtime Environments </property></emphasis> + and clicking <emphasis> + <property moreinfo="none">Edit</property></emphasis>. + </para> + </section> + </section> + <section> + <title>Servers</title> + <para>WTP servers are eclipse-representations of a backing server installation. They are used to + start or stop servers, deploy to servers, or debug code that will run on the server. They keep + track of the modules (jars, wars, etc) you deploy to the server and also allow you to undeploy + those modules (see <link linkend="run_on_server_wizard">Deploying with Run On Server + Wizard</link> section). </para> + <para>Servers can be started or stopped with different <link linkend="com_line_arg">command-line + arguments</link>. They are often backed by a runtime object representing that server's + location.</para> + + <section> + <title>Creating a New Server</title> + + <para>There are many ways to get to the new server wizard. One way is to use the old standard <emphasis> + <property moreinfo="none">File > New > Other... </property> + </emphasis> and then <emphasis> + <property moreinfo="none">Server</property> + </emphasis>. This should show the wizard like below.</para> + <figure float="0"> + <title>Adding a JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>A server object is that keeps track of things like command line arguments when starting + or stopping, and runtimes keep track of the location of the installation. Thus, each server + instance must be backed by an appropriate runtime. </para> + + <para> <emphasis><property moreinfo="none"> New server wizard </property></emphasis> allows to name the server appropriately in the <emphasis><property moreinfo="none">Server name field </property></emphasis>or you can use a generated default name.If it's nessecary to restore the default name,after you defined yours, click the Reset default button(<inlinemediaobject> <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4d.png"></imagedata> + </imageobject></inlinemediaobject>). + From the list of already declared runtimes in the combo box below the view it's + possible to select which runtime you want your server to be backed by. If there is no + runtime that matches your needs just press the <emphasis> + <property moreinfo="none">Add...</property> + </emphasis> link nearby to bring up the wizard for creating a new runtime (see the <link linkend="add_runtime_figure">Installing a New Runtime section</link>). To configure the already installed + runtimes you should go to server preferences that you can easily do by pressing the <emphasis> + <property moreinfo="none">Configure runtime environments...</property></emphasis> link.</para> + + <para>If the server you want to create doesn't have any installed runtime yet, the combo box + and the links are absent.</para> + + <figure float="0"> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In this case the next page in the wizard which has the same form as in <link linkend="add_runtime_figure">the previous section</link> will ask you to create the + associated runtime.</para> + <para>Either way, after targeting your server to a runtime, the final screen in this wizard is + largely confirmational, giving you a chance to verify that you've selected the + appropriate runtime. </para> + + <figure float="0"> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to complete the process of the server creation.</para> + <para>Now that we've created our runtimes and servers, we can dwell on all services + and tools that JBoss Server Manager provides.</para> + + <para>We hope, this guide helped you to get started with the JBoss Tools server manager. Besides, for additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </section> + </section> + + +</chapter> + + +<chapter id="perspective" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/as/docs/reference/en/modules/perspective.xml" xreflabel="perspective"> + <?dbhtml filename="perspective.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JBoss AS Perspective</title> + + <para>This chapter tells how to manage installed <property moreinfo="none">JBoss Server</property> via + <property moreinfo="none">JBoss AS perspective</property>.</para> + + <para>The <property moreinfo="none">JBoss AS perspective</property> is similar to the <property moreinfo="none">Java + perspective</property>, but it contains a few additional views. Two of the additional + views are standard views, specifically the <property moreinfo="none">Console view</property> and the + <property moreinfo="none">Properties view</property>. The other two views that are added are the + <property moreinfo="none">Project archives view</property> and the <property moreinfo="none">JBoss Server + View</property>.</para> + + <section id="JBossServerView" role="updated"> + <?dbhtml filename="JBossServerView.html"?> + <title>The JBoss Server View</title> + + <para>The <property moreinfo="none">JBoss Server View</property> is built on Common Navigator Framework + allowing extensions and is using label decorators what makes the UI enough compact + without loosing the vital information.</para> + + <para>Let's have a look at the <property moreinfo="none">JBoss Server View</property> and inspect + in detail all parts it consists of. </para> + <figure float="0"> + <title>The JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="jbossserver_view_toolbar"> + <title>JBoss Server View Toolbar</title> + <para>In the right top corner of the <property moreinfo="none">JBoss Server View</property> there is a + special toolbar which provides a quick access to starting a server (in the debug + mode, run mode, or profile mode), restarting a server, stopping a server and a + possibility to publish to a server.</para> + + <figure float="0"> + <title>The JBoss Server View Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In order to debug your applications or EJB's that are deployed to the server, you + must start the server in debug mode. By starting the server in debug mode, eclipse + will allow you to set breakpoints on code in your workspace and step through the + code.</para> + + <para><emphasis> + <property moreinfo="none">Start the server in profiling mode</property> + </emphasis> button allows to enable profiling actions for your application. For more + details on how to start using TPTP profiling with <property moreinfo="none">JBoss Tools</property> + refer to <link linkend="tptp_support">TPTP Support</link> chapter.</para> + + <para><emphasis> + <property moreinfo="none">Publish to the server</property> + </emphasis> button will republish any modules where it has determined the workspace + is out of sync with the server. It will attempt to do an incremental publish if it + turns out that the module in question is capable of doing one.</para> + + </section> + + <section id="jbossserver_view_structure"> + <title>JBoss Server View Structure</title> + <para>The <property moreinfo="none">JBoss Server View</property> displays all declared servers as well + as their current states (that is whether they are started or stopped) and statuses + in the square brackets next to a server name.</para> + + <figure float="0"> + <title>The JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The following table lists possible server statuses.</para> + + <table> + <title>Server Publish Status</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center">Status</entry> + + <entry align="center">Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry align="center"> + <para>Republish</para> + </entry> + + <entry align="center"> + <para>The status which allows you to see if changes are + awaiting</para> + </entry> + </row> + <row> + <entry align="center"> + <para>Publishing...</para> + </entry> + + <entry align="center"> + <para>The status which shows if changes are being updated</para> + </entry> + </row> + <row> + <entry align="center"> + <para>Synchronized</para> + </entry> + + <entry align="center"> + <para>The status which allows you to see if changes are + in-sync</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para>You can control a server behavior as well as adjust some server preferences with + the help of the context menu commands.</para> + + <figure float="0"> + <title>Context Menu Commands</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>All available context menu commands are described in the following table.</para> + <table> + <title>Server Properties through the Context Menu</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>New Server</para> + </entry> + <entry> + <para>The option allows to define a new server</para> + </entry> + </row> + + <row> + <entry> + <para>Open</para> + </entry> + <entry> + <para>The option opens the Server editor</para> + </entry> + </row> + + <row> + <entry> + <para>Show in</para> + </entry> + <entry> + <para>This option gives an easy access to the next views: Console, + Debug view, Server Log or MBean Explorer</para> + </entry> + </row> + + <row> + <entry> + <para>Delete</para> + </entry> + <entry> + <para>Standard option that allows to delete the chosen server</para> + </entry> + </row> + + <row> + <entry> + <para>Start</para> + </entry> + <entry> + <para>The action for stating a server in a run mode</para> + </entry> + </row> + + <row> + <entry> + <para>Debug</para> + </entry> + <entry> + <para>The action for stating a server in a debug mode</para> + </entry> + </row> + + <row> + <entry> + <para>Stop</para> + </entry> + <entry> + <para>The action for stopping a declared server</para> + </entry> + </row> + + <row> + <entry> + <para>Publish</para> + </entry> + <entry> + <para>The action for synchronizing the publish information between + the server and workspace</para> + </entry> + </row> + + <row> + <entry> + <para>Explore</para> + </entry> + <entry> + <para>This action uses the native OS file explorer to browse the + deploy destination. Note: The option is also available for + deployed resources/projects (see the figure below).</para> + </entry> + </row> + + <row> + <entry> + <para>Add and Remove Projects</para> + </entry> + <entry> + <para>The option allows to publish a new project to the server (if + its type is supported)</para> + </entry> + </row> + + <row> + <entry> + <para>Monitoring</para> + </entry> + <entry> + <para>Possibility to add ports to be monitored on the current + server</para> + </entry> + </row> + + <row> + <entry> + <para>Properties</para> + </entry> + <entry> + <para>Opens the window to adjust the current server + preferences</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>Under the server element in the <property moreinfo="none">JBoss Server View</property>, you can + see currently deployed to the server modules and some server extensions which + provide the additional information on the server.</para> + + <para>The context menu for any module allows you to remove it from the server, force a + full or incremental republish upon it.</para> + + <figure float="0"> + <title>Modules Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="filesets"> + <title>Filesets</title> + + <para>The <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category in the <property moreinfo="none">JBoss Server View</property> is intended + for files filtering.</para> + + <para>To add a new file filter, right-click the <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category and select <emphasis> + <property moreinfo="none">Create File Filter</property>.</emphasis></para> + <para id="filefilterWiz">The <property moreinfo="none">New File + Filter wizard</property> should appear.</para> + + <figure float="0"> + <title>Creating a New File Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The wizard asks you to enter the filter name and add includes and excludes + patterns. The preview box underneath gives a list of files matched to the + defined patterns (see the figures bellow).</para> + <para>In order to set up a default fileset relative to the concrete configuration of the server runtime, use the following variable: + <literal moreinfo="none">${jboss_config}</literal>, i. e. you should type in the <emphasis> + <property moreinfo="none">Root Directory</property></emphasis> something like <literal moreinfo="none">server/${jboss_config}/</literal>. + This is implemented in order you can modify the runtime's configuration and not have to manually update paths.</para> + <figure float="0"> + <title>New File Filter Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets2_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Notice, that the <emphasis> + <property moreinfo="none">Browse</property></emphasis> button still returns an absolute path:</para> + + <figure float="0"> + <title>New File Filter Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After the filter is created, you can observe it by expanding the <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category in the <property moreinfo="none">JBoss Server View</property>.</para> + + <para>It's possible now to edit files directly from the <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category. Double clicking on a file from <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> opens up the editor automatically or you can use the <emphasis> + <property moreinfo="none">Edit File</property> + </emphasis> context menu command.</para> + + <figure float="0"> + <title>Direct Editing from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To delete a file filter (or just a file) from the <emphasis> + <property moreinfo="none">Filesets</property>,</emphasis> right-click a file filter (or the + unnecessary file) and select the <emphasis> + <property moreinfo="none">Delete File Filter</property> + </emphasis> + <emphasis>(<property moreinfo="none">Delete File</property>)</emphasis> command.</para> + + <figure float="0"> + <title>Deleting the File from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>If you want to set filesets for some server types, you should open + <emphasis><property moreinfo="none">Window>Preferences</property></emphasis> + and then select <emphasis><property moreinfo="none">Server > Default Filesets</property></emphasis> + from the categories available on the left.</para> + + <figure float="0"> + <title>Deleting the File from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this preference page you can add a fileset + to any server type or to all servers at once.To do this you should select the server type in the combo box and click <emphasis><property moreinfo="none">Add fileset...</property></emphasis> button. + In the opened <property moreinfo="none">New File + Filter wizard</property> follow the steps described <link linkend="filefilterWiz">before</link> and finally click <emphasis><property moreinfo="none">Apply</property></emphasis> button on the preference page.</para> + <para>The defined file filter will be automatically added to new servers during creation.</para> + + + </section> + + <section id="xml_configuration"> + <title>XML Configuration</title> + <para>The <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> category allows you to quickly browse to descriptor files in your + server's deploy directory and check or change the values. Basically, <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> includes XML XPaths where an xpath is a path used to access some + specific part of an xml document. </para> + + <note> + <title>Note:</title> + <para>You are assumed to be familiar with XPath. If not, we highly suggested + that you look through an appropriate manual or tutorial on the topic.</para> + </note> + + <para>The <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> category itself contains only a list of categories. <emphasis> + <property moreinfo="none">Ports</property> + </emphasis> are provided by default and is filled with many of the most commonly + used ports in the <property moreinfo="none">JBoss Server</property>.</para> + + <figure float="0"> + <title>XML Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + +  + + <para>By right-clicking on <emphasis> + <property moreinfo="none">XML Configuration</property>, </emphasis> you can create a new + category. Besides, context menu for <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> category makes possible to disable it. You can disable any category + in the bottom part of the <emphasis> + <property moreinfo="none">JBoss Server View</property>.</emphasis> Look for them in the <emphasis> + <property moreinfo="none">Inactive Categories</property> + </emphasis> afterwards to re-enable.</para> + + <figure float="0"> + <title>Adding New Category</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>By right-clicking on <emphasis> + <property moreinfo="none">Ports</property> + </emphasis> or any other category in <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis>, you can create a new xpath.</para> + + <figure float="0"> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After that, the dialog shown below will appear.</para> + + <figure float="0"> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The goal here is to get an end result where the XPath matches up with a + necessary property. With that in mind, let's look how it works. If the + property you want to reach is the value of the <emphasis>name</emphasis> + attribute in the element <code><mbean></code>, then your <emphasis> + <property moreinfo="none">XPath Patten</property> + </emphasis>should end with <emphasis>mbean</emphasis> and your <emphasis> + <property moreinfo="none">Attribute Name</property> + </emphasis> should be <emphasis>name</emphasis> like on the next figure.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[... +<server> +... + <mbean code="org.jboss.ejb.EJBDeployer" + name="jboss.ejb:service=EJBDeployer" xmbean-dd=""> + +  + <xmbean> + <description> + The EJBDeployer responsible for ejb jar deployment</description> + ... + </xmbean> + </mbean> +</server> +]]></programlisting> + + <figure float="0"> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Notice, when you type the fields autocomplete to help you locate exactly + what xpath you're looking for.</para> + </tip> + + <para>Then, on the other hand, if your desired field is the text of an element + <code><description></code>, your <emphasis> + <property moreinfo="none">XPath Patten</property> + </emphasis> should end with <emphasis>description</emphasis> and <emphasis> + <property moreinfo="none">Attribute Name</property> + </emphasis> field should be left blank. When finished, click <emphasis> + <property moreinfo="none">Preview</property> + </emphasis> to see how many matches you have for that particular XPath.</para> + + <figure float="0"> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + <section id="dragndrop_to_jboss_server_view"> + <title>Drag-n-Drop to JBoss Server View</title> + + <para>Starting from 2.0.0.CR2 version of <property moreinfo="none">JBoss AS Tools</property> the + <property moreinfo="none">JBoss Server View</property> supports drag-n-drop of deployable and + runnable projects/resources.</para> + + <figure float="0"> + <title>Dragging to the JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/dnd_toJBossServerView.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>With drag-n-drop the following actions can be performed:</para> + + <itemizedlist> + <listitem> + <para>dragging a project to a server will deploy it to the server and run it by + showing the main page in a browser</para> + </listitem> + + <listitem> + <para>dragging an <emphasis> + <property moreinfo="none">.xhtml</property> + </emphasis> file from <emphasis> + <property moreinfo="none">WebContent</property> + </emphasis> will do the same and show the corresponding page in a + browser</para> + </listitem> + + <listitem> + <para>dragging a deployable resource (i.e. a datasource (<emphasis> + <property moreinfo="none">-ds.xml</property> + </emphasis>) file that has been made deployable) will simply deploy that + resource directly to the server</para> + </listitem> + </itemizedlist> + + <para>In short, the feature does the same thing as if you used the <emphasis> + <property moreinfo="none">Run On Server</property> + </emphasis> option or <emphasis> + <property moreinfo="none">Add and Remove Projects</property> + </emphasis> option in the context menu of the server.</para> + </section> + + <section id="server_log"> + <title>Server Log View</title> + + <para>You can monitor the current server behavior with the help of the <property moreinfo="none">Server + Log</property>. To open a server in the <property moreinfo="none">Server Log view</property> you + should right-click on the server and follow to <emphasis> + <property moreinfo="none">Open in > Server Log</property>.</emphasis></para> + + <para>The <emphasis> + <property moreinfo="none">Server Log</property> + </emphasis> shows relevant information to your server's startup, shutdown, + and publish processes. This allows you to keep an eye on what's going on + (such as automatic incremental deployment if you have it enabled).</para> + + <figure float="0"> + <title>Event Log Actions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">Server Log</property> toolbar contains several icons that perform + the following actions:</para> + + <table> + <title>Server Log Toolbar Icons</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Export Log</para> + </entry> + <entry> + <para>Possibility to export the log into a text file</para> + </entry> + </row> + + <row> + <entry> + <para>Clear Log Viewer</para> + </entry> + <entry> + <para>The option clears the current server log</para> + </entry> + </row> + + <row> + <entry> + <para>Delete Log</para> + </entry> + <entry> + <para>Click to delete the server log</para> + </entry> + </row> + + <row> + <entry> + <para>Open Log</para> + </entry> + <entry> + <para>Click to open the server log text file</para> + </entry> + </row> + + <row> + <entry> + <para>Restore Log</para> + </entry> + <entry> + <para>Click to restore the server log</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + </section> + + <section id="server_editor"> + <title>Server Editor</title> + <para>By double-clicking on any server, an editor window will appear allowing you to + edit parts of that server.</para> + + <figure float="0"> + <title>Preferences Page for the Chosen Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>On the figure you can see that a username/password is available in the UI when + configuring the server. If you get a SecurityException when trying to launch the + server, it is most likely because your server is protected and hence you need to + fill the username/password fields with appropriate values.</para> + </tip> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Under the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Publishing</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> section it' possible to disable/inable the automatic publishing of the changes in the workspace.</diffmk:wrapper></para> + + <para>It should be pointed out that our server adapter by default tries to automatically + detect the ports it needs for integrating with a <property moreinfo="none">JBoss Server</property>. + Sometimes it can though be relevant to override this automatic detection if you are + using some custom configuration. For this purposes the <emphasis> + <property moreinfo="none">Server Ports</property> + </emphasis> section in the <property moreinfo="none">Server editor</property> is provided where the + port settings are configurable. Click the <emphasis> + <property moreinfo="none">Configure...</property> + </emphasis> link to bring up the wizard for adjusting the settings for the + ports.</para> + + <figure float="0"> + <title>Server Ports Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Press <emphasis> + <property moreinfo="none">Edit XPath</property> + </emphasis> button for the chosen port to configure its XPath's values.</para> + + <figure float="0"> + <title>XPath Pattern for a Server Port</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property moreinfo="none">Server editor</property> you are able to edit the timeouts and the server pollers to use.</para> + + <note> + <title>Note:</title> + <para>By default, the Startup poller is set to JMX Poller (see the <emphasis> + <property moreinfo="none">Server Polling</property></emphasis> section). If you change the Startup poller + to Timeout Poller (it may need in case, for example, you're using the minimal configuration for your server), this will do no polling at all and will only set the server + state to <emphasis> + <property moreinfo="none">"Started"</property></emphasis> after your startup timeout is reached.</para> + </note> + + <para id="com_line_arg"><property moreinfo="none">Server editor</property> makes it also possible to + modify the server's launch configuration. It's just after clicking <emphasis> + <property moreinfo="none">Open launch configuration</property> + </emphasis> link. In the open window there are the tabs for setting command line + arguments, classpaths and other things that are relevant to launching the + server.</para> + + <figure float="0"> + <title>Launch Configuration Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Look up <ulink url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/start-stop.html">AS Installation Guide </ulink> to find parameters which can be specified for <property moreinfo="none">JBoss + Server</property>.</para> + + <note> + <title>Note:</title> + <para>Please note, that the Launch Configurations for JBoss Servers are enough + strict in enforcing the configured values in the server in order to avoid + inconsistencies between server's and their configured runtime.</para> + + <para>For example, if you change the launch configuration program arguments to + <emphasis>"-c myConfig"</emphasis> but do not change the + targeted runtime configuration, then your program arguments will be ignored. The + server runtime "wins" so to speak. This ensures consistency + and if you change the location of the runtime, your launch configurations will + automatically pick that up.</para> + + <para>Values are not controlled by the server and its runtime setup will be passed + on unaltered.</para> + </note> + + <para>Until 3.0.0.GA release of <property moreinfo="none">JBoss Tools</property>, the servers classpath + was readonly, but that caused problems for users wanting to add their own jars in + the startup classpath. That is relevant if you need to patch the server, add a + custom charset or other tweaks that require early access to the classpath.</para> + + <para>Now all servers have a custom 'server runtime classpath + container', which is there by default and point to the default jars in + JBoss. You can now adjust the classpath. Then just make sure this container is there + if you want the classpath to be picked up.</para> + + <figure float="0"> + <title>Server Classpaths</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/server_classpaths.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If for some reason you have a launch configuration without this container, <emphasis> + <property moreinfo="none">Restore Default Entries</property> + </emphasis> should add it properly. Also, <emphasis> + <property moreinfo="none">Restore Default Entries</property> + </emphasis> will also remove any extra entries you added yourself.</para> + </section> + + <section> + <title>Relevant Resources Links</title> + <para>Find more about XPath in the <ulink url="http://www.w3.org/TR/xpath20/">XPath + Documentation</ulink>.</para> + </section> + </section> + + <section id="Project_archivesView" role="updated"> + <title>Project Archives View</title> + <para>Every application, whether Plain Old Java, J2EE, or some other language altogether, + needs to be packaged in some way. In Java-related projects, many people use ANT. </para> + <note> + <title>Note:</title> + <para>Those who use ANT will appreciate how the Project Archives Ant task is now + improved: it supports variables and gives more informative error/logging messages + when something goes wrong.</para> + </note> + + <para>But <property moreinfo="none">JBoss Tools</property> come with our own Archives tool with a bit easier + and less-verbose XML and a handy user interface. The Project Archives plugin consists + primarily of a view, that is <property moreinfo="none">Project Archives view</property>, to set up each + packaging configuration.</para> + <para>So far, let's look through all functionality that the <property moreinfo="none">Project + Archives view</property> provides.</para> + + <section id="archives_overview"> + <title>Overview</title> + + <para>The packaging configuration for each project is stored in the project's root + folder, and is in a file named <emphasis> + <property moreinfo="none">.packages</property> + </emphasis>, which has a fairly simple XML structure. Modifying the file by hand is + neither required nor recommended, and using the UI is the official way of modifying + your packaging structure.</para> + + <figure float="0"> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>A project's configuration contains archives. As you can see on the image + above a project can contain more than one archive. Internal archives and filesets + can be directly inside of an archive, or in some sub-folder of that archive.</para> + + <para>In the upper right corner of the view you can see an icon which, when clicked, + will build the selected top-level archive. Additionally, you can select <emphasis> + <property moreinfo="none">Project > Build Packages</property> + </emphasis> when a project is selected in the <property moreinfo="none">Packages View</property> to + build all declared packages in that project's <emphasis> + <property moreinfo="none">.packages</property> + </emphasis> file. This will execute a full build on all declared archives.</para> + </section> + + <section id="Creating_Archive"> + <title>Creating an Archive</title> + + <para>When you open the <property moreinfo="none">Project archives view</property> for the first time, + it asks you to select the project for what you want to create an archive.</para> + + <figure float="0"> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When creating a new archive for selected project, you have some different options + at your disposal. You need right-click inside the view and select <emphasis> + <property moreinfo="none">New Archive</property> + </emphasis> to see your archive type options.</para> + + <figure float="0"> + <title>Create an Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If you see only JAR from the list of available archive types, you should + verify whether AS Tools plugins/features are in place. EAR, EJB JAR and WAR + options are contributed by the AS Tools independently from webtools and the + virtual project model. Thus, without them only JAR will show up.</para> + </note> + + <para><property moreinfo="none">JAR</property> is the standard archive type, and does very little + configuration, leaving most of the work up to you. You can customize the name, add + folders, filesets, and inner jars to it.</para> + + <para>The other types, for the most part, simply start off with a default setting, + usually the jar with some specific children based on an expected structure of the + project. For example, if the project is a Dynamic Web Project, and you create a + <property moreinfo="none">WAR</property> archive, the archive will be created with a few + filesets relevant to the known structure of the project.</para> + + <para>Here is the first page of all New archive wizards. It is the same for any archive + type and the only page in the <property moreinfo="none">New Jar wizard</property>.</para> + <figure float="0"> + <title>New WAR Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The page is pretty simple. First it asks to set the name of your new archive and a + destination.</para> + + <para>The destination of an archive can be anywhere on the file system, anywhere in the + workspace, inside some other archive, or inside a folder declared inside an archive. + Select the necessary checkbox (either <emphasis> + <property moreinfo="none">workspace</property> + </emphasis> or <emphasis> + <property moreinfo="none"> file system</property> + </emphasis>) for marking the destination as related to either workspace or file + system. You can browse to workspace or filesystem destinations by clicking on their + respective buttons. To select a destination inside some other archive, you'll need + to press the <emphasis> + <property moreinfo="none">Workspace</property> + </emphasis> button. At the bottom of the list, you'll see archives that + have been declared in the workspace.</para> + + <figure float="0"> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Also in the wizard for creating a new archive you can choose whether an archive to + be compressed or exploded into a folder (without compression). You need just select + proper chechbox in the <emphasis> + <property moreinfo="none">Archive type</property> + </emphasis> section.</para> + <para>If a build or incremental update fails Project Archives will show an error + dialog:</para> + <figure float="0"> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/projectarchives_error.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click in <emphasis> + <property moreinfo="none">Details</property> + </emphasis> to see detailed information about what caused the error.</para> + + <para>In the <property moreinfo="none">Package Explorer</property> you can observe the created + archive.</para> + <figure float="0"> + <title>The Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you use the exploded type of archiving, instead of a single file archive the + result put into a folder is displayed in the <property moreinfo="none">Package + Explorer</property>.</para> + <figure float="0"> + <title>The Exploded Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="CreatingaFolder"> + <title>Creating a Folder</title> + <para>Creating a folder is much easier. You simply right-click on an archive or + folder you want your new folder to be a child under. The only piece of required + information is naming the file.</para> + </section> + <section id="CreatingaFileSet"> + <title>Creating a FileSet</title> + <para>To create a new fileset, you click on an available target location such as an + archive, a nested archive, or a folder within an archive, and select <emphasis> + <property moreinfo="none">New Fileset</property>. </emphasis></para> + <para>The <property moreinfo="none">New Fileset wizard</property> requires a destination (where the + files will go), and a root directory (or where the files are coming from). The + source can be anywhere in the workspace or from the filesystem at large.</para> + + <figure float="0"> + <title>Adding a New FileSet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Below that, the fileset requires only an includes pattern and an excludes + pattern. As you type in either of these fields, the preview viewer should update + itself with which files are matched.</para> + + <para>You can create a Fileset with flattening or without it. Look at the difference + on the figure below.</para> + + <figure float="0"> + <title>The FileSet with flattening and without it</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section diffmk:change="added" id="CreatingaUserLibrariesFileSet"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating User Library FileSet</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you use user libraries in your projects you can also refer to these from project archives and have all the .jar/.zip files they refer included into the archive.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To add a new user libraries file set, call the right-click menu on the necessary archive and choose " New User Libraries FileSet" item</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding New User Library Fileset</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/perspective/userlibraryfileset1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can edit the existing user libraries as well using "User Libraries Fileset Wizard". Call the right-click menu on the library fileset and choose "Edit Fileset " item</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Editing User Library Fileset</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/perspective/userlibraryfileset2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + </section> + + <section id="View_Actions"> + <title>Archive Actions</title> + <figure float="0"> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_25.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The context menu on the items in the view is extendable, but there are several + that come standard.</para> + + <table> + <title>Context Menu on the Item</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Build Archive (Full)</para> + </entry> + + <entry> + <para>The action enabled only on top-level archives, which initiates + a full build on that archive</para> + </entry> + </row> + + <row> + <entry> + <para>Edit Archive</para> + </entry> + + <entry> + <para>Standard action that brings up the wizard associated with that + particular node type and allows the details to be changed</para> + </entry> + </row> + + <row> + <entry> + <para>Delete Archive</para> + </entry> + + <entry> + <para>Deleting node is standard action with deletion not needing an + explanation</para> + </entry> + </row> + + <row> + <entry> + <para>Publish To Server</para> + </entry> + + <entry> + <para>The action means the ability to publish to a declared + server</para> + </entry> + </row> + + <row> + <entry> + <para>Edit publish settings</para> + </entry> + + <entry> + <para>Gives possibility to edit an archive publish settings</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section id="PublishToServer"> + <title>Publishing to Server</title> + <para>Finally, you'll need to publish your application to a server. Here, we + show you how to do it with the help of <emphasis> + <property moreinfo="none">Archives View</property>. </emphasis></para> + + <figure float="0"> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_26.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The dialog above appears after selecting <emphasis> + <property moreinfo="none">Publish To Server</property>. </emphasis> To simply publish once, you + just select the server(s) that you want, and finish. If you want the <emphasis> + <property moreinfo="none">Publish to Server</property> + </emphasis> action on that particular Archive to publish always to that set of + servers, then check the appropriate checkbox. And finally, to enable automatic + publishing upon build events, check the last checkbox.</para> + <para>The automatic publishing feature is nice if, for example, your package's + destination (where it is built) is a temporary folder and you want the archive + published to several servers. If you only really want your archive published to one + server, it might be easier to have the archive's destination folder be the deploy + folder of the server.</para> + </section> + <section id="rel_res_links_archiving"> + <title>Relevant Resources Links</title> + <para>Refer to <ulink url="http://ant.apache.org/manual/index.html">Ant manual</ulink> + to find more on how to build your applications with help of Ant.</para> + + <para>We also recommend you to watch the <ulink url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.htm">movie</ulink> which demonstrates a powerful archiving functionality in + <property moreinfo="none">JBoss Tools</property>.</para> + + <para>At this point, you are guessed to be familiar with <property moreinfo="none">JBoss AS + perspective</property> and your next step now is to explore how to work with + different kinds of projects.</para> + </section> + + </section> + + +</chapter> + + +<chapter id="webtools" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/as/docs/reference/en/modules/webtools.xml"> + <title>Projects</title> + <para>The most popular of the projects we deal with are the J2EE ones, such as Dynamic Web + Project, EJB Project, or EAR project. Web projects of <property moreinfo="none">JBoss Tools</property> are + Struts, JSF and Seam projects. All of them are called faceted projects. Thus, in this + chapter we are going to tell you about facets the main benefit of which to provide proper + structuring and packaging for any type of project.</para> + + <section> + <title>Faceted Projects Overview</title> + <para>The idea behind faceted projects is that each project can accept units of + functionality, or facets, which can be added or removed by the user. Most often, these + facets either add to the project's classpath, enable a builder, or watch the project in + some other fashion. Generally, every project concerned has at least one facet when + it's created. As an example, a Web project has a WebDoclet facet, or an EJB + Project has an EJB Module facet as prerequisites.</para> + + <para> WTP projects have undergone some criticism as being + <emphasis>over-engineered</emphasis> or too restrictive in their design. WTP projects + are set up in a tree-relationship to each other, where one project can be a child of + another. For example, an EAR project may have a Web Project child, an EJB project child, + or other types.</para> + + <para> However, the benefit of this is that the structure of your projects is then known, + and packaging it up *should* be trivial. Apparently, if your project is non-standard, or + you feel too confined by such rigid structural requirements, you can still choose to + package your project using the <link linkend="Project_archivesView">Archives + plugin</link>.</para> + </section> + + + <section> + <title>Adding Facets to a Project</title> + + <para>In this section we're going to consider the facets added by <property moreinfo="none">JBoss + Tools</property> and show how you can configure them in a project: add new ones or + modify already existing configuration of the facets.</para> + + <para>One way to configure the facets is doing it while organizing a new project. To + demonstrate this let's create a new <property moreinfo="none">Dynamic Web Project</property> by + selecting <emphasis> + <property moreinfo="none">File > New > Other...</property> + </emphasis> and then <emphasis> + <property moreinfo="none">Web > Dynamic Web Project</property>. </emphasis></para> + <figure float="0"> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> and you will see Dynamic Web Project page like on the figure below.</para> + + <para> The first page of most WTP projects allows you to target a specific runtime, + representing a server's library location. It will also provide you the ability to add + this project to an EAR project, and select a preselected default set of facets, called + a configuration, rather than manually select each facet you might want.</para> + <para> Selecting the runtime, again, allows the project to install the proper classpaths to + the project so it knows what code to compile against.</para> + + <figure float="0" id="dyn_web_project"> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <emphasis> + <property moreinfo="none">Modify</property> + </emphasis> button next to <property moreinfo="none">Configuration</property> section in order to open + the wizard which allows you to modify a chosen configuration. The wizard looks as + follows.</para> + + <figure float="0" id="project_facets"> + <title>Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here part of the listed facets are those which are provided by WTP. Some of them are + added by <property moreinfo="none">JBoss Tools</property>. They are:</para> + <itemizedlist> + <listitem> + <para>BIRT Charting Runtime Component</para> + </listitem> + <listitem> + <para>BIRT Reporting Runtime Component</para> + </listitem> + <listitem> + <para>JBoss ESB</para> + </listitem> + <listitem> + <para>JBoss Portlets</para> + </listitem> + <listitem> + <para>JBoss Web Services</para> + </listitem> + <listitem> + <para>Seam</para> + </listitem> + </itemizedlist> + + <para>On this wizard page you can enable or disable any facet as well as change it version. + What you should note here is that some facets or facets versions may conflict with each + other. In case of incompatibility you'll be prompted about this in the combo + box underneath.</para> + <figure float="0"> + <title>Facet Constraints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When switching on the <emphasis> + <property moreinfo="none">Runtimes</property> + </emphasis> tab on the right you'll see the current server Runtime.</para> + <figure float="0"> + <title>Runtimes on the Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this tab you can also create a new Server Runtime and make it primary by pressing <emphasis> + <property moreinfo="none">Make Primary</property> + </emphasis> button after enabling it.</para> + + <para>Clicking on <emphasis> + <property moreinfo="none">OK</property> + </emphasis> will save the chosen configuration of the facets and return you to the <link linkend="dyn_web_project">Dynamic Web Project wizard</link>. Further pages in the + wizard are specific to either the project type or the facets selected.</para> + + + <para>If you need to configure the facets for the existing project, you should bring up the + context menu for selected project and click <emphasis> + <property moreinfo="none">Properties</property> + </emphasis> and then <emphasis> + <property moreinfo="none">Project Facets</property>. </emphasis> This will bring up the familiar + <link linkend="project_facets">Project Facets wizard</link>, where you can create + your own custom facets configuration.</para> + + <para></para> + + </section> + <section id="rel_resources_links"> + <title>Relevant Resources Links</title> + + <para>More on the WTP facets you can read in the <ulink url="http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.jst.j2ee.do...">eclipse help</ulink>.</para> + </section> +</chapter> + + +<chapter id="modules" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/as/docs/reference/en/modules/modules.xml"> + <title>Deploying Modules</title> + + <para>In this chapter it will be described how to deploy modules onto the server.</para> + <para> First of all it is necessary to say that deploying to a server is mostly painless. There + are several ways to do it provided by WTP, and some additional methods provided by JBoss + Tools. These methods are described further in this chapter.</para> + + <section> + <title>Deploying on the Package Explorer</title> + + <para>On the package explorer it is possible to publish either a project to a server or just + a single file. Let's look at how to do this.</para> + <section id="run_on_server_wizard"> + <title>Deploying with Run On Server Wizard</title> + <para> The first WTP method is to right-click on a project, such as a Dynamic Web + project, EJB project, or EAR project and then select <emphasis> + <property moreinfo="none">Run As > Run on Server</property> + </emphasis>. The resulting dialog allows you to select which supporting server the + project can be published to.</para> + <figure float="0"> + <title>Define a New Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button to see add or remove projects page where you can choose projects + to configure them on server.</para> + <figure float="0" id="add_rem_proj"> + <title>Add or Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>This page of the wizard also allows to undeploy modules from the server. For that + choose proper module(s) from the right and click <emphasis> + <property moreinfo="none"> < Remove</property> + </emphasis>. The modules will be completely undeployed after restarting your server + or republishing.</para> + <para>Generally, for the JBoss AS Server Adapters, publishing using this method will + force a default, best-guess, packaging configuration for your project. This + best-guess does not publish incrementally, but instead repackages your entire + project into a <emphasis> + <property moreinfo="none">.war</property> + </emphasis>, <emphasis> + <property moreinfo="none">.jar</property> + </emphasis>, or <emphasis> + <property moreinfo="none">.ear</property> + </emphasis> as appropriate, and then copies that file into the proper deploy + directory. For quicker smarter deployment, you will need to create archives using + the <link linkend="Project_archivesView">Project Archives view</link> and customize + packaging yourself.</para> + + + + </section> + + <section id="single_file_deployment"> + <?dbhtml filename="DeployToServer.html"?> + <title>Deploying single files</title> + + <para>Sometimes it becomes necessary to deploy one or more files to a server. For + that in order not to do a full republish in the context menu of files a <emphasis><property moreinfo="none">Deploy To Server</property></emphasis> + option is provided that allows a single file deployment. To deploy these non-WTP files/projects + right click on the file (<emphasis> + <property moreinfo="none">-ds.xml</property></emphasis>, <emphasis> + <property moreinfo="none">.ear</property></emphasis>, <emphasis> + <property moreinfo="none">.jar</property></emphasis> etc.) and select <emphasis> + <property moreinfo="none">Deploy To Server</property> + </emphasis> and it will be automatically deployed.</para> + <figure float="0"> + <title>Deploy to Sever</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The deployed files are listed side-by-side with other modules that are deployed to + the server.</para> + + <figure float="0"> + <title>Deployed files on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + </section> + <section> + <title>Deploying with JBoss Server View</title> + <para>As it has been already mentioned <property moreinfo="none">JBoss Server View</property> contains two + parts: the top part that displays all defined servers and the bottom part which provides + categories with additional information. Thus, in this section we suggest two more ways + to deploy resources onto the server.</para> + <section> + <title>Top part of JBoss Server View</title> + <para>In the top part of the <property moreinfo="none">JBoss Servers View</property> like in the Servers + View you should right click on a server and select the <emphasis> + <property moreinfo="none">Add and Remove Projects</property> + </emphasis> menu item.</para> + <figure float="0"> + <title>Add and Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>This will bring up a <link linkend="add_rem_proj">familiar dialog</link> allowing + you to either publish projects or modules to a server, or remove them from the + server. If the selected module is a project like a Dynamic Web project, EJB project, + or EAR project, it will be published as through <emphasis> + <property moreinfo="none">Run on Server</property> + </emphasis> wizard, with a best-guess full package. If, however, the selected + element is an archive from the <link linkend="Project_archivesView">Project Archives + view</link>, it will be published according to the rules of that module + type.</para> + </section> + + <section> + <title>Bottom part of JBoss Server View</title> + <para>In the bottom part of <emphasis> + <property moreinfo="none">JBoss Server View</property> + </emphasis> there is a category called <emphasis> + <property moreinfo="none">Modules</property> + </emphasis> which should display all currently-published modules on the server. + Right-clicking on the desired module and selecting <emphasis> + <property moreinfo="none">Full Publish</property> + </emphasis> will force a full rebuild of the entire module.</para> + <figure float="0"> + <title>Full Publish</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here, <emphasis> + <property moreinfo="none">Incremental Publish</property> + </emphasis> is meant to enable publishing of only those parts where changes have + been made.</para> + </section> + </section> + <section> + <title>Deploying with Project Archives View</title> + <para>In the <property moreinfo="none">Project Archives View</property> you can right-click on any declared + archive and select the <emphasis> + <property moreinfo="none">Publish To Server</property> + </emphasis> element. For more on this subject, see <link linkend="PublishToServer">Publishing to Server</link> in the Project Archives View section.</para> + <figure float="0"> + <title>Publish to Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> The only way to ensure an <emphasis> + <property moreinfo="none">Incremental Build</property> + </emphasis>, such as changes to one <emphasis> + <property moreinfo="none">.jsp</property>, </emphasis> + <emphasis> + <property moreinfo="none">.html</property>, </emphasis> or <emphasis> + <property moreinfo="none">.class</property> + </emphasis> file, is to enable the builder for that project. This is done by either + changing the global preferences for the <property moreinfo="none">Archives View</property>, or by + enabling project-specific preferences and ensuring the builder is on.</para> + + <para>You can also use the "Finger touch" button for a quick restart of the project without restarting the server:</para> + <figure float="0"> + <title>Finger Touch button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_8_finger_touch.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR, jboss-esb.xml in ESB projects).</para> + + + <para>The last chapter covers a variety of methods on how you can deploy needed modules onto a + server.</para> + </section> +</chapter> + + +<chapter id="tptp_support" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/as/docs/reference/en/modules/tptp_support.xml"> + <title>TPTP Support</title> + <para>This chapter provides an overview on how to enable TPTP Profiling for <property moreinfo="none">JBoss + AS</property> adapters in <property moreinfo="none">JBoss Tools</property>.</para> + + <section> + <title>TPTP Profiling</title> + + <para>To get TPTP profiling work on <property moreinfo="none">JBoss Application Server</property> you should + first download <ulink url="http://www.eclipse.org/downloads/download.php?file=/tptp/4.5.0/TPTP-4.5.0...">TPTP 4.5.0 Runtime</ulink> and install it, i. e. just add the content of <emphasis> + <property moreinfo="none">plugins/features</property> + </emphasis> folders from downloaded directory to the same folders in your eclipse + installation directory.</para> + + <para>And now all profile actions should work for you. To start <property moreinfo="none">JBoss + AS</property> in profiling mode use <emphasis> + <property moreinfo="none">Start the server in profiling mode</property> + </emphasis> button or <emphasis> + <property moreinfo="none">Profile As > Profile on Server</property> + </emphasis> option in the context menu of the project.</para> + + <figure float="0"> + <title>Start the Server in Profiling mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/tptp_support/tptp_support_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To enable TPTP features in your workbench use <property moreinfo="none">Profiling and Logging + Perspective</property> that you can find in the list of proposed perspectives: <emphasis> + <property moreinfo="none">Window > Open Perspective > Other…</property> + </emphasis> + </para> + + <figure float="0"> + <title>Profiling and Logging Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/tptp_support/tptp_support_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Relevant Resources Links</title> + <para>All additional information on TPTP(Test and Performance Tools Platform) you can find + in <ulink url="http://www.eclipse.org/tptp/home/downloads/4.5.0/documents/quicktour/quic...">eclipse documentation</ulink>.</para> + <para>In summary, this reference should help you to start with <ulink url="http://www.jboss.org/jbossas">JBoss AS</ulink> and get to know with functionality + for work with it.</para> + </section> +</chapter> + + +</book>

15 years

1
0
0 / 0

JBoss Tools SVN: r19302 - branches/jbosstools-3.1.0.RC1/as/docs/reference/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-16 09:46:22 -0500 (Wed, 16 Dec 2009) New Revision: 19302 Modified: branches/jbosstools-3.1.0.RC1/as/docs/reference/en/master.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating the plugin version; Modified: branches/jbosstools-3.1.0.RC1/as/docs/reference/en/master.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/as/docs/reference/en/master.xml 2009-12-16 14:24:53 UTC (rev 19301) +++ branches/jbosstools-3.1.0.RC1/as/docs/reference/en/master.xml 2009-12-16 14:46:22 UTC (rev 19302) @@ -51,7 +51,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 2.1.0.M2 + Version: 2.1.0.CR1 </releaseinfo> <abstract> <title/>

15 years

1
0
0 / 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits December 2009