June 2010 - jbosstools-commits - Jboss List Archives

JBoss Tools SVN: r22655 - in tags/jbosstools-3.1.1.GA/jbpm/docs: reference and 8 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:04:29 -0400 (Tue, 08 Jun 2010) New Revision: 22655 Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Author_Group.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Book_Info.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Feedback.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Introduction.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Preface.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Quick_Howto_Guide.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Revision_History.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_1.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_2.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_3.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_4.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_5.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_6.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_7.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_8.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_9.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_1.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_2.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_3.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_4.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_5.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_6.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_7.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_8.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/favicon.ico tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_1.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_2.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_4.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_5.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_9.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/jbosstools_logo.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/runtime_installation/ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/runtime_installation/runtime_installation_1.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/jbpm_1.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/jbpm_2.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/jbpm_3.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_0.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_1.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_10.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_2.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_3.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_4.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_5.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_6.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_6a.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_7.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_8.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_9.png tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/tasks.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/the_views.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/pom.xml tags/jbosstools-3.1.1.GA/jbpm/docs/reference/publican.cfg Log: uploading restructured version Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Author_Group.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Author_Group.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Author_Group.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,26 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author> + <firstname>Anatoly</firstname> + <surname>Fedosik</surname> + </author> + <author> + <firstname>Koen</firstname> + <surname>Aers</surname> + <email>koen.aers(a)jboss.com</email> + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email>smukhina(a)exadel.com</email> + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email>tom.baeyens(a)jboss.com</email> + </author></authorgroup> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Book_Info.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Book_Info.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Book_Info.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>jBPM Tools Reference Guide</title><subtitle>Provides information relating to the jBPM Tools set.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The jBPM Tools Reference Guide explains how to use the jBPM Tools to create process definitions and workflow processes.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Feedback.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Feedback.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Feedback.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,20 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US"> + <title>We Need Feedback!</title> + <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + </indexterm> + <para> + If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink> + </para> + <para> + When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component. + </para> + <para> + If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. + </para> +</section> + + Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Introduction.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Introduction.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Introduction.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,154 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="Introduction" xreflabel="Introduction"> + <?dbhtml filename="TargetAudience.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>Target</keyword> + <keyword>developers</keyword> + <keyword>Audience</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para>All developers and process analysts who are beginning to use JBoss jBPM should read this + Getting Started guide. It will give them a jumpstart showing how to create a process definition.</para> + <section id="Preface"> + <?dbhtml filename="Preface.html"?> + <title>Preface</title> + <para>This document introduces the use of the JBoss jBPM Graphical Process Designer (GPD) to + create workflow processes. It will help first time users with the following tasks :</para> + <itemizedlist> + <listitem> + <para>Install the JBoss jBPM GPD Eclipse plugin available from the JBoss jBPM download + area</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Using the creation wizard to create an empty process definition</para> + </listitem> + <listitem> + <para>Use the designer palette to draw the first processdefinition</para> + </listitem> + <listitem> + <para>Show how the xml processdefinition can be inspected as an xml file</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Write an example process test case</para> + </listitem> + </itemizedlist> + <para>If you have any questions, please feel free to contact <ulink url="mailto:koen.aers@jboss.com" + >Koen Aers</ulink> or <ulink url="mailto:tom.baeyens@jboss.com">Tom Baeyens</ulink> for more + information.</para> + </section> + + <section id="feature_list"> + + <title>Feature list</title> + + <para> JBoss jBPM is a workflow that enables creating and automatization business processes. Look + at the list of features below to understand its main functionality.</para> + <table> + <title>Key Functionality for JBoss jBPM</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + </row> + </thead> + <tbody> + + <row> + <entry> + <link linkend="minimal_process_definition">jPDL support</link> + </entry> + <entry>Enables managing workflow processes as well as human tasks and interactions between + them. jPDL combines the best techniques both in Java and in declarative process.</entry> + </row> + + <row> + <entry> + <link linkend="GuidedTourJBossjBPMGPD">Support of Graphical Process Designer (GPD)</link> + </entry> + <entry>Is used for simplifying declarative process development and visualizations of all + actions.</entry> + </row> + + <row> + <entry> + <link linkend="CreatingjBPMProject">Project Creation wizard</link> + </entry> + <entry>Allows to create a new jBPM template project that already includes all advanced + artifacts and core jBPM libraries.</entry> + </row> + + <row> + <entry> + <link linkend="minimal_process_definition">Rich palette of pre-build process nodes</link> + </entry> + <entry>Provides process-building functionality and gives opportunity even non-programmers to + develop processes.</entry> + </row> + + <row> + <entry> + <link linkend="the_views">A large range of special views, including:</link> + </entry> + <entry></entry> + </row> + + <row> + <entry> + <link linkend="source_mode">Support of XML code view</link> + </entry> + <entry>Shows the corresponding XML that's generated automatically in the Source view + of the process definition editor when developing the process.</entry> + </row> + + <row> + <entry> + <link linkend="the_properties_view">Properties view</link> + </entry> + <entry>Facilitates configuring and editing of all nodes properties.</entry> + </row> + + <row> + <entry> + <link linkend="jbpm_gpd_editor">The jBPM Graphical Process Designer editor</link> + </entry> + <entry>The plugin is used for designing the workflow.</entry> + </row> + + + <row> + <entry>Interaction with all of the J2EE based integration technologies including Web Services, + Java Messaging, J2EE Connectors, JBDC, EJBs.</entry> + <entry>Enables implementation, provides better functionality and flexibility.</entry> + </row> + + <row> + <entry>Integration with jBoss Seam</entry> + <entry>Allows to write applications with complex workflows and provides easier interactions + between them.</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>There is some extra information on <ulink url="http://www.jboss.org/community/wiki/JBPMWiki">JBoss Wiki. </ulink></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> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Preface.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Preface.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Preface.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></xi:fallback></xi:include></preface> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Quick_Howto_Guide.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Quick_Howto_Guide.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Quick_Howto_Guide.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,175 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="Quick_Howto_Guide" xreflabel="Quick_Howto_Guide"> + <?dbhtml filename="Quick_Howto_Guide.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword/> + <keyword/> + <keyword/> + <keyword/> + </keywordset> + </chapterinfo> + <title>Quick Howto Guide</title> + + <para>This chapter contains additional information related to the <property>JBoss + jBPM</property>.</para> + + <section id="change_core_jbpm_inst"> + <title>Change the Default Core jBPM Installation</title> + + <para> You can change the default <property>jBPM</property> installation by means of the + Eclipse preference mechanism. Open the Preferences dialog by selecting <emphasis> + <property>Window > Preferences</property> + </emphasis> and select the <emphasis> + <property>JBoss jBPM > Runtime Location</property> + </emphasis> category. Using this page you can add multiple <property>jBPM</property> + installation locations and change the default one. The default installation is used for + the classpath settings when creating a new Process Project. Changing the preferences has + no influence on already created projects. Getting rid of a <property>jBPM</property> + installation that's being referenced by a project however will cause the + classpath to contain errors. </para> + + + <figure> + <title>The jBPM Preferences Page</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Configuring Task Nodes</title> + + <para>Here, we'll examine how you can configure the Task nodes in jBPM jPDL GPD.</para> + + <para> You can add Tasks to Task nodes and then configure them in a similar manner as the + Action configuration mechanism. Let's consider the process definition similar + to the previous one that contains three nodes: Start state, Task node and End state. The + <property>Properties view</property> for selected Task node includes several tabs. </para> + + <figure> + <title>The Properties View of the selected Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>We should choose the Task tab and then bring up the context menu or click the button + in the top right corner of the view to add a Task to our Task node.</para> + + <figure> + <title>Adding a Task to the Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Every added Task has its own configuration possibilities. You can access them through + the <property>Properties view</property> as well.</para> + + <figure> + <title>The Task properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>General page</property> is a place where you can specify the name of a + Task and its description. For instance, let it be <emphasis> + <property>approve oder</property> + </emphasis> with appropriate description that you can see in the figure below.</para> + + <figure> + <title>The Task General Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now, look at <property>Details page</property>. First, you should specify the due date + that is a mandatory property for the Task. The due date is the date on which the task + should be accomplished. Here you can also set a Task priority as well as signalling, + notifying or blocking. The <emphasis> + <property>Blocking</property> + </emphasis> attribute indicates that the process will not be able to continue if this + task is still unaccomplished. The <emphasis> + <property>Generate Form...</property> + </emphasis> button is for creating a simple task form that can be rendered by the jBPM + console.</para> + + <figure> + <title>The Task Details Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>For our example, we specify the due date as 2 business days, choose the high priority + and also check the <emphasis> + <property>Signalling</property> + </emphasis> and <emphasis> + <property>Notify</property> + </emphasis> attributes. It means that the Task should be accomplished in 2 business days + and the assignee will be notified by email when the task is assigned. To specify how the + Task should be assigned switch on to the <property>Assignment page</property>.</para> + + <figure> + <title>The Task Assignment Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the <property>Reminder page</property> you can specify whether the assignee will be reminded of the task + that awaits him.</para> + + <figure> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>In our case, the assignee will be reminded by email after two business hours and + continue to get reminding every business hour after that.</para> + <para>In the next figure you can see our configuring generated into XML.</para> + <figure> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + <para>We hope, our guide will help you to get started with the jPDL process language and jBPM + workflow on the whole. 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> +</chapter> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Revision_History.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Revision_History.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/Revision_History.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_3.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_4.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_5.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_6.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_7.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_8.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_9.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_3.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_4.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_5.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_6.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_7.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_8.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_4.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_5.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_9.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/runtime_installation/runtime_installation_1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/runtime_installation/runtime_installation_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/jbpm_1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/jbpm_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/jbpm_2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/jbpm_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/jbpm_3.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/jbpm_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_0.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_10.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_3.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_4.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_5.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_6.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_6a.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_6a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_7.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_8.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_9.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/images/the_views/the_views_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "jBPM_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,17 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + +<xi:include href="tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="the_views.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/master.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/master.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + + +[<!ENTITY introduction SYSTEM "Introduction.xml"> +<!ENTITY the_views SYSTEM "the_views.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + ]> +<book> + <bookinfo> + <title>jBPM Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <author> + <firstname>Anatoly</firstname> + <surname>Fedosik</surname> + </author> + <author> + <firstname>Koen</firstname> + <surname>Aers</surname> + <email>koen.aers(a)jboss.com</email> + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email>smukhina(a)exadel.com</email> + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email>tom.baeyens(a)jboss.com</email> + </author> + + <copyright> + <year>2007</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> Version: 4.3.0.trunk</releaseinfo> + +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jbpm/pdf/JBPM_Refere...">PDF version</ulink> + </para> +</abstract> +</bookinfo> + <toc/> + + &introduction; + &tasks; + &the_views; + + +  +</book> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/master_output.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/master_output.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,1284 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + + +[<!ENTITY introduction SYSTEM "Introduction.xml"> +<!ENTITY jboss_jbpm_runtime_installation SYSTEM "jboss_jbpm_runtime_installation.xml"> +<!ENTITY guided_tour_jboss_jbpmgpd SYSTEM "guided_tour_jboss_jbpmgpd.xml"> +<!ENTITY the_views SYSTEM "the_views.xml"> +<!ENTITY Test_Drive_Proc SYSTEM "Test_Drive_Proc.xml"> +<!ENTITY The_JBoss_jBPM_Int_Mech SYSTEM "The_JBoss_jBPM_Int_Mech.xml"> +<!ENTITY Quick_Howto_Guide SYSTEM "Quick_Howto_Guide.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + ]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>jBPM Tools 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>Koen</firstname> + <surname>Aers</surname> + <email>koen.aers(a)jboss.com</email> + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email>smukhina(a)exadel.com</email> + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email>tom.baeyens(a)jboss.com</email> + </author> + + <copyright> + <year>2007</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> Version: 4.3.0.trunk</releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jbpm/pdf/JBPM_Refere...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + <toc></toc> + +<chapter id="Introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en-US/Introduction.xml" xreflabel="Introduction"> + <?dbhtml filename="TargetAudience.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>Target</keyword> + <keyword>developers</keyword> + <keyword>Audience</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para>All developers and process analysts who are beginning to use JBoss jBPM should read this + Getting Started guide. It will give them a jumpstart showing how to create a process definition.</para> + <section id="Preface"> + <?dbhtml filename="Preface.html"?> + <title>Preface</title> + <para>This document introduces the use of the JBoss jBPM Graphical Process Designer (GPD) to + create workflow processes. It will help first time users with the following tasks :</para> + <itemizedlist> + <listitem> + <para>Install the JBoss jBPM GPD Eclipse plugin available from the JBoss jBPM download + area</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Using the creation wizard to create an empty process definition</para> + </listitem> + <listitem> + <para>Use the designer palette to draw the first processdefinition</para> + </listitem> + <listitem> + <para>Show how the xml processdefinition can be inspected as an xml file</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Write an example process test case</para> + </listitem> + </itemizedlist> + <para>If you have questions, please feel free to contact <ulink url="mailto:koen.aers@jboss.com">Koen Aers</ulink> or <ulink url="mailto:tom.baeyens@jboss.com">Tom Baeyens</ulink> for more + information.</para> + </section> + + <section id="feature_list"> + + <title>Feature list</title> + + <para> JBoss jBPM is a workflow that enables creating and automatization business processes. Look + at the list of features below to understand its main functionality.</para> + <table> + <title>Key Functionality for JBoss jBPM</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + </row> + </thead> + <tbody> + + <row> + <entry> + <link linkend="minimal_process_definition"><diffmk:wrapper diffmk:change="changed">jPDL support</diffmk:wrapper></link> + </entry> + <entry><diffmk:wrapper diffmk:change="changed">Enables managing workflow processes as well as human tasks and interactions between + them. jPDL combines the best both Java and declarative process techniques.</diffmk:wrapper></entry> + </row> + + <row> + <entry> + <link linkend="GuidedTourJBossjBPMGPD">Support of Graphical Process Designer (GPD)</link> + </entry> + <entry>Is used for simplifying declarative process development and visualizations of all + actions.</entry> + </row> + + <row> + <entry> + <link linkend="CreatingjBPMProject">Project Creation wizard</link> + </entry> + <entry>Allows to create a new jBPM template project that already includes all advanced + artifacts and core jBPM libraries.</entry> + </row> + + <row> + <entry> + <link linkend="minimal_process_definition">Rich palette of pre-build process nodes</link> + </entry> + <entry>Provides process-building functionality and gives opportunity even non-programmers to + develop processes.</entry> + </row> + + <row> + <entry> + <link linkend="the_views">A large range of special views, including:</link> + </entry> + <entry></entry> + </row> + + <row> + <entry> + <link linkend="source_mode">Support of XML code view</link> + </entry> + <entry>Shows the corresponding XML that's generated automatically in the Source view + of the process definition editor when developing the process.</entry> + </row> + + <row> + <entry> + <link linkend="the_properties_view">Properties view</link> + </entry> + <entry>Facilitates configuring and editing of all nodes properties.</entry> + </row> + + <row> + <entry> + <link linkend="jbpm_gpd_editor">The jBPM Graphical Process Designer editor</link> + </entry> + <entry>The plugin is used for designing the workflow.</entry> + </row> + + + <row> + <entry>Interaction with all of the J2EE based integration technologies including Web Services, + Java Messaging, J2EE Connectors, JBDC, EJBs.</entry> + <entry>Enables implementation, provides better functionality and flexibility.</entry> + </row> + + <row> + <entry>Integration with jBoss Seam</entry> + <entry>Allows to write applications with complex workflows and provides easier interactions + between them.</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>There is some extra information on <ulink url="http://www.jboss.org/community/wiki/JBPMWiki">JBoss Wiki. </ulink></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 diffmk:change="added" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en-US/tasks.xml"> + <?dbhtml filename="jboss_jbpm_runtime_installation.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>designer</keyword> + <keyword>process</keyword> + <keyword>JBoss Developer Studio</keyword> + <keyword>jBPM runtime</keyword> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss</diffmk:wrapper></keyword> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Process</diffmk:wrapper></keyword> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Definition</diffmk:wrapper></keyword> + </keywordset> + + </chapterinfo> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tasks</diffmk:wrapper></title> +<section diffmk:change="added" id="jboss_jbpm_runtime_installation" xreflabel="jboss_jbpm_runtime_installation"> + + <title>JBoss jBPM Runtime Installation</title> + <para>The main purpose of this chapter is to let you know how to launch the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss + jBPM</diffmk:wrapper></property> (business process management).</para> + <para>The jBPM plugin (jBPM Designer) is already included in the <property>JBoss Tools</property>. + To make it work, you should only download the jBPM runtime (<ulink + url="http://sourceforge.net/project/showfiles.php?group_id=70542&package_i..." + >jbpm-jpdl-3.2.3</ulink> currently) and specify the directory where you extracted the runtime + either when you create a jBPM project or by using the jBPM preference pages.</para> <note> + <title>Note:</title> + <para><diffmk:wrapper diffmk:change="changed">Try to avoid using spaces in the names of installation folders. It can provoke problems in + some situations with Sun-based VMs.</diffmk:wrapper></para> + </note> + + <para>Navigate to <emphasis> + <property moreinfo="none">Window > Preferences > JBoss jBPM > Runtime Locations</property><diffmk:wrapper diffmk:change="changed">. + </diffmk:wrapper></emphasis> Here you can add, edit and remove JBoss jBPM installation locations. Click <emphasis> + <property moreinfo="none">Add</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> button. In the dialog that appeared enter a name for a newly added jBPM runtime and + point to the correct location of this package on your harddrive. Click </diffmk:wrapper><emphasis> + <property moreinfo="none">OK</property> + </emphasis> then click <emphasis> + <property moreinfo="none">OK</property> + </emphasis> again.</para> + + <figure float="0"> + <title>Adding jBPM Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtime_installation/runtime_installation_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="changed">Now, when you have a runtime installed, we are going to demonstrate some powerful features of + the jBPM.</diffmk:wrapper></para> +</section> + <section diffmk:change="added" id="GuidedTourJBossjBPMGPD" xreflabel="GuidedTourJBossjBPMGPD"> + <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?> + + <title>A Guided Tour of JBoss jBPM GPD</title> + <para><diffmk:wrapper diffmk:change="changed">In this chapter we suggest a step-by-step walk-through of creating and configuring your + own simple process. Let's try to organize a new jBPM project.</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="changed">A wizard for creating a jBPM project is included in the GPD plugin. We have opted to + create a project based on a template already containing a number of advanced artifacts that + we will ignore for this section. In the future we will elaborate this wizard and offer the + possibility to create an empty jBPM project as well as projects based on templates taken + from the jBPM tutorial.</diffmk:wrapper></para> + <section id="CreatingjBPMProject"> + + <title>Creating a jBPM Project</title> + <para><diffmk:wrapper diffmk:change="changed">This section will show you how to use the Creation wizard for creating a new jBPM + project with already included source folders.</diffmk:wrapper></para> + <para>At first you should select <emphasis> + <property moreinfo="none">File >New Project...</property> + </emphasis> and then <emphasis> + <property moreinfo="none">JBoss jBPM > Process Project</property> + </emphasis> in the New Project dialog:</para> + <figure float="0"> + <title>New Project Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> brings us to the wizard page where it's necessary to specify the + name and location for the project. We choose, for example, </diffmk:wrapper><emphasis> + <property moreinfo="none">HellojBPM</property> + </emphasis> as the name and accept the default location. </para> + <figure float="0"> + <title>Process Name and Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="changed">Thus, our project will be created in the workspace root directory by default. If you + want to change the directory for your future project, deselect </diffmk:wrapper><emphasis> + <property moreinfo="none">Use default location</property> + </emphasis> and click <emphasis> + <property moreinfo="none">Browse...</property> + </emphasis> button to set needed location or simply type it.</para> + <para><diffmk:wrapper diffmk:change="changed">On the next screen you'll be prompted to select the core jBPM location that + we have defined in the previous chapter.</diffmk:wrapper></para> + <figure float="0"> + <title>Core jBPM Location Specifying</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on <emphasis> + <property moreinfo="none">Finish</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> results in the project being generated. The wizard creates four source + folders: one for the processes (</diffmk:wrapper><emphasis> + <property moreinfo="none">src/main/jpdl</property> + </emphasis>), one for the java sources (<emphasis> + <property moreinfo="none">src/main/java</property> + </emphasis>), one for the unit tests (<emphasis> + <property moreinfo="none">src/test/java</property> + </emphasis><diffmk:wrapper diffmk:change="changed">) and one for the resources such as the jbpm.properties and the + hibernate.properties files (</diffmk:wrapper><emphasis> + <property moreinfo="none">src/main/config</property> + </emphasis><diffmk:wrapper diffmk:change="changed">). In addition a classpath container with all the core jBPM libraries is + added to the project</diffmk:wrapper></para> + <figure float="0"> + <title>Layout of the Process Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="changed">Looking inside the different source folders will reveal a number of other artifacts + that were generated, but we will leave these untouched for the moment. Instead, we will + look at another wizard that enables us to create an empty process definition.</diffmk:wrapper></para> + </section> + <section id="creating_an_empty_process_definition"> + + <title>Creating an Empty Process Definition</title> + <para><diffmk:wrapper diffmk:change="changed">Now when the project is set up, we can use a Creation wizard to create an empty + process definition. Bring up the </diffmk:wrapper><emphasis> + <property moreinfo="none">New</property> + </emphasis> wizard by clicking the <emphasis> + <property moreinfo="none">File > New > Other...</property> + </emphasis> menu item. The wizard opens on the <emphasis> + <property moreinfo="none">Select Wizard</property> + </emphasis> page.</para> + <figure float="0"> + <title>The Select Wizard Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Selecting the <emphasis> + <property moreinfo="none">JBoss jBPM</property> + </emphasis> category, then the <emphasis> + <property moreinfo="none">Process Definition</property> + </emphasis> item and clicking on the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button brings us to the <emphasis> + <property moreinfo="none">Create Process Definition</property> + </emphasis> page.</para> + <figure float="0"> + <title>The Create New Process Defining Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>We choose <emphasis> + <property moreinfo="none">hello</property> + </emphasis> as the name of the process archive file. Click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to end the wizard and open the process definition editor.</para> + <figure float="0"> + <title>The Process Definition Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_6.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para><diffmk:wrapper diffmk:change="changed">You can see in the Package Explorer that creating a process definition involves + creating a folder with the name of the process definition and populating this folder + with two .xml files : </diffmk:wrapper><emphasis> + <property moreinfo="none">gpd.xml</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> , </diffmk:wrapper><emphasis> + <property moreinfo="none">processdefinition.xml</property> </emphasis><diffmk:wrapper diffmk:change="added"> and a .jpg file:</diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">processimage.jpg</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <para>The <emphasis> + <property moreinfo="none">gpd.xml</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> contains the graphical information used by the process definition editor. + The </diffmk:wrapper><emphasis> + <property moreinfo="none">processdefinition.xml</property> + </emphasis><diffmk:wrapper diffmk:change="added"> file contains the actual process definition info. + The graphical view of the process is automatically saved in </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">processimage.jpg</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed">file. + At present, the GPD assumes that these three files are siblings. More + sophisticated configuration will be supported later.</diffmk:wrapper></para> + + <section id="minimal_process_definition"> + + <title>A Minimal Process Definition</title> + <para><diffmk:wrapper diffmk:change="changed">Now we are ready to create a very simple process definition consisting of a begin + state, an intermediate state and an end state.</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="added">To make the configuration of actions much easier it's better to use the + </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">></diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">"jBPM jPDL 3"</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> perspective. It provides the tabbed Properties Editor which allows to configure + all the relevant properties of the current selected item. </diffmk:wrapper></para> + + <section id="adding_the_nodes"> + + <title>Adding the Nodes</title> + <para>At first select respectively <emphasis> + <property moreinfo="none">Start</property>, </emphasis> + <emphasis> + <property moreinfo="none">State</property> + </emphasis> and <emphasis> + <property moreinfo="none">End</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> on the tools palette and click on the canvas to add these nodes to + the process definition. The result should look similar to this:</diffmk:wrapper></para> + <figure float="0"> + <title>A Simple Process With Three Nodes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_7.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="adding_transitions"> + + <title>Adding Transitions</title> + <para>Then, we will connect the nodes with transitions. To do that select the <emphasis> + <property moreinfo="none">Transition</property> + </emphasis> tool in the tools palette and click on the <emphasis> + <property moreinfo="none">Start</property> + </emphasis> node, then move to the <emphasis> + <property moreinfo="none">State</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> node and click again to see the transition being drawn. Perform the + same steps to create a transition from the </diffmk:wrapper><emphasis> + <property moreinfo="none">State</property> + </emphasis> node to the <emphasis> + <property moreinfo="none">End</property> + </emphasis> node. The result will look like:</para> + <figure float="0"> + <title>A Simple Process With Transitions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_8.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="changed">Now, when you've got background knowledge of simple project creation, + let's move to more advanced tools.</diffmk:wrapper></para> + </section> + </section> + </section> + </section> + <section diffmk:change="added" id="The_JBoss_jBPM_Int_Mech" xreflabel="The_JBoss_jBPM_Int_Mech"> + <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?> + + <title><diffmk:wrapper diffmk:change="changed">Actions : The JBoss jBPM Integration Mechanism</diffmk:wrapper></title> + + <para><diffmk:wrapper diffmk:change="changed"> In this chapter we will show how to do software integration with </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss + jBPM</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. The standard mechanism to implement this is to wrap the functionality you + want to integrate in a class that implements the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ActionHandler</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> interface. In order to demonstrate it let's specify Hello World action for our + process.</diffmk:wrapper></para> + + <section diffmk:change="added"> + <title><diffmk:wrapper diffmk:change="changed">Creating a Hello World Action</diffmk:wrapper></title> + + <para><diffmk:wrapper diffmk:change="added">Each Hello World process should integrate one or more Hello World actions, so this is + what we will be doing. We can integrate custom code at different points in the process + definition. To do this we have to specify an action handler, represented by an + implementation of the </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">ActionHandler</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> interface, and attach this piece of code to a particular event. These events + are amongst others, going over a transition, leaving or entering nodes, after and before + signalling. </diffmk:wrapper></para> + + <para><diffmk:wrapper diffmk:change="changed"> To make things a little bit more concrete, let's create a new class called </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="added">HelloActionHandler</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. + </diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> For that firstly we'll create a new package </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">com.jbay.action</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> in the </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">src/java/main</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> folder of our project. Then, we should call New Class Creation wizard as + usual by right-clicking and navigating </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New > Class</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. + </diffmk:wrapper></emphasis> </para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Creating HelloActionHendler Class</diffmk:wrapper></title> + + <mediaobject> + <imageobject> + <imagedata diffmk:change="added" fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="changed">Notice that two first gaps have been filled automatically. Here, instead of </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Package</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> option </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Enclose type</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> option can be selected where a type in which to enclose a new class should + be specified.</diffmk:wrapper></para> + + <para><diffmk:wrapper diffmk:change="changed">In our case, we leave everything as it is, just type </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">HelloActionHandler</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> as a name of new class and add </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">org.jbpm.graph.ActionHendler</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> interface as it's shown in the picture above.</diffmk:wrapper></para> + + <para><diffmk:wrapper diffmk:change="added">Thus, our </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">HelloActionHandler</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> implements the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ActionHandler</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> interface including the </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">execute</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> method as shown in the next figure. Here, we add a variable named </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">greeting</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> to the collection of process variables and put a message in it : + </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">"Hello from ActionHandler"</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">A Simple Hello Action</diffmk:wrapper></title> + + <mediaobject> + <imageobject> + <imagedata diffmk:change="added" fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">Now, as we have </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">HelloActionHandler</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> class defined, let's explore how we can handle it.</diffmk:wrapper></para> + </section> + + <section diffmk:change="added"> + <title><diffmk:wrapper diffmk:change="changed">Integrating the Hello World Action</diffmk:wrapper></title> + + <para><diffmk:wrapper diffmk:change="added">The main purpose of this chapter is to provide you with the steps associating our + Hello World action with a particular event and test the correctness of our actions as + well.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> As good Testcity citizens we will first create a Unit Test that proves the behaviour + we want to achieve by adding the </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">ActionHandler</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> to the process. So we implement another test.</diffmk:wrapper></para> + + <para><diffmk:wrapper diffmk:change="added">At first, let's return to the + code we already saw </diffmk:wrapper><link diffmk:change="added" linkend="hello_test"><diffmk:wrapper diffmk:change="added">in the previous chapter</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> and add new test method </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">testActionHendler</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> to it. </diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Create the Hello Action Test</diffmk:wrapper></title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">We assert + that no variable called </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">greeting</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> exist. Then we give the process a signal to move it to the auction state. We + want to associate the execution of the action with the event of going over the + transition from the start state to the auction state. So after the signal, the process + should be in the auction state as in the previous scenario. But moreover, the </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">greeting</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> variable should exist and contain the string </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">"Hello from + ActionHandler"</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added">. That's what we assert in the last lines of the test + method.</diffmk:wrapper></para> + + + + <para><diffmk:wrapper diffmk:change="changed"> Running the tests now results in a failure. The point is that we did not associate + the action with any particular event in the process definition, so the process variable + did not get set. </diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Test Results Before Integration</diffmk:wrapper></title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added"> Let's do something about it and add an action to the first transition of our + sample process. To do this you can use the Actions tab in the Properties Editor that is + under the graphical canvas. Bring up the popup menu of the action element container and + chose New Action as it's shown on the figure below. The other way to add an action + to the transition is simply to use the dropdown menu that is available under the action + icon in the right upper corner of the Properties View.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title><diffmk:wrapper diffmk:change="changed">Adding an Action to a Transition</diffmk:wrapper></title> + + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">After adding the action a tabbed view with three pages will appear.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Configuration Dialog for an Action</diffmk:wrapper></title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">The first of these three pages allows you to give the Action a name. The last page + contains some advanced attributes such as whether the Action is asynchronous. The + Details page is the most important. It allows to choose and configure the actual action + handler implementation. </diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Details page of an Action Configuration Dialog</diffmk:wrapper></title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para><diffmk:wrapper diffmk:change="changed">Clicking on the </diffmk:wrapper><emphasis> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Search...</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> button brings us to a Choose Class dialog.</diffmk:wrapper></para> + + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Choose Action Handler Dialog</diffmk:wrapper></title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para><diffmk:wrapper diffmk:change="added"> We choose our previously created 'HelloActionHandler' class and + push the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">OK</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> button. After the selection of the action handler for + the action, we can run the test and observe it gives us a green light.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Test Results</diffmk:wrapper></title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">There we are. The above objective has been achieved.</diffmk:wrapper></para> + </section> + + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Integration Points</diffmk:wrapper></title> + + <para><diffmk:wrapper diffmk:change="added"> The different integration points in a process definition are thoroughly documented in + the </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.com/jbpm/v3/userguide/"><diffmk:wrapper diffmk:change="added">JBoss jBPM User Guide</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. Instance nodes can contain many action + elements. Each of these will appear in the Action element list of the Actions tab. But + each Action also has a properties view of itself. You can navigate to this view by + selecting the added Action in the outline view. </diffmk:wrapper></para> + + </section> + </section> + <section diffmk:change="added" id="Quick_Howto_Guide" xreflabel="Quick_Howto_Guide"> + <?dbhtml filename="Quick_Howto_Guide.html"?> + + <title><diffmk:wrapper diffmk:change="changed">Quick Howto Guide</diffmk:wrapper></title> + + <para><diffmk:wrapper diffmk:change="changed">This chapter contains additional information related to the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss + jBPM</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">.</diffmk:wrapper></para> + + <section diffmk:change="added" id="change_core_jbpm_inst"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Change the Default Core jBPM Installation</diffmk:wrapper></title> + + <para><diffmk:wrapper diffmk:change="added"> You can change the default </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">jBPM</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> installation by means of the + Eclipse preference mechanism. Open the Preferences dialog by selecting </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Preferences</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> and select the </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss jBPM > Runtime Location</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> category. Using this page you can add multiple </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">jBPM</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + installation locations and change the default one. The default installation is used for + the classpath settings when creating a new Process Project. Changing the preferences has + no influence on already created projects. Getting rid of a </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">jBPM</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + installation that's being referenced by a project however will cause the + classpath to contain errors. </diffmk:wrapper></para> + + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The jBPM Preferences Page</diffmk:wrapper></title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Configuring Task Nodes</diffmk:wrapper></title> + + <para><diffmk:wrapper diffmk:change="added">Here, we'll examine how you can configure the Task nodes in jBPM jPDL GPD.</diffmk:wrapper></para> + + <para><diffmk:wrapper diffmk:change="added"> You can add Tasks to Task nodes and then configure them in a similar manner as the + Action configuration mechanism. Let's consider the process definition similar + to the previous one that contains three nodes: Start state, Task node and End state. The + </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> for selected Task node includes several tabs. </diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Properties View of the selected Task Node</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">We should choose the Task tab and then bring up the context menu or click the button + in the top right corner of the view to add a Task to our Task node.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Adding a Task to the Task Node</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">Every added Task has its own configuration possibilities. You can access them through + the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> as well.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Task properties</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">General page</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is a place where you can specify the name of a + Task and its description. For instance, let it be </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">approve oder</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> with appropriate description that you can see in the figure below.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Task General Page</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">Now, look at </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Details page</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. First, you should specify the due date + that is a mandatory property for the Task. The due date is the date on which the task + should be accomplished. Here you can also set a Task priority as well as signalling, + notifying or blocking. The </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Blocking</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> attribute indicates that the process will not be able to continue if this + task is still unaccomplished. The </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Generate Form...</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> button is for creating a simple task form that can be rendered by the jBPM + console.</diffmk:wrapper></para> + + + <title><diffmk:wrapper diffmk:change="changed">The Task Details Page</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png" + scale="80"/> + </imageobject> + </mediaobject> + + + <para><diffmk:wrapper diffmk:change="changed">For our example, we specify the due date as 2 business days, choose the high priority + and also check the </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Signalling</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> and </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Notify</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> attributes. It means that the Task should be accomplished in 2 business days + and the assignee will be notified by email when the task is assigned. To specify how the + Task should be assigned switch on to the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Assignment page</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Task Assignment Page</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Reminder page</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you can specify whether the assignee will be reminded of the task + that awaits him.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Task Reminder Page</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata diffmk:change="added" fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In our case, the assignee will be reminded by email after two business hours and + continue to get reminding every business hour after that.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the next figure you can see our configuring generated into XML.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Task Reminder Page</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>We hope, our guide will help you to get started with the jPDL process language and jBPM + workflow on the whole. 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 diffmk:change="added" id="reference" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en-US/the_views.xml" xreflabel="reference"> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + </keywordset> + </chapterinfo> + <title><diffmk:wrapper diffmk:change="changed">Reference</diffmk:wrapper></title> + <section> + <title><diffmk:wrapper diffmk:change="changed">Wizards</diffmk:wrapper></title> + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Process Project Wizard</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="added">This wizard helps to create new jBPM project.It is available with clicking + </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">File->New->Other->jBPM 3 Project</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> in the menu bar.</diffmk:wrapper></para> + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">New Process Project Wizard</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/jbpm_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="added">It consists of several pages:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="added">On the first page you can adjust the name of the project and the directory where it will be created.</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="added">If "</diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="added">Use default</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">" option is checked the output directory will be the workspace, + othervise the user should specify it by himself using </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Browse</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button.</diffmk:wrapper></para> + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">New Process Project Wizard</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/jbpm_1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="added">On the second page you should point the location of your jbpm runtime.</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The last page is only available for unabling/disabling + </diffmk:wrapper><emphasis><diffmk:wrapper diffmk:change="added">Generate simple process definition,action handling and Unit test</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="changed">.</diffmk:wrapper></para></listitem> + </itemizedlist> + + </section> + <section diffmk:change="added"> + <title><diffmk:wrapper diffmk:change="changed">New JBPM Action Wizard</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="added">This wizard is available by clicking + </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">File->New->Other->jBPM 3 Action Handler</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">New JBPM Action Wizard</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/jbpm_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="added">It includes the next options to adjust:</diffmk:wrapper></para> + + <table diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">New JBPM Action Wizard. Options.</diffmk:wrapper></title> + <tgroup cols="3" diffmk:change="added"> + <colspec align="left" colnum="1" colwidth="1*" diffmk:change="added"></colspec> + <colspec colnum="2" colwidth="3*" diffmk:change="added"></colspec> + <colspec align="left" colnum="3" colwidth="1*" diffmk:change="added"></colspec> + + <thead diffmk:change="added"> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Option</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Default</diffmk:wrapper></entry> + </row> + </thead> + <tbody diffmk:change="added"> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Source folder</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">The path to the source folder relative to the selected project</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">The source folder of the project selected in the </diffmk:wrapper><emphasis diffmk:change="added"><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Project</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> field</diffmk:wrapper></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Package</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Enter a package to contain an Action Handler. + Either type a valid package name or click + </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Browse</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> + to select a package via the dialog box.</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added"><blank></diffmk:wrapper></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Enclosing type</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select the enclosing type of your jBPM action using + </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"> + button.</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added"><blank></diffmk:wrapper></entry> + </row> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Modifiers</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select the modifiers that will be added to the generated class.</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Public</diffmk:wrapper></entry> + </row> + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Name</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Type a name for a new Action Handler</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added"><blank></diffmk:wrapper></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Superclass</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Type or click </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"> + to select a superclass for an Action Handler</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">org.jbpm.graph.def.ActionHandler</diffmk:wrapper></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Interface</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Type or click </diffmk:wrapper><emphasis><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> + to select an interface/interfaces for an Action Handler</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">org.jbpm.graph.def.ActionHandler</diffmk:wrapper></entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Which method stubs you would like to create?</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select the stubs that you would like to be created automatically.</diffmk:wrapper></entry> + <entry diffmk:change="added"><itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Constructors from superclass</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="changed">Inherited abstract methods</diffmk:wrapper></para></listitem> + </itemizedlist> + </entry> + </row> + + <row diffmk:change="added"> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Do you want to add comments?</diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Generate comments</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> check box if you want comment mask + to be generated before the class definition. + </diffmk:wrapper></entry> + <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added"><blank></diffmk:wrapper></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + + </section> + + <section diffmk:change="added" id="the_views" xreflabel="the_views"> + <?dbhtml filename="the_views.html"?> + <title><diffmk:wrapper diffmk:change="changed">The views</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="changed">Here, it will be explained how to work with views and editors provided by JBDS.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The views are used for representation and navigation the resources you are working on at + the moment. One of the advantages of all the views is that all modifications made in the + current active file are immediately displayed in them. Let’s get acquainted more closely + with those that the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">jPDL perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> provides. </diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The jPDL Perspective Views and Editors</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata diffmk:change="added" fileref="images/the_views/the_views_0.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">As you can see in the picture above, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">jPDL perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> contains a + complete set of functionality that's necessary for working on the jBPM project.</diffmk:wrapper></para> + + <section diffmk:change="added" id="the_outline_view"> + <?dbhtml filename="the_outline_view.html"?> + <title><diffmk:wrapper diffmk:change="changed">The Outline View</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="changed">To have a way to quickly see an outline of the process use the </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Outline view</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> that is presented as the classical tree. If it is not visible select </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Show view > Outline</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></emphasis></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Overview View</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section diffmk:change="added" id="the_overview"> + <?dbhtml filename="the_outline_view.html"?> + <title><diffmk:wrapper diffmk:change="changed">The Overview</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="added">The main advantage of this view is that it gives visual representation of the whole + current developing process. Besides, the </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Overview</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> comes as a scrollable thumbnail which enables a better navigation of the + process structure if it's too large.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Overview</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section diffmk:change="added" id="the_properties_view"> + <?dbhtml filename="the_properties_view.html"?> + <title><diffmk:wrapper diffmk:change="changed">The Properties View</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="changed"> Here, we dwell on the JBDS </diffmk:wrapper><property moreinfo="none">Properties view</property><diffmk:wrapper diffmk:change="changed">.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Notice if it's not visible you can access it by navigating </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window > Show view > Properties</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></emphasis></para> + <para><diffmk:wrapper diffmk:change="changed">The view shows the relevant properties of the selected item in the tabbed form. Every + item has its own set of properties, which can be directly editable in the Properties + view or by brining up the context menu.</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Properties View of selected Transition</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">For example, on the picture above the Properties view displays all the properties for + a selected transition. Its name has been changed to </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">to_auction</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> We've done it directly in + active General tab of the view. The same way let's change the name for the + second transition to </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">to_end</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></emphasis></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If no one item is selected, the view represents the properties of the whole process + definition. </diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Properties View of Process Definition</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">In this case, it contains six tabs. The first one is the </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">General</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> It allows to specify a process name and add + necessary description. To illustrate let's change the process definition name + to </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">jbay</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">. </diffmk:wrapper></emphasis></para> + </section> + + <section diffmk:change="added" id="jbpm_gpd_editor"> + <?dbhtml filename="direct_editing.html"?> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The jBPM Graphical Process Designer editor.</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">jBPM GPD editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> includes four modes: Diagram, Deployment, + Design and Source, which are available as switchable tabs at the bottom of the editor. + Let's dwell on each of them.</diffmk:wrapper></para> + + <section diffmk:change="added" id="the_diagram_mode"> + <title><diffmk:wrapper diffmk:change="changed">The Diagram mode</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> In this mode we define the process in the form of a diagram by means of tools + provided on the left-hand side of the jBPM GPD. </diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Diagram mode</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject> + <imagedata diffmk:change="added" fileref="images/the_views/the_views_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="changed">Besides, some properties can be directly edited in the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Diagram + mode</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> of the graphical editor. One example of this is the </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">name</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="changed"> property of nodes. You can edit this directly by selecting the node of + which you want to change the name and then click once inside this node. This enables + an editor in the node. We change the name of the node to </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">auction</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">. </diffmk:wrapper></emphasis></para> + </section> + + <section diffmk:change="added" id="source_mode"> + <?dbhtml filename="the_source_view.html"?> + <title><diffmk:wrapper diffmk:change="changed">The Source Mode</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now, that we have defined a simple process definition, we can have a look at the + XML that is being generated under the covers. To see this XML click on the Source + tab of the graphical process designer editor.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Source Mode</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject> + <imagedata diffmk:change="added" fileref="images/the_views/the_views_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Source mode</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> enables to easily manipulate our XML. That is + manually inserting and editing necessary elements or attributes. In addition, here + you can take advantage of content assist.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">A template is added to better render the jBPM task forms in the Visual editor. + Now the jBPM Graphical Process designer can create facelets that are associated with tasks and are rendered in the jBPM console.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">A task form in VPE</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/the_views/the_views_6a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section diffmk:change="added" id="design_mode"> + <?dbhtml filename="the_design_view.html"?> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Design Mode</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">One more way to edit your file is to use </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Design mode</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">. You can + see it in the next picture:</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title><diffmk:wrapper diffmk:change="changed">The Design Mode</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject> + <imagedata diffmk:change="added" fileref="images/the_views/the_views_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">As you can see above, this mode looks like a table in the first column of which + the process structure is performed. Here, you can also insert, remove and edit + elements or attributes, moreover add comments and instructions. Their values can be + directly edited in the second column of the Design mode table.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For instance, let’s add a comment on the second transition. For that, you should + bring up the context menu for it and choose </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Add Before > Comment</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></emphasis></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Adding a Comment</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject> + <imagedata diffmk:change="added" fileref="images/the_views/the_views_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="added">Then, we can put the text </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">This transition leads to the end + state</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> in the right column as its value.</diffmk:wrapper></para> + + <figure float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Comment is added</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/the_views/the_views_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section diffmk:change="added" id="deployment_mode"> + <?dbhtml filename="the_deployment_view.html"?> + <title><diffmk:wrapper diffmk:change="changed">The Deployment Mode</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Finally, to adjust the deployment settings of the project you should switch on to + the tab that opens the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Deployment mode</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. On the picture below + the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Deployment mode</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is performed with default settings. Here, + you can easily modify them or, if the settings won't match your needs, to + reset defaults. </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Deployment Mode</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject> + <imagedata diffmk:change="added" fileref="images/the_views/the_views_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">The button </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Test Connections</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> is necessary to make sure whether all your settings are valid before + deploying the process.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now that we've seen how to work with </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">jPDL + perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, let's pass on to the project testing.</diffmk:wrapper></para> + </section> + </section> +</section> +</chapter> + +  + +  +</book> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/tasks.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/tasks.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/tasks.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,671 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter> + <?dbhtml filename="jboss_jbpm_runtime_installation.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>designer</keyword> + <keyword>process</keyword> + <keyword>JBoss Developer Studio</keyword> + <keyword>jBPM runtime</keyword> + <keyword>JBoss</keyword> + <keyword>Process</keyword> + <keyword>Definition</keyword> + </keywordset> + + </chapterinfo> + <title>Tasks</title> +<section id="jboss_jbpm_runtime_installation" xreflabel="jboss_jbpm_runtime_installation"> + + <title>JBoss jBPM Runtime Installation</title> + <para>The main purpose of this chapter is to let you know how to launch the <property>JBoss + jBPM</property> (business process management).</para> + <para>The jBPM plugin (jBPM Designer) is already included into the <property>JBoss Tools</property>. + To make it work, you should only download the jBPM runtime (<ulink + url="http://sourceforge.net/project/showfiles.php?group_id=70542&package_i..." + >jbpm-jpdl-3.2.3</ulink> currently) and specify the directory where you extracted the runtime + either when you create a jBPM project or by using the jBPM preference pages.</para> + + <note> + <title>Note:</title> + <para>Try to avoid using spaces in the names of installation folders. It can provoke problems in + some situations with Sun-based VMs.</para> + </note> + + <para>Navigate to <emphasis> + <property>Window > Preferences > JBoss jBPM > Runtime Locations</property>. + </emphasis> Here you can add, edit and remove JBoss jBPM installation locations. Click <emphasis> + <property>Add</property> + </emphasis> button. In the dialog that appeared enter a name for a newly added jBPM runtime and + point to the correct location of this package on your harddrive. Click <emphasis> + <property>OK</property> + </emphasis> then click <emphasis> + <property>OK</property> + </emphasis> again.</para> + + <figure> + <title>Adding jBPM Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtime_installation/runtime_installation_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Now, when you have a runtime installed, we are going to demonstrate some powerful features of + the jBPM.</para> +</section> + <section id="GuidedTourJBossjBPMGPD" xreflabel="GuidedTourJBossjBPMGPD"> + <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?> + + <title>A Guided Tour of JBoss jBPM GPD</title> + <para>In this chapter we suggest a step-by-step walk-through of creating and configuring your + own simple process. Let's try to organize a new jBPM project.</para> + <para>A wizard for creating a jBPM project is included in the GPD plugin. We have opted to + create a project based on a template already containing a number of advanced artifacts that + we will ignore for this section. In the future we will elaborate this wizard and offer the + possibility to create an empty jBPM project as well as projects based on templates taken + from the jBPM tutorial.</para> + <section id="CreatingjBPMProject"> + <?dbhtml filename="CreatingjBPMProject.html"?> + <title>Creating a jBPM Project</title> + <para>This section will show you how to use the Creation wizard for creating a new jBPM + project with already included source folders.</para> + <para>At first you should select <emphasis> + <property>File >New Project...</property> + </emphasis> and then <emphasis> + <property>JBoss jBPM > Process Project</property> + </emphasis> in the New Project dialog:</para> + <figure> + <title>New Project Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para> Clicking <emphasis> + <property>Next</property> + </emphasis> brings us to the wizard page where it's necessary to specify the + name and location for the project. We choose, for example, <emphasis> + <property>HellojBPM</property> + </emphasis> as the name and accept the default location. </para> + <figure> + <title>Process Name and Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Thus, our project will be created in the workspace root directory by default. If you + want to change the directory for your future project, deselect <emphasis> + <property>Use default location</property> + </emphasis> and click <emphasis> + <property>Browse...</property> + </emphasis> button to set needed location or simply type it.</para> + <para>On the next screen you'll be prompted to select the core jBPM location that + we have defined in the previous chapter.</para> + <figure> + <title>Core jBPM Location Specifying</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_9.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on <emphasis> + <property>Finish</property> + </emphasis> results in the project being generated. The wizard creates four source + folders: one for the processes (<emphasis> + <property>src/main/jpdl</property> + </emphasis>), one for the java sources (<emphasis> + <property>src/main/java</property> + </emphasis>), one for the unit tests (<emphasis> + <property>src/test/java</property> + </emphasis>) and one for the resources such as the jbpm.properties and the + hibernate.properties files (<emphasis> + <property>src/main/config</property> + </emphasis>). In addition a classpath container with all the core jBPM libraries is + added to the project</para> + <figure> + <title>Layout of the Process Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Looking inside the different source folders will reveal a number of other artifacts + that were generated, but we will leave these untouched for the moment. Instead, we will + look at another wizard that enables us to create an empty process definition.</para> + </section> + <section id="creating_an_empty_process_definition"> + <?dbhtml filename="creating_an_empty_process_definition.html"?> + <title>Creating an Empty Process Definition</title> + <para>Now when the project is set up, we can use a Creation wizard to create an empty + process definition. Bring up the <emphasis> + <property>New</property> + </emphasis> wizard by clicking the <emphasis> + <property>File > New > Other...</property> + </emphasis> menu item. The wizard opens on the <emphasis> + <property>Select Wizard</property> + </emphasis> page.</para> + <figure> + <title>The Select Wizard Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Selecting the <emphasis> + <property>JBoss jBPM</property> + </emphasis> category, then the <emphasis> + <property>Process Definition</property> + </emphasis> item and clicking on the <emphasis> + <property>Next</property> + </emphasis> button brings us to the <emphasis> + <property>Create Process Definition</property> + </emphasis> page.</para> + <figure> + <title>The Create New Process Defining Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_5.png"/> + </imageobject> + </mediaobject> + </figure> + <para>We choose <emphasis> + <property>hello</property> + </emphasis> as the name of the process archive file. Click on the <emphasis> + <property>Finish</property> + </emphasis> button to end the wizard and open the process definition editor.</para> + <figure> + <title>The Process Definition Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_6.png" + scale="60"/> + </imageobject> + </mediaobject> + </figure> + + + <para>You can see in the Package Explorer that creating a process definition involves + creating a folder with the name of the process definition and populating this folder + with two .xml files : <emphasis> + <property>gpd.xml</property> + </emphasis> , <emphasis> + <property>processdefinition.xml</property> </emphasis> and a .jpg file:<emphasis> + <property>processimage.jpg</property></emphasis>.</para> + <para>The <emphasis> + <property>gpd.xml</property> + </emphasis> contains the graphical information used by the process definition editor. + The <emphasis> + <property>processdefinition.xml</property> + </emphasis> file contains the actual process definition info. + The graphical view of the process is automatically saved in <emphasis> + <property>processimage.jpg</property> + </emphasis>file. + At present, the GPD assumes that these three files are siblings. More + sophisticated configuration will be supported later.</para> + + <section id="minimal_process_definition"> + <?dbhtml filename="minimal_process_definition.html"?> + <title>A Minimal Process Definition</title> + <para>Now we are ready to create a very simple process definition consisting of a begin + state, an intermediate state and an end state.</para> + <para>To make the configuration of actions much easier it's better to use the + <emphasis>><property>"jBPM jPDL 3"</property></emphasis> perspective. It provides the tabbed Properties Editor which allows to configure + all the relevant properties of the current selected item. </para> + + <section id="adding_the_nodes"> + <?dbhtml filename="adding_the_nodes.html"?> + <title>Adding the Nodes</title> + <para>At first select respectively <emphasis> + <property>Start</property>, </emphasis> + <emphasis> + <property>State</property> + </emphasis> and <emphasis> + <property>End</property> + </emphasis> on the tools palette and click on the canvas to add these nodes to + the process definition. The result should look similar to this:</para> + <figure> + <title>A Simple Process With Three Nodes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_7.png" + scale="60"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="adding_transitions"> + <?dbhtml filename="adding_transitions.html"?> + <title>Adding Transitions</title> + <para>Then, we will connect the nodes with transitions. To do that select the <emphasis> + <property>Transition</property> + </emphasis> tool in the tools palette and click on the <emphasis> + <property>Start</property> + </emphasis> node, then move to the <emphasis> + <property>State</property> + </emphasis> node and click again to see the transition being drawn. Perform the + same steps to create a transition from the <emphasis> + <property>State</property> + </emphasis> node to the <emphasis> + <property>End</property> + </emphasis> node. The result will look like:</para> + <figure> + <title>A Simple Process With Transitions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_8.png" + scale="60"/> + </imageobject> + </mediaobject> + </figure> + <para>Now, when you've got background knowledge of simple project creation, + let's move to more advanced tools.</para> + </section> + </section> + </section> + </section> + <section id="The_JBoss_jBPM_Int_Mech" xreflabel="The_JBoss_jBPM_Int_Mech"> + <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?> + + <title>Actions : The JBoss jBPM Integration Mechanism</title> + + <para> In this chapter we will show how to do software integration with <property>JBoss + jBPM</property>. The standard mechanism to implement this is to wrap the functionality you + want to integrate in a class that implements the <emphasis> + <property>ActionHandler</property> + </emphasis> interface. In order to demonstrate it let's specify Hello World action for our + process.</para> + + <section> + <title>Creating a Hello World Action</title> + + <para>Each Hello World process should integrate one or more Hello World actions, so this is + what we will be doing. We can integrate custom code at different points in the process + definition. To do this we have to specify an action handler, represented by an + implementation of the <emphasis> + <property>ActionHandler</property> + </emphasis> interface, and attach this piece of code to a particular event. These events + are amongst others, going over a transition, leaving or entering nodes, after and before + signalling. </para> + + <para> To make things a little bit more concrete, let's create a new class called <emphasis> + <property>HelloActionHandler</property>. + </emphasis> For that firstly we'll create a new package <emphasis> + <property>com.jbay.action</property> + </emphasis> in the <emphasis> + <property>src/java/main</property> + </emphasis> folder of our project. Then, we should call New Class Creation wizard as + usual by right-clicking and navigating <emphasis> + <property>New > Class</property>. + </emphasis> </para> + + <figure> + <title>Creating HelloActionHendler Class</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Notice that two first gaps have been filled automatically. Here, instead of <emphasis> + <property>Package</property> + </emphasis> option <emphasis> + <property>Enclose type</property> + </emphasis> option can be selected where a type in which to enclose a new class should + be specified.</para> + + <para>In our case, we leave everything as it is, just type <emphasis> + <property>HelloActionHandler</property> + </emphasis> as a name of new class and add <emphasis> + <property>org.jbpm.graph.ActionHendler</property> + </emphasis> interface as it's shown in the picture above.</para> + + <para>Thus, our <emphasis> + <property>HelloActionHandler</property> + </emphasis> implements the <emphasis> + <property>ActionHandler</property> + </emphasis> interface including the <emphasis> + <property>execute</property> + </emphasis> method as shown in the next figure. Here, we add a variable named <emphasis> + <property>greeting</property> + </emphasis> to the collection of process variables and put a message in it : + <emphasis>"Hello from ActionHandler"</emphasis>. </para> + + <figure> + <title>A Simple Hello Action</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now, as we have <emphasis> + <property>HelloActionHandler</property> + </emphasis> class defined, let's explore how we can handle it.</para> + </section> + + <section> + <title>Integrating the Hello World Action</title> + + <para>The main purpose of this chapter is to provide you with the steps associating our + Hello World action with a particular event and test the correctness of our actions as + well.</para> + + <para> As good Testcity citizens we will first create a Unit Test that proves the behaviour + we want to achieve by adding the <emphasis> + <property>ActionHandler</property> + </emphasis> to the process. So we implement another test.</para> + + <para>At first, let's return to the + code we already saw in the previous chapter and add new test method <emphasis> + <property>testActionHendler</property></emphasis> to it. </para> + + <figure> + <title>Create the Hello Action Test</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>We assert + that no variable called <emphasis> + <property>greeting</property> + </emphasis> exist. Then we give the process a signal to move it to the auction state. We + want to associate the execution of the action with the event of going over the + transition from the start state to the auction state. So after the signal, the process + should be in the auction state as in the previous scenario. But moreover, the <emphasis> + <property>greeting</property> + </emphasis> variable should exist and contain the string <emphasis>"Hello from + ActionHandler"</emphasis>. That's what we assert in the last lines of the test + method.</para> + + + + <para> Running the tests now results in a failure. The point is that we did not associate + the action with any particular event in the process definition, so the process variable + did not get set. </para> + + <figure> + <title>Test Results Before Integration</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para> Let's do something about it and add an action to the first transition of our + sample process. To do this you can use the Actions tab in the Properties Editor that is + under the graphical canvas. Bring up the popup menu of the action element container and + chose New Action as it's shown on the figure below. The other way to add an action + to the transition is simply to use the dropdown menu that is available under the action + icon in the right upper corner of the Properties View.</para> + + <figure> + <title>Adding an Action to a Transition</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>After adding the action a tabbed view with three pages will appear.</para> + + <figure> + <title>Configuration Dialog for an Action</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>The first of these three pages allows you to give the Action a name. The last page + contains some advanced attributes such as whether the Action is asynchronous. The + Details page is the most important. It allows to choose and configure the actual action + handler implementation. </para> + + <figure> + <title>The Details page of an Action Configuration Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + + <para>Clicking on the <emphasis> + <property>Search...</property> + </emphasis> button brings us to a Choose Class dialog.</para> + + + <figure> + <title>The Choose Action Handler Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para> We choose our previously created 'HelloActionHandler' class and + push the <property>OK</property> button. After the selection of the action handler for + the action, we can run the test and observe it gives us a green light.</para> + + <figure> + <title>Test Results</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png" + scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para>There we are. The above objective has been achieved.</para> + </section> + + <section> + <title> Integration Points</title> + + <para> The different integration points in a process definition are thoroughly documented in + the <ulink + url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink>. Instance nodes can contain many action + elements. Each of these will appear in the Action element list of the Actions tab. But + each Action also has a properties view of itself. You can navigate to this view by + selecting the added Action in the outline view. </para> + + </section> + </section> + <section id="Quick_Howto_Guide" xreflabel="Quick_Howto_Guide"> + <?dbhtml filename="Quick_Howto_Guide.html"?> + + <title>Quick Howto Guide</title> + + <para>This chapter contains additional information related to the <property>JBoss + jBPM</property>.</para> + + <section id="change_core_jbpm_inst"> + <title>Change the Default Core jBPM Installation</title> + + <para> You can change the default <property>jBPM</property> installation by means of the + Eclipse preference mechanism. Open the Preferences dialog by selecting <emphasis> + <property>Window > Preferences</property> + </emphasis> and select the <emphasis> + <property>JBoss jBPM > Runtime Location</property> + </emphasis> category. Using this page you can add multiple <property>jBPM</property> + installation locations and change the default one. The default installation is used for + the classpath settings when creating a new Process Project. Changing the preferences has + no influence on already created projects. Getting rid of a <property>jBPM</property> + installation that's being referenced by a project however will cause the + classpath to contain errors. </para> + + + <figure> + <title>The jBPM Preferences Page</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Configuring Task Nodes</title> + + <para>Here, we'll examine how you can configure the Task nodes in jBPM jPDL GPD.</para> + + <para> You can add Tasks to Task nodes and then configure them in a similar manner as the + Action configuration mechanism. Let's consider the process definition similar + to the previous one that contains three nodes: Start state, Task node and End state. The + <property>Properties view</property> for selected Task node includes several tabs. </para> + + <figure> + <title>The Properties View of the selected Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>We should choose the Task tab and then bring up the context menu or click the button + in the top right corner of the view to add a Task to our Task node.</para> + + <figure> + <title>Adding a Task to the Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Every added Task has its own configuration possibilities. You can access them through + the <property>Properties view</property> as well.</para> + + <figure> + <title>The Task properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>General page</property> is a place where you can specify the name of a + Task and its description. For instance, let it be <emphasis> + <property>approve oder</property> + </emphasis> with appropriate description that you can see in the figure below.</para> + + <figure> + <title>The Task General Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now, look at <property>Details page</property>. First, you should specify the due date + that is a mandatory property for the Task. The due date is the date on which the task + should be accomplished. Here you can also set a Task priority as well as signalling, + notifying or blocking. The <emphasis> + <property>Blocking</property> + </emphasis> attribute indicates that the process will not be able to continue if this + task is still unaccomplished. The <emphasis> + <property>Generate Form...</property> + </emphasis> button is for creating a simple task form that can be rendered by the jBPM + console.</para> + + <figure> + <title>The Task Details Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>For our example, we specify the due date as 2 business days, choose the high priority + and also check the <emphasis> + <property>Signalling</property> + </emphasis> and <emphasis> + <property>Notify</property> + </emphasis> attributes. It means that the Task should be accomplished in 2 business days + and the assignee will be notified by email when the task is assigned. To specify how the + Task should be assigned switch on to the <property>Assignment page</property>.</para> + + <figure> + <title>The Task Assignment Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the <property>Reminder page</property> you can specify whether the assignee will be reminded of the task + that awaits him.</para> + + <figure> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>In our case, the assignee will be reminded by email after two business hours and + continue to get reminding every business hour after that.</para> + <para>In the next figure you can see our configuring generated into XML.</para> + <figure> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + <para>We hope, our guide will help you to get started with the jPDL process language and jBPM + workflow on the whole. 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> \ No newline at end of file Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/the_views.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/the_views.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/en-US/the_views.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,385 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="reference" xreflabel="reference"> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + </keywordset> + </chapterinfo> + <title>Reference</title> + <section> + <title>Wizards</title> + <section> + <title>Process Project Wizard</title> + <para>This wizard helps to create new jBPM project.It is available with clicking + <property>File->New->Other->jBPM 3 Project</property> in the menu bar.</para> + <figure> + <title>New Process Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/jbpm_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>It consists of several pages:</para> + <itemizedlist> + <listitem><para>On the first page you can adjust the name of the project and the directory where it will be created.</para> + <para>If "<property>Use default</property>" option is checked the output directory will be the workspace, + othervise the user should specify it by himself using <property>Browse</property> button.</para> + <figure> + <title>New Process Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/jbpm_1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>On the second page you should point the location of your jbpm runtime.</para></listitem> + <listitem><para>The last page is only available for unabling/disabling + <emphasis>Generate simple process definition,action handling and Unit test</emphasis>.If you unable the option all the mentioned code will be generated automatically.</para></listitem> + </itemizedlist> + + </section> + <section> + <title>New JBPM Action Wizard</title> + <para>This wizard is available by clicking + <property>File->New->Other->jBPM 3 Action Handler</property>.</para> + + <figure> + <title>New JBPM Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/jbpm_3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>It includes the next options to adjust:</para> + + <table> + <title>New JBPM Action Wizard. Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + + <row> + <entry>Source folder</entry> + <entry>The path to the source folder relative to the selected project</entry> + <entry>The source folder of the project selected in the <emphasis><property>Project</property></emphasis> field</entry> + </row> + + <row> + <entry>Package</entry> + <entry>Enter a package to contain an Action Handler. + Either type a valid package name or click + <emphasis><property>Browse</property></emphasis> + to select a package via the dialog box.</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Enclosing type</entry> + <entry>Select the enclosing type of your jBPM action using + <emphasis><property>Browse</property></emphasis> + button.</entry> + <entry><blank></entry> + </row> + <row> + <entry>Modifiers</entry> + <entry>Select the modifiers that will be added to the generated class.</entry> + <entry>Public</entry> + </row> + <row> + <entry>Name</entry> + <entry>Type a name for a new Action Handler</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Superclass</entry> + <entry>Type or click <emphasis><property>Browse</property></emphasis> + to select a superclass for an Action Handler</entry> + <entry>org.jbpm.graph.def.ActionHandler</entry> + </row> + + <row> + <entry>Interface</entry> + <entry>Type or click <emphasis><property>Add</property></emphasis> + to select an interface/interfaces for an Action Handler</entry> + <entry>org.jbpm.graph.def.ActionHandler</entry> + </row> + + <row> + <entry>Which method stubs you would like to create?</entry> + <entry>Select the stubs that you would like to be created automatically.</entry> + <entry><itemizedlist> + <listitem><para>Constructors from superclass</para></listitem> + <listitem><para>Inherited abstract methods</para></listitem> + </itemizedlist> + </entry> + </row> + + <row> + <entry>Do you want to add comments?</entry> + <entry>Select <property>Generate comments</property> check box if you want comment mask + to be generated before the class definition. + </entry> + <entry><blank></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + + </section> + + <section id="the_views" xreflabel="the_views"> + <?dbhtml filename="the_views.html"?> + <title>The views</title> + <para>Here, it will be explained how to work with views and editors provided by JBDS.</para> + <para>The views are used for representation and navigation the resources you are working on at + the moment. One of the advantages of all the views is that all modifications made in the + current active file are immediately displayed in them. Let’s get acquainted more closely + with those that the <property>jPDL perspective</property> provides. </para> + + <figure> + <title>The jPDL Perspective Views and Editors</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_0.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see in the picture above, the <property>jPDL perspective</property> contains a + complete set of functionality that's necessary for working on the jBPM project.</para> + + <section id="the_outline_view"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Outline View</title> + <para>To have a way to quickly see an outline of the process use the <emphasis> + <property>Outline view</property> + </emphasis> that is presented as the classical tree. If it is not visible select <emphasis> + <property>Window > Show view > Outline</property>. </emphasis></para> + + <figure> + <title>The Overview View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="the_overview"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Overview</title> + <para>The main advantage of this view is that it gives visual representation of the whole + current developing process. Besides, the <emphasis> + <property>Overview</property> + </emphasis> comes as a scrollable thumbnail which enables a better navigation of the + process structure if it's too large.</para> + + <figure> + <title>The Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="the_properties_view"> + <?dbhtml filename="the_properties_view.html"?> + <title>The Properties View</title> + <para> Here, we dwell on the JBDS <property>Properties view</property>.</para> + <para>Notice if it's not visible you can access it by navigating <emphasis> + <property>Window > Show view > Properties</property>. </emphasis></para> + <para>The view shows the relevant properties of the selected item in the tabbed form. Every + item has its own set of properties, which can be directly editable in the Properties + view or by brining up the context menu.</para> + + <figure> + <title>The Properties View of selected Transition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>For example, on the picture above the Properties view displays all the properties for + a selected transition. Its name has been changed to <emphasis> + <property>to_auction</property>. </emphasis> We've done it directly in + active General tab of the view. The same way let's change the name for the + second transition to <emphasis> + <property>to_end</property>. </emphasis></para> + <para>If no one item is selected, the view represents the properties of the whole process + definition. </para> + + <figure> + <title>The Properties View of Process Definition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In this case, it contains six tabs. The first one is the <emphasis> + <property>General</property>.</emphasis> It allows to specify a process name and add + necessary description. To illustrate let's change the process definition name + to <emphasis> + <property>jbay</property>. </emphasis></para> + </section> + + <section id="jbpm_gpd_editor"> + <?dbhtml filename="direct_editing.html"?> + <title>The jBPM Graphical Process Designer editor.</title> + <para>The <property>jBPM GPD editor</property> includes four modes: Diagram, Deployment, + Design and Source, which are available as switchable tabs at the bottom of the editor. + Let's dwell on each of them.</para> + + <section id="the_diagram_mode"> + <title>The Diagram mode</title> + <para> In this mode we define the process in the form of a diagram by means of tools + provided on the left-hand side of the jBPM GPD. </para> + + <figure> + <title>The Diagram mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Besides, some properties can be directly edited in the <property>Diagram + mode</property> of the graphical editor. One example of this is the <emphasis> + <property>name</property> + </emphasis> property of nodes. You can edit this directly by selecting the node of + which you want to change the name and then click once inside this node. This enables + an editor in the node. We change the name of the node to <emphasis> + <property>auction</property>. </emphasis></para> + </section> + + <section id="source_mode"> + <?dbhtml filename="the_source_view.html"?> + <title>The Source Mode</title> + <para>Now, that we have defined a simple process definition, we can have a look at the + XML that is being generated under the covers. To see this XML click on the Source + tab of the graphical process designer editor.</para> + + <figure> + <title>The Source Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The <property>Source mode</property> enables to easily manipulate our XML. That is + manually inserting and editing necessary elements or attributes. In addition, here + you can take advantage of content assist.</para> + + <para>A template is added to better render the jBPM task forms in the Visual editor. + Now the jBPM Graphical Process designer can create facelets that are associated with tasks and are rendered in the jBPM console.</para> + <figure> + <title>A task form in VPE</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_6a.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="design_mode"> + <?dbhtml filename="the_design_view.html"?> + <title>The Design Mode</title> + <para>One more way to edit your file is to use <property>Design mode</property>. You can + see it in the next picture:</para> + <figure> + <title>The Design Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see above, this mode looks like a table in the first column of which + the process structure is performed. Here, you can also insert, remove and edit + elements or attributes, moreover add comments and instructions. Their values can be + directly edited in the second column of the Design mode table.</para> + <para>For instance, let’s add a comment on the second transition. For that, you should + bring up the context menu for it and choose <emphasis> + <property>Add Before > Comment</property>. </emphasis></para> + + <figure> + <title>Adding a Comment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_8.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Then, we can put the text <emphasis>This transition leads to the end + state</emphasis> in the right column as its value.</para> + + <figure> + <title>Comment is added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_9.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="deployment_mode"> + <?dbhtml filename="the_deployment_view.html"?> + <title>The Deployment Mode</title> + <para>Finally, to adjust the deployment settings of the project you should switch on to + the tab that opens the <property>Deployment mode</property>. On the picture below + the <property>Deployment mode</property> is performed with default settings. Here, + you can easily modify them or, if the settings won't match your needs, to + reset defaults. </para> + <figure> + <title>The Deployment Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_10.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Test Connections</property> button can be used to check whether all your settings are valid before + deploying the process.</para> + + <para>To deploy the process on the server you should click the <property>Delpoy Process Archive</property> button.</para> + + <para>However, prior to testing the connection and deploying the process on the server you need to + make sure the server is configured to support jBPM functionality and is running.</para> + + <para>Please, also note that if authentication for deployment is required you may use the process deployer that is available at <property>/gpd-deployer/upload</property>.</para> + + <para>Now that we've seen how to work with <property>jPDL + perspective</property>, let's pass on to the project testing.</para> + </section> + </section> +</section> +</chapter> \ No newline at end of file Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/pom.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/pom.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/pom.xml 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,180 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>jbpm-ref-guide-en-US</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>JBPM_Reference_Guide</name> + + <profiles> + <profile> + <id>release</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseTest</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseJBDS</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>${pom.basedir}/target/docbook/staging/css/com/css</cssdir> + </properties> + </profile> + <profile> + <id>diffmk</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf> + </properties> + </profile> + </profiles> + + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.2.1</version> + <extensions>true</extensions> + + <dependencies> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-jdocbook-style</artifactId> + <type>jdocbook-style</type> + <version>1.0.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-docbook-xslt</artifactId> + <version>1.0.0-SNAPSHOT</version> + </dependency> + + + </dependencies> + + <configuration> + <sourceDocumentName>${master}</sourceDocumentName> + <sourceDirectory>${pom.basedir}</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>${xsl-pdf}</stylesheetResource> + <finalName>${project.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>${xsl-chunked}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>${xsl-single}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> +  +  + <docbookVersion>1.72.0</docbookVersion> + </options> + + </configuration> + </plugin> + <plugin> + <artifactId>maven-clean-plugin</artifactId> + <version>2.4</version> + <executions> + <execution> + <id>clean</id> + <phase>package</phase> + <goals> + <goal>clean</goal> + </goals> + </execution> + </executions> + <configuration> + <excludeDefaultDirectories>true</excludeDefaultDirectories> + <filesets> + <fileset> + <directory>${pom.basedir}/target/docbook/publish/en-US/</directory> + <includes> + <include>html/org/</include> + <include>html/org/</include> + <include>html_single/org/</include> + <include>html_single/org/</include> + <include>eclipse/org/</include> + <include>eclipse/org/</include> + </includes> + <followSymlinks>false</followSymlinks> + </fileset> + </filesets> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> +  +  +  + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + <stylesdir>classpath:/xslt</stylesdir> + <cssdir>${pom.basedir}/target/docbook/staging/css/org/css</cssdir> + <master>master.xml</master> + </properties> +</project> Added: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/publican.cfg =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/reference/publican.cfg (rev 0) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/reference/publican.cfg 2010-06-09 00:04:29 UTC (rev 22655) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22654 - tags/jbosstools-3.1.1.GA/jbpm/docs.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 20:00:08 -0400 (Tue, 08 Jun 2010) New Revision: 22654 Removed: tags/jbosstools-3.1.1.GA/jbpm/docs/reference/ Log: removing to upload restructured version

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22653 - tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 19:57:00 -0400 (Tue, 08 Jun 2010) New Revision: 22653 Modified: tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/BPMN_Convert_User_Guide.xml tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/Book_Info.xml tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/bpmn2jpdl.xml tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/master_output.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/BPMN_Convert_User_Guide.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/BPMN_Convert_User_Guide.xml 2010-06-08 23:55:43 UTC (rev 22652) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/BPMN_Convert_User_Guide.xml 2010-06-08 23:57:00 UTC (rev 22653) @@ -7,5 +7,4 @@ <xi:include href="overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="bpmn2jpdl.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> -<index></index> </book> Modified: tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/Book_Info.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/Book_Info.xml 2010-06-08 23:55:43 UTC (rev 22652) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/Book_Info.xml 2010-06-08 23:57:00 UTC (rev 22653) @@ -1,4 +1,4 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> -<bookinfo><title>BPMN Convert User Guide</title><subtitle>Provides information relating to the BPMN Convert module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>1</pubsnumber><abstract><para>The BPMN Convert User Guide explains how to use the BPMN Convert module to translate a BPMN file to a JPDL file.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> +<bookinfo><title>BPMN Convert User Guide</title><subtitle>Provides information relating to the BPMN Convert module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The BPMN Convert User Guide explains how to use the BPMN Convert module to translate a BPMN file to a JPDL file.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Modified: tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/bpmn2jpdl.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/bpmn2jpdl.xml 2010-06-08 23:55:43 UTC (rev 22652) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/bpmn2jpdl.xml 2010-06-08 23:57:00 UTC (rev 22653) @@ -46,7 +46,7 @@ <itemizedlist> <listitem> <para>Select 'test.bpmn' file and right-click it. Open the export wizard by - <emphasis><property>Export... > BPMN Export > BPMN -> JPDL</property></emphasis> + <emphasis><property>Export... -> BPMN -> BPMN to jPDL</property></emphasis> . </para> <figure> Modified: tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/master_output.xml 2010-06-08 23:55:43 UTC (rev 22652) +++ tags/jbosstools-3.1.1.GA/jbpm/docs/converter_ref/en-US/master_output.xml 2010-06-08 23:57:00 UTC (rev 22653) @@ -27,9 +27,9 @@ <year>2010</year> <holder>JBoss by Red Hat</holder> </copyright> - <releaseinfo><diffmk:wrapper diffmk:change="changed"> + <releaseinfo> Version: 1.1.0.GA - </diffmk:wrapper></releaseinfo> + </releaseinfo> <abstract> <title></title> <para> @@ -140,8 +140,8 @@ <para>A Bpmn file may include more than one pool. Every pool can be mapped to a corresponding Jpdl file.</para> <itemizedlist> <listitem> - <para>Select 'test.bpmn' file and right-click it. Open the export wizard by - <emphasis><property moreinfo="none">Export... > BPMN Export > BPMN -> JPDL</property></emphasis> + <para><diffmk:wrapper diffmk:change="changed">Select 'test.bpmn' file and right-click it. Open the export wizard by + </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Export... -> BPMN -> BPMN to jPDL</diffmk:wrapper></property></emphasis> . </para> <figure float="0">

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22652 - in tags/jbosstools-3.1.1.GA/as/docs/reference/en-US: images/modules and 5 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 19:55:43 -0400 (Tue, 08 Jun 2010) New Revision: 22652 Added: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_7a.png Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/modules/modules_1.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/modules/modules_3.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/modules/modules_4.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/dnd_toJBossServerView.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/filesets1.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/filesets3.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/filesets4.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_1.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_11.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_12.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_14.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_15.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_16.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_21a.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_22.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_23b.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_23c.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_25.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_26.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_4.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_5.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_7.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_8.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/server_classpaths.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/userlibraryfileset1.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_1.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_2.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_3.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_4a.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_4b.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_5.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_1.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_2.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_3.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4b.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4c.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_6.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_7.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/tptp_support/tptp_support_1.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/webtools/webtools_2.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/webtools/webtools_3.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/webtools/webtools_5.png tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/modules.xml tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/perspective.xml tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/quick_start.xml tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/runtimes_servers.xml tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/tptp_support.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/modules/modules_1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/modules/modules_3.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/modules/modules_4.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/dnd_toJBossServerView.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/filesets1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/filesets3.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/filesets4.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_11.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_12.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_14.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_15.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_16.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_21a.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_22.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_23b.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_23c.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_25.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_26.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_4.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_5.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_7.png =================================================================== (Binary files differ) Added: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_7a.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_7a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/perspective_8.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/server_classpaths.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/perspective/userlibraryfileset1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_2.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_3.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_4a.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_4b.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/quick_start/quick_start_5.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_2.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_3.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4b.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4c.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_6.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_7.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/tptp_support/tptp_support_1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/webtools/webtools_2.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/webtools/webtools_3.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/images/webtools/webtools_5.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/master.xml 2010-06-08 23:45:39 UTC (rev 22651) +++ tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/master.xml 2010-06-08 23:55:43 UTC (rev 22652) @@ -52,7 +52,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 2.1.0.GA + Version: 2.1.1.GA </releaseinfo> <abstract> <title/> Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/master_output.xml 2010-06-08 23:45:39 UTC (rev 22651) +++ tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/master_output.xml 2010-06-08 23:55:43 UTC (rev 22652) @@ -2,12 +2,12 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY quick_start SYSTEM "modules/quick_start.xml"> -<!ENTITY runtimes_servers SYSTEM "modules/runtimes_servers.xml"> -<!ENTITY perspective SYSTEM "modules/perspective.xml"> -<!ENTITY webtools SYSTEM "modules/webtools.xml"> -<!ENTITY modules SYSTEM "modules/modules.xml"> -<!ENTITY tptp_support SYSTEM "modules/tptp_support.xml"> +[<!ENTITY quick_start SYSTEM "quick_start.xml"> +<!ENTITY runtimes_servers SYSTEM "runtimes_servers.xml"> +<!ENTITY perspective SYSTEM "perspective.xml"> +<!ENTITY webtools SYSTEM "webtools.xml"> +<!ENTITY modules SYSTEM "modules.xml"> +<!ENTITY tptp_support SYSTEM "tptp_support.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -42,14 +42,15 @@ <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> + <copyright> <year>2007</year> - <year>2009</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 2.1.0.GA + Version: 2.1.1.GA </diffmk:wrapper></releaseinfo> <abstract> <title></title> @@ -63,7 +64,7 @@ <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"> +<chapter id="quick_start" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en-US/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> @@ -74,7 +75,7 @@ <table> - <title><diffmk:wrapper diffmk:change="changed">Key Functionality for JBoss AS and Archive Tools</diffmk:wrapper></title> + <title>Key Functionality for JBoss AS and Archive Tools</title> <tgroup cols="3"> <colspec align="left" colnum="1" colwidth="2*"></colspec> @@ -99,7 +100,7 @@ <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><para><diffmk:wrapper diffmk:change="changed">It makes managing installed JBoss Server quite easy and includes the standard Console and Properties views, and specially added Project archives view and Servers view for that purpose. </diffmk:wrapper></para></entry> <entry> <link linkend="perspective">JBoss AS perspective</link> </entry> @@ -126,23 +127,22 @@ </tgroup> </table> - <para><diffmk:wrapper diffmk:change="changed">If you + <para>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> + read in the <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><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> + <para>To start working with JBoss AS, select a <property moreinfo="none">JBoss AS Perspective</property> via + <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Show View > Other > Server > Servers</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> + behaviour with the help of a special toolbar in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view + where you could </diffmk:wrapper><emphasis> <property moreinfo="none">start</property> </emphasis> it in a regular or debug mode, <emphasis> <property moreinfo="none">stop</property> @@ -153,7 +153,7 @@ </emphasis> to the server.</para> <figure float="0"> - <title>JBoss Server Toolbar</title> + <title><diffmk:wrapper diffmk:change="changed">Servers Toolbar</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/quick_start/quick_start_1.png"></imagedata> @@ -161,11 +161,11 @@ </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> + <para>To launch the server click the green-with-white-arrow icon on the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers + </diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view or right click server name in this view and select </diffmk:wrapper><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> + <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Show View > Other > Server > + Servers</diffmk:wrapper></property>.</emphasis></para> <figure float="0"> <title>Start JBoss Server</title> @@ -183,8 +183,8 @@ <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> + </emphasis> icon in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view or right click the server name + and press </diffmk:wrapper><emphasis><property moreinfo="none">Stop</property>.</emphasis></para> <figure float="0"> <title>Stop JBoss Server</title> @@ -198,8 +198,8 @@ <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> + <para>Learn more about the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view + </diffmk:wrapper><link linkend="JBossServerView">here</link>.</para> </section> <section id="archiving"> @@ -210,8 +210,8 @@ 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> + <para>Right clicking in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Project archives</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view you can create War, + EJB War, EAR or JAR archive.</diffmk:wrapper></para> <figure float="0"> <title>Archive Creating</title> @@ -251,8 +251,8 @@ <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> + <para>Learn more about the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Project Archives</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view + </diffmk:wrapper><link linkend="Project_archivesView">here</link>.</para> </section> <section id="deployment"> @@ -295,7 +295,7 @@ </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 + server in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view and then selecting </diffmk:wrapper><emphasis><property moreinfo="none">Add and Remove Projects</property></emphasis> from the context menu.</para> <figure float="0"> @@ -321,22 +321,22 @@ </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 + <section id="publishing"> + <title>Publishing to JBoss Server</title> + <para>The publishing of all the modules added to a Server is performed automatically when starting a Server.</para> + <para>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> + just disable the automatic publish in the <link linkend="server_editor">Server Editor</link> and use the <emphasis> + <property moreinfo="none">Publish to Server</property></emphasis> (<inlinemediaobject> + <imageobject> + <imagedata fileref="images/quick_start/publish_button.png"></imagedata> </imageobject> - </inlinemediaobject><diffmk:wrapper diffmk:change="added">) button which initiates an incremental publish. - </diffmk:wrapper></para> + </inlinemediaobject>) button which initiates an incremental publish. + </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 + <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.</diffmk:wrapper></para> + talk about them in detail.</para> </section> <section> @@ -345,358 +345,15 @@ <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><diffmk:wrapper diffmk:change="changed">Find out the answers on the frequently asked questions about JBoss AS 5 usage in the + </diffmk:wrapper><diffmk:wrapper diffmk:change="changed">JBossAS5FAQ</diffmk:wrapper></para>. + </section> <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> - - -<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"> +<chapter id="perspective" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en-US/perspective.xml" xreflabel="perspective"> <?dbhtml filename="perspective.html"?> <chapterinfo> <keywordset> @@ -717,21 +374,21 @@ 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> + <property moreinfo="none">Project archives view</property> and the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers + </diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view.</diffmk:wrapper></para> <section id="JBossServerView" role="updated"> <?dbhtml filename="JBossServerView.html"?> - <title>The JBoss Server View</title> + <title><diffmk:wrapper diffmk:change="changed">The Servers view</diffmk:wrapper></title> - <para>The <property moreinfo="none">JBoss Server View</property> is built on Common Navigator Framework + <para>The <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view 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> + without loosing the vital information.</diffmk:wrapper></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> + <para>Let's have a look at the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view and inspect + in detail all parts it consists of. </diffmk:wrapper></para> <figure float="0"> - <title>The JBoss Server View</title> + <title><diffmk:wrapper diffmk:change="changed">The Servers view</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/perspective/perspective_1.png"></imagedata> @@ -740,14 +397,14 @@ </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 + <title><diffmk:wrapper diffmk:change="changed">Servers view Toolbar</diffmk:wrapper></title> + <para>In the right top corner of the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view 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> + possibility to publish to a server.</diffmk:wrapper></para> <figure float="0"> - <title>The JBoss Server View Toolbar</title> + <title><diffmk:wrapper diffmk:change="changed">The Servers view Toolbar</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/perspective/perspective_2.png"></imagedata> @@ -775,13 +432,13 @@ </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 + <title><diffmk:wrapper diffmk:change="changed">Servers view Structure</diffmk:wrapper></title> + <para>The <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view 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> + in the square brackets next to a server name.</diffmk:wrapper></para> <figure float="0"> - <title>The JBoss Server View</title> + <title><diffmk:wrapper diffmk:change="changed">The Servers view</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/perspective/perspective_1.png"></imagedata> @@ -991,9 +648,9 @@ </tgroup> </table> - <para>Under the server element in the <property moreinfo="none">JBoss Server View</property>, you can + <para>Under the server element in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view, you can see currently deployed to the server modules and some server extensions which - provide the additional information on the server.</para> + provide the additional information on the server.</diffmk:wrapper></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> @@ -1012,8 +669,8 @@ <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> + </emphasis> category in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view is intended + for files filtering.</diffmk:wrapper></para> <para>To add a new file filter, right-click the <emphasis> <property moreinfo="none">Filesets</property> @@ -1061,7 +718,7 @@ <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> + </emphasis> category in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view.</diffmk:wrapper></para> <para>It's possible now to edit files directly from the <emphasis> <property moreinfo="none">Filesets</property> @@ -1162,7 +819,7 @@ <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"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view.</diffmk:wrapper></emphasis> Look for them in the <emphasis> <property moreinfo="none">Inactive Categories</property> </emphasis> afterwards to re-enable.</para> @@ -1263,14 +920,14 @@ </section> <section id="dragndrop_to_jboss_server_view"> - <title>Drag-n-Drop to JBoss Server View</title> + <title><diffmk:wrapper diffmk:change="changed">Drag-n-Drop to Servers view</diffmk:wrapper></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> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view supports drag-n-drop of deployable and + runnable projects/resources.</diffmk:wrapper></para> <figure float="0"> - <title>Dragging to the JBoss Server View</title> + <title><diffmk:wrapper diffmk:change="changed">Dragging to the Servers view</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/perspective/dnd_toJBossServerView.png"></imagedata> @@ -1428,8 +1085,8 @@ 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>Under the <emphasis> + <property moreinfo="none">Publishing</property></emphasis> section it' possible to disable/inable the automatic publishing of the changes in the workspace.</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>. @@ -1479,7 +1136,7 @@ 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 + arguments, main, classpaths and other things that are relevant to launching the server.</para> <figure float="0"> @@ -1490,7 +1147,9 @@ </imageobject> </mediaobject> </figure> - + + + <para>The first tab shows the Jboss server arguments</para> <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> @@ -1510,6 +1169,8 @@ <para>Values are not controlled by the server and its runtime setup will be passed on unaltered.</para> </note> + + <para>On the second tab you find the main class used for launching JBoss AS (default is org.jboss.Main), you can change it, if necessary. </para> <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 @@ -1535,6 +1196,23 @@ </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> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Using </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Deployment tab</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> you configure local deployment settings.</diffmk:wrapper></para> + + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Deployment tab</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/perspective/perspective_7a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Using the group of radio buttons in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Default Settings section</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + a user can set where the application will + be deployed to.By default it is deployed to the user's workspace folder, + exactly to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">[workspaceDirecotry]\.metadata\.plugins</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.If you would like the application to be deployed to your Jboss + server deploy folder select </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Use the JBoss deploy folder</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">. + The option to specify your custom deploy folder is also available.</diffmk:wrapper></para> </section> <section> @@ -1762,28 +1440,28 @@ </section> - <section diffmk:change="added" id="CreatingaUserLibrariesFileSet"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating User Library FileSet</diffmk:wrapper></title> + <section id="CreatingaUserLibrariesFileSet"> + <title>Creating User Library FileSet</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> + <para>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.</para> + <para>To add a new user libraries file set, call the right-click menu on the necessary archive and choose " New User Libraries FileSet" item</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> + <figure float="0"> + <title>Adding New User Library Fileset</title> + <mediaobject> + <imageobject> + <imagedata 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> + <para>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</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> + <figure float="0"> + <title>Editing User Library Fileset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/userlibraryfileset2.png"></imagedata> </imageobject> </mediaobject> </figure> @@ -1883,6 +1561,11 @@ </tbody> </tgroup> </table> + + <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">When editing an archive, it is also updated in all folders and other archives where it is nested.</diffmk:wrapper></para> + </note> </section> <section id="PublishToServer"> @@ -1931,7 +1614,7 @@ </chapter> -<chapter id="webtools" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/as/docs/reference/en/modules/webtools.xml"> +<chapter id="webtools" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en-US/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 @@ -2092,7 +1775,7 @@ </chapter> -<chapter id="modules" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/as/docs/reference/en/modules/modules.xml"> +<chapter id="modules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en-US/modules.xml"> <title>Deploying Modules</title> <para>In this chapter it will be described how to deploy modules onto the server.</para> @@ -2192,16 +1875,15 @@ </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 + <title><diffmk:wrapper diffmk:change="changed">Deploying with Servers View</diffmk:wrapper></title> + <para>As it has been already mentioned <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view 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> + to deploy resources onto the server.</diffmk:wrapper></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> + <title><diffmk:wrapper diffmk:change="changed">Top part of Servers view</diffmk:wrapper></title> + <para>In the top part of the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view you should right click on a server and select the </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Add and Remove</diffmk:wrapper></property> </emphasis> menu item.</para> <figure float="0"> <title>Add and Remove Projects</title> @@ -2224,10 +1906,10 @@ </section> <section> - <title>Bottom part of JBoss Server View</title> + <title><diffmk:wrapper diffmk:change="changed">Bottom part of Servers view</diffmk:wrapper></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"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view + </diffmk:wrapper></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> @@ -2291,7 +1973,7 @@ </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"> +<chapter id="tptp_support" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en-US/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> @@ -2299,11 +1981,20 @@ <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>To get TPTP profiling work on <property moreinfo="none">JBoss Application Server</property><diffmk:wrapper diffmk:change="added"> you should + do the following:</diffmk:wrapper></para> + + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Download </diffmk:wrapper><ulink diffmk:change="added" url="http://www.eclipse.org/tptp/home/downloads/"><diffmk:wrapper diffmk:change="added">TPTP Runtime</diffmk:wrapper></ulink> and install it, i. e. just add the content of <emphasis> + <code diffmk:change="added">plugins/features</code> + </emphasis><diffmk:wrapper diffmk:change="added"> folders from downloaded directory to the same folders in your eclipse + installation directory or use the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Help > Install New Software</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> + command.</diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Install </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss TPTP Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + which provide TPTP support for JBoss AS servers (find the latest stable version of the JBoss TPTP profile feature at + </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/tools/download/stable"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/tools/download/stable</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">).</diffmk:wrapper></para></listitem> + </itemizedlist> <para>And now all profile actions should work for you. To start <property moreinfo="none">JBoss AS</property> in profiling mode use <emphasis> Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/modules.xml =================================================================== --- tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/modules.xml 2010-06-08 23:45:39 UTC (rev 22651) +++ tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/modules.xml 2010-06-08 23:55:43 UTC (rev 22652) @@ -99,16 +99,15 @@ </section> <section> - <title>Deploying with JBoss Server View</title> - <para>As it has been already mentioned <property>JBoss Server View</property> contains two + <title>Deploying with Servers View</title> + <para>As it has been already mentioned <property>Servers</property> view 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>JBoss Servers View</property> like in the Servers - View you should right click on a server and select the <emphasis> - <property>Add and Remove Projects</property> + <title>Top part of Servers view</title> + <para>In the top part of the <property>Servers</property> view you should right click on a server and select the <emphasis> + <property>Add and Remove</property> </emphasis> menu item.</para> <figure> <title>Add and Remove Projects</title> @@ -131,9 +130,9 @@ </section> <section> - <title>Bottom part of JBoss Server View</title> + <title>Bottom part of Servers view</title> <para>In the bottom part of <emphasis> - <property>JBoss Server View</property> + <property>Servers</property> view </emphasis> there is a category called <emphasis> <property>Modules</property> </emphasis> which should display all currently-published modules on the server. Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/perspective.xml =================================================================== --- tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/perspective.xml 2010-06-08 23:45:39 UTC (rev 22651) +++ tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/perspective.xml 2010-06-08 23:55:43 UTC (rev 22652) @@ -20,21 +20,21 @@ perspective</property>, but it contains a few additional views. Two of the additional views are standard views, specifically the <property>Console view</property> and the <property>Properties view</property>. The other two views that are added are the - <property>Project archives view</property> and the <property>JBoss Server - View</property>.</para> + <property>Project archives view</property> and the <property>Servers + </property> view.</para> <section id="JBossServerView" role="updated"> <?dbhtml filename="JBossServerView.html"?> - <title>The JBoss Server View</title> + <title>The Servers view</title> - <para>The <property>JBoss Server View</property> is built on Common Navigator Framework + <para>The <property>Servers</property> view 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>JBoss Server View</property> and inspect + <para>Let's have a look at the <property>Servers</property> view and inspect in detail all parts it consists of. </para> <figure> - <title>The JBoss Server View</title> + <title>The Servers view</title> <mediaobject> <imageobject> <imagedata fileref="images/perspective/perspective_1.png"/> @@ -43,14 +43,14 @@ </figure> <section id="jbossserver_view_toolbar"> - <title>JBoss Server View Toolbar</title> - <para>In the right top corner of the <property>JBoss Server View</property> there is a + <title>Servers view Toolbar</title> + <para>In the right top corner of the <property>Servers</property> view 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> - <title>The JBoss Server View Toolbar</title> + <title>The Servers view Toolbar</title> <mediaobject> <imageobject> <imagedata fileref="images/perspective/perspective_2.png"/> @@ -78,13 +78,13 @@ </section> <section id="jbossserver_view_structure"> - <title>JBoss Server View Structure</title> - <para>The <property>JBoss Server View</property> displays all declared servers as well + <title>Servers view Structure</title> + <para>The <property>Servers</property> view 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> - <title>The JBoss Server View</title> + <title>The Servers view</title> <mediaobject> <imageobject> <imagedata fileref="images/perspective/perspective_1.png"/> @@ -294,7 +294,7 @@ </tgroup> </table> - <para>Under the server element in the <property>JBoss Server View</property>, you can + <para>Under the server element in the <property>Servers</property> view, you can see currently deployed to the server modules and some server extensions which provide the additional information on the server.</para> @@ -315,7 +315,7 @@ <para>The <emphasis> <property>Filesets</property> - </emphasis> category in the <property>JBoss Server View</property> is intended + </emphasis> category in the <property>Servers</property> view is intended for files filtering.</para> <para>To add a new file filter, right-click the <emphasis> @@ -364,7 +364,7 @@ <para>After the filter is created, you can observe it by expanding the <emphasis> <property>Filesets</property> - </emphasis> category in the <property>JBoss Server View</property>.</para> + </emphasis> category in the <property>Servers</property> view.</para> <para>It's possible now to edit files directly from the <emphasis> <property>Filesets</property> @@ -465,7 +465,7 @@ <property>XML Configuration</property> </emphasis> category makes possible to disable it. You can disable any category in the bottom part of the <emphasis> - <property>JBoss Server View</property>.</emphasis> Look for them in the <emphasis> + <property>Servers</property> view.</emphasis> Look for them in the <emphasis> <property>Inactive Categories</property> </emphasis> afterwards to re-enable.</para> @@ -566,14 +566,14 @@ </section> <section id="dragndrop_to_jboss_server_view"> - <title>Drag-n-Drop to JBoss Server View</title> + <title>Drag-n-Drop to Servers view</title> <para>Starting from 2.0.0.CR2 version of <property>JBoss AS Tools</property> the - <property>JBoss Server View</property> supports drag-n-drop of deployable and + <property>Servers</property> view supports drag-n-drop of deployable and runnable projects/resources.</para> <figure> - <title>Dragging to the JBoss Server View</title> + <title>Dragging to the Servers view</title> <mediaobject> <imageobject> <imagedata fileref="images/perspective/dnd_toJBossServerView.png"/> @@ -844,6 +844,23 @@ </emphasis> should add it properly. Also, <emphasis> <property>Restore Default Entries</property> </emphasis> will also remove any extra entries you added yourself.</para> + <para>Using <emphasis>Deployment tab</emphasis> you configure local deployment settings.</para> + + + <figure> + <title>Deployment tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_7a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Using the group of radio buttons in <property>Default Settings section</property> + a user can set where the application will + be deployed to.By default it is deployed to the user's workspace folder, + exactly to <property>[workspaceDirecotry]\.metadata\.plugins</property>.If you would like the application to be deployed to your Jboss + server deploy folder select <emphasis><property>Use the JBoss deploy folder</property></emphasis>. + The option to specify your custom deploy folder is also available.</para> </section> <section> @@ -1192,6 +1209,11 @@ </tbody> </tgroup> </table> + + <note> + <title>Note:</title> + <para>When editing an archive, it is also updated in all folders and other archives where it is nested.</para> + </note> </section> <section id="PublishToServer"> Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/quick_start.xml =================================================================== --- tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/quick_start.xml 2010-06-08 23:45:39 UTC (rev 22651) +++ tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/quick_start.xml 2010-06-08 23:55:43 UTC (rev 22652) @@ -35,7 +35,7 @@ <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><para>It makes managing installed JBoss Server quite easy and includes the standard Console and Properties views, and specially added Project archives view and Servers view for that purpose. </para></entry> <entry> <link linkend="perspective">JBoss AS perspective</link> </entry> @@ -69,15 +69,14 @@ chapter.</para> <para>To start working with JBoss AS, select a <property>JBoss AS Perspective</property> via - <emphasis><property>Window > Open Perspective > Other > JBoss - AS</property>.</emphasis></para> + <emphasis><property>Window > Show View > Other > Server > Servers</property>.</emphasis></para> </section> <section id="starting"> <title>Starting JBoss Server</title> <para>Starting <property>JBoss Server</property> is quite simple. You can control the server - behaviour with the help of a special toolbar in the <property>JBoss Server View</property> + behaviour with the help of a special toolbar in the <property>Servers</property> view where you could <emphasis> <property>start</property> </emphasis> it in a regular or debug mode, <emphasis> @@ -89,7 +88,7 @@ </emphasis> to the server.</para> <figure> - <title>JBoss Server Toolbar</title> + <title>Servers Toolbar</title> <mediaobject> <imageobject> <imagedata fileref="images/quick_start/quick_start_1.png"/> @@ -97,11 +96,11 @@ </mediaobject> </figure> - <para>To launch the server click the green-with-white-arrow icon on the <property>JBoss Server - View </property>or right click server name in this view and select <emphasis> + <para>To launch the server click the green-with-white-arrow icon on the <property>Servers + </property> view or right click server name in this view and select <emphasis> <property>Start</property>. </emphasis> If this view is not open, select <emphasis><property>Window > Show View > Other > Server > - JBoss Server View</property>.</emphasis></para> + Servers</property>.</emphasis></para> <figure> <title>Start JBoss Server</title> @@ -119,7 +118,7 @@ <para>To stop the server, click the <emphasis> <property>Stop</property> - </emphasis> icon in the <property>JBoss Server View</property> or right click the server name + </emphasis> icon in the <property>Servers</property> view or right click the server name and press <emphasis><property>Stop</property>.</emphasis></para> <figure> @@ -134,7 +133,7 @@ <para>When the server is stopped you will see <emphasis> <property>Stopped</property> </emphasis> state next to its name in the square brackets.</para> - <para>Learn more about the <property>JBoss Server View</property> + <para>Learn more about the <property>Servers</property> view <link linkend="JBossServerView">here</link>.</para> </section> @@ -146,7 +145,7 @@ plugin consists primarily of a view to set up each packaging configuration <emphasis>( <property>Window > Show View > Other > JBoss Tools > Project archives</property>). </emphasis></para> - <para>Right clicking in the <property>Project archives view</property> you can create War, + <para>Right clicking in the <property>Project archives</property> view you can create War, EJB War, EAR or JAR archive.</para> <figure> @@ -187,7 +186,7 @@ <para>To perform the building of the project archives, select the project in the <property>Package Explorer</property> view and execute the hotkey combination you assigned for this action.</para> - <para>Learn more about the <property>Project Archives View</property> + <para>Learn more about the <property>Project Archives</property> view <link linkend="Project_archivesView">here</link>.</para> </section> @@ -231,7 +230,7 @@ </figure> <para>You can deploy an existing application to a server by right-clicking the target defined - server in the <property>JBoss Servers View</property> and then selecting <emphasis><property>Add and + server in the <property>Servers</property> view and then selecting <emphasis><property>Add and Remove Projects</property></emphasis> from the context menu.</para> <figure> @@ -284,7 +283,7 @@ 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>. + <ulink url="http://community.jboss.org/wiki/JBossAS5FAQ">JBossAS5FAQ</ulink>. </para> <para>The information on how to monitor a remote JBoss Server from Eclipse you can find in the following Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/runtimes_servers.xml =================================================================== --- tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/runtimes_servers.xml 2010-06-08 23:45:39 UTC (rev 22651) +++ tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/runtimes_servers.xml 2010-06-08 23:55:43 UTC (rev 22652) @@ -90,7 +90,7 @@ <note> <title>Note:</title> - <para>Currently we recommend you to use a fully supported JBoss 4.2 server adapter.</para> + <para>Currently we recommend you to use a fully supported JBoss 5.0 server adapter.</para> </note> <para>You'll also note a Deploy-Only Runtime type. This type provides no classpath @@ -99,7 +99,7 @@ debugging their projects inside eclipse.</para> <figure id="add_runtime_figure"> - <title>Adding a JBoss 4.2 Runtime</title> + <title>Adding a JBoss 5.0 Runtime</title> <mediaobject> <imageobject> <imagedata fileref="images/runtimes_servers/runtimes_servers_3.png"/> Modified: tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/tptp_support.xml =================================================================== --- tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/tptp_support.xml 2010-06-08 23:45:39 UTC (rev 22651) +++ tags/jbosstools-3.1.1.GA/as/docs/reference/en-US/tptp_support.xml 2010-06-08 23:55:43 UTC (rev 22652) @@ -8,12 +8,21 @@ <title>TPTP Profiling</title> <para>To get TPTP profiling work on <property>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>plugins/features</property> - </emphasis> folders from downloaded directory to the same folders in your eclipse - installation directory.</para> + do the following:</para> + + <itemizedlist> + <listitem><para>Download <ulink + url="http://www.eclipse.org/tptp/home/downloads/" + >TPTP Runtime</ulink> and install it, i. e. just add the content of <emphasis> + <code>plugins/features</code> + </emphasis> folders from downloaded directory to the same folders in your eclipse + installation directory or use the <emphasis><property>Help > Install New Software</property></emphasis> + command.</para> + </listitem> + <listitem><para>Install <property>JBoss TPTP Tools</property> + which provide TPTP support for JBoss AS servers (find the latest stable version of the JBoss TPTP profile feature at + <ulink url="http://www.jboss.org/tools/download/stable">http://www.jboss.org/tools/download/stable</ulink>).</para></listitem> + </itemizedlist> <para>And now all profile actions should work for you. To start <property>JBoss AS</property> in profiling mode use <emphasis> @@ -52,7 +61,7 @@ <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> + >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>

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22651 - tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 19:45:39 -0400 (Tue, 08 Jun 2010) New Revision: 22651 Modified: tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/intro.xml tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/portlet_tools_tasks.xml tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/seam_portlet.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/intro.xml =================================================================== --- tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/intro.xml 2010-06-08 23:43:43 UTC (rev 22650) +++ tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/intro.xml 2010-06-08 23:45:39 UTC (rev 22651) @@ -5,8 +5,7 @@ <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins includes tools for supporting <property>JBoss Portal</property> and JSR-186/JSR-286 portlets. Thus, this guide is intended to explain you how to get started and manage <property>JBoss Portlet Tools</property>.</para> - - <section id="preface"> +<section> <title>What is JBoss Portal and Portlet Tools?</title> <para><property>JBoss Portal</property> provides an open source platform for hosting and serving a portal's Web interface, publishing and managing its content, and customizing @@ -119,6 +118,6 @@ <para><property>JBoss Portlet Tools</property> is included as part of <property>JBoss Tools</property> project. Refer to <ulink url="http://www.jboss.org/tools/download/installation.html">http://www.jboss.org/tools/download/installation.html</ulink> - for installation methods of <property>JBoss Tools</property>.</para> - </section> + for installation methods of <property>JBoss Tools</property>.</para> +</section> </chapter> Modified: tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/master.xml 2010-06-08 23:43:43 UTC (rev 22650) +++ tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/master.xml 2010-06-08 23:45:39 UTC (rev 22651) @@ -50,7 +50,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 1.1.0.GA + Version: 1.1.1.GA </releaseinfo> <abstract> Modified: tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/master_output.xml 2010-06-08 23:43:43 UTC (rev 22650) +++ tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/master_output.xml 2010-06-08 23:45:39 UTC (rev 22651) @@ -2,14 +2,14 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY intro SYSTEM "modules/intro.xml"> -<!ENTITY installation SYSTEM "modules/installation.xml"> -<!ENTITY portlet_tools_tasks SYSTEM "modules/portlet_tools_tasks.xml"> -<!ENTITY starting_project SYSTEM "modules/starting_project.xml"> -<!ENTITY jsf_portlet SYSTEM "modules/jsf_portlet.xml"> -<!ENTITY seam_portlet SYSTEM "modules/seam_portlet.xml"> -<!ENTITY reference SYSTEM "modules/reference.xml"> -<!ENTITY summary SYSTEM "modules/summary.xml"> +[<!ENTITY intro SYSTEM "intro.xml"> +<!ENTITY installation SYSTEM "installation.xml"> +<!ENTITY portlet_tools_tasks SYSTEM "portlet_tools_tasks.xml"> +<!ENTITY starting_project SYSTEM "starting_project.xml"> +<!ENTITY jsf_portlet SYSTEM "jsf_portlet.xml"> +<!ENTITY seam_portlet SYSTEM "seam_portlet.xml"> +<!ENTITY reference SYSTEM "reference.xml"> +<!ENTITY summary SYSTEM "summary.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -48,7 +48,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 1.1.0.GA + Version: 1.1.1.GA </diffmk:wrapper></releaseinfo> <abstract> @@ -64,14 +64,13 @@ -<chapter id="intro" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/intro.xml" xreflabel="intro"> +<chapter id="intro" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en-US/intro.xml" xreflabel="intro"> <?dbhtml filename="intro.html"?> <title>Introduction</title> <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins includes tools for supporting <property moreinfo="none">JBoss Portal</property> and JSR-186/JSR-286 portlets. Thus, this guide is intended to explain you how to get started and manage <property moreinfo="none">JBoss Portlet Tools</property>.</para> - - <section id="preface"> +<section> <title>What is JBoss Portal and Portlet Tools?</title> <para><property moreinfo="none">JBoss Portal</property> provides an open source platform for hosting and serving a portal's Web interface, publishing and managing its content, and customizing @@ -185,792 +184,187 @@ Refer to <ulink url="http://www.jboss.org/tools/download/installation.html">http://www.jboss.org/tools/download/installation.html</ulink> for installation methods of <property moreinfo="none">JBoss Tools</property>.</para> </section> -</chapter> + <section diffmk:change="added" id="Test_Drive_Proc_Development" xreflabel="Test_Drive_Proc_Development"> + <?dbhtml filename="Test_Drive_Proc_Development.html"?> - -<chapter id="portlet_tools_tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/portlet_tools_tasks.xml" xreflabel="portlet_tools_tasks"> - <?dbhtml filename="portlet_tools_tasks.html"?> - <title>JBoss Portlet Tools Tasks</title> - - -<section id="starting_project" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/starting_project.xml"> - <title>Creating and Deploying a Java Portlet</title> - - <para>This chapter shows how to create a Dynamic Web Project, add a Java - Portlet to it and deploy it to the <property moreinfo="none">JBoss Portal</property>.</para> - - <section id="jboss_core_portlet"> - <title>Creating a Web Project with JBoss Portlet Capabilities</title> - <para>Fallow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>Go to <emphasis> - <property moreinfo="none">File > New > Dynamic Web Project</property> - </emphasis> if you are in the <property moreinfo="none">Web</property> perspective or <emphasis><property moreinfo="none">File > - New > Other > Web > Dynamic Web Project</property></emphasis> in any other perspective. - The <property moreinfo="none">New Dynamic Web Project</property> wizard appears.</para> - - <figure float="0"> - <title>New Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem><para>Specify the name of the project.</para></listitem> - - <listitem> - <para>Click <emphasis> - <property moreinfo="none">New</property> - </emphasis> in the <emphasis> - <property moreinfo="none">Target Runtime</property> - </emphasis> area to create a JBoss Portal runtime. Choose <emphasis> - <property moreinfo="none">JBoss Community > JBoss 4.2 Runtime</property> - </emphasis> and select the <emphasis> - <property moreinfo="none">Create a new local server</property> - </emphasis> check box below. Click <emphasis> - <property moreinfo="none">Next</property>.</emphasis></para> - - <figure float="0"> - <title>New Server Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>The <property moreinfo="none">New Server Runtime Environment</property> wizard appears. In the <emphasis> - <property moreinfo="none">Name</property></emphasis> field, type <emphasis> - <property moreinfo="none">JBoss Portal 2.7 Runtime</property>, - </emphasis> and then use the <emphasis> - <property moreinfo="none">Browse</property></emphasis> button to point to the location of JBoss Portal + JBoss AS extracted. Click <emphasis> - <property moreinfo="none">Next</property></emphasis> to proceed.</para> - - <figure float="0"> - <title>New Server Runtime Environment</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/server_runtime_environment.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>At this point a new JBoss Server instance will be created. On the next page you can verify the - runtime information defined. If something is incorrect, press <emphasis> - <property moreinfo="none">Back</property> - </emphasis> to return to the previous wizard page. Click <emphasis> - <property moreinfo="none">Finish</property>.</emphasis></para> - - <figure float="0"> - <title>Target Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>Click <emphasis> - <property moreinfo="none">Modify</property> - </emphasis> in the <emphasis><property moreinfo="none">Configuration</property></emphasis> area to enable - a portlet facet for the project.</para> - - <figure float="0"> - <title>Setting the Project Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>In the <property moreinfo="none">Project Facets</property> dialog, check <emphasis> - <property moreinfo="none">JBoss Core Portlet</property> - </emphasis> and press <emphasis> - <property moreinfo="none">OK</property> - </emphasis>.</para> - - <figure float="0"> - <title>Enabling the JBoss Core Portlet Facet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_4_a.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - <para>If the portlet libraries aren't available in the runtime you targeted, - <emphasis> - <property moreinfo="none">JBoss Portlets</property></emphasis> facets will be hidden on this page.</para> - <para>To make them always visible no matter what the runtime is set, you should enable the appropriate option in - <link linkend="preferences">JBoss Portlet Preferences</link>.</para> - </note> - </listitem> - - <listitem> - <para>The <property moreinfo="none">Java</property> and <property moreinfo="none">Web Module</property> pages are for configuring Java and Web modules in the project. - Here all values are set, so leave everything as it is.</para> - </listitem> - - <listitem> - <para>The last wizard page will ask you to add JBoss Portlet capabilities to the - project. Select <emphasis> - <property moreinfo="none">Portlet Target Runtime Provider</property></emphasis> and click <emphasis> - <property moreinfo="none">Finish</property></emphasis> to complete the project creation.</para> - - <figure float="0"> - <title>Including the Portlet Libraries Provided by Target Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/portlet_capabilities6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - <para>All types available under <emphasis> - <property moreinfo="none">Portlet Implementation Library</property></emphasis> are fully described in the Wiki article at: - <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para> - </note> - </listitem> - </orderedlist> - - <para>As the result, <property moreinfo="none">JBoss Portlet Tools</property> adds <emphasis> - <property moreinfo="none">JBoss Core Portlet</property></emphasis> facet to the project, - creates an empty <literal moreinfo="none">portlet.xml</literal> file and adds the JBoss Portlet library to the project classpath.</para> - - <figure float="0"> - <title>Portlet Project Structure Overview</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </section> - - <section id="adding_java_portlet"> - <title>Adding a Java Portlet to a Web Project</title> - - <para>At the previous section you have created a web project with JBoss Portlet capabilities. - The next steps will show you how to add a new Java portlet to the project.</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>Right-click the project and follow to <emphasis> - <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > Java - Portlet</property>.</emphasis></para> - - <figure float="0"> - <title>New Java Portlet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_7.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>The <property moreinfo="none">Create Portlet</property> wizard starts (for information about the wizard options, see - <link linkend="java_portlet_wizard">"Java Portlet Wizard"</link> in the guide reference). - The wizard fills in the <emphasis><property moreinfo="none">Project</property></emphasis> and <emphasis> - <property moreinfo="none">Source Folder</property></emphasis> fields for you. You should specify a Java package and a class name - (for instance, <emphasis> - <property moreinfo="none">org.example</property></emphasis> and <emphasis> - <property moreinfo="none">TestPortlet</property></emphasis>). Then click <emphasis> - <property moreinfo="none">Next</property> - </emphasis>.</para> - - <figure float="0"> - <title>Specifying Class File Destination</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_8.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem><para>You may leave the next three pages with default values, on the last one hit <emphasis> - <property moreinfo="none">Finish</property>.</emphasis></para> - </listitem> - </orderedlist> - - <para>Once a Java portlet is created, new resources are added to the project structure: a Java portlet class (<literal moreinfo="none">TestPortlet.java</literal>), - <literal moreinfo="none">default-object.xml</literal> and <literal moreinfo="none">portlet-instances.xml</literal> files and the <literal moreinfo="none">portlet.xml</literal> descriptor is updated as well.</para> - - <figure float="0"> - <title>Structure of the Project with a Java Portlet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_12.png"></imagedata> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Test Driven Process Development</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> One of the most important advantages of JBoss jBPM's lightweight approach to BPM + and workflow management is that developers can easily leverage their usual programming + skills and techniques. One of these well-known techniques is Unit Testing and Test Driven + Development. </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In this chapter we will show how developers, making use of the JBoss jBPM GPD, can use a + technique we have baptized </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Test Driven Process Development</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to create + process definitions and test their correctness. </diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> When creating the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">HellojBPM</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> project the Project Creation wizard has already put in place all the library + requirements we need to start writing the jBPM unit tests. They are contained in the jBPM + Library container and the most important of them is the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">.jar</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> file containing the core jBPM classes. While working on the project you could + find them all in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Package Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The jBPM Libraries</diffmk:wrapper></title> + + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/Test_Drive_Proc/test_driv_proc_1.png"></imagedata> </imageobject> </mediaobject> </figure> - - <para>Thus, now the project is ready to be built and deployed.</para> - </section> - - <section id="deploying_to_portal"> - <title>Deploying a Portlet to JBoss Portal</title> - - <para>You can deploy a portlet project in the way you deploy any other web application.</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>Right-click the project and do <emphasis> - <property moreinfo="none">Run As > Run On Server</property>. - </emphasis> The <property moreinfo="none">Run On Server</property> wizard starts.</para> - - <figure float="0"> - <title>Running the Java Portlet on Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/runOnServer.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>Select <emphasis><property moreinfo="none">JBoss Portal 2.7 Server</property></emphasis> created before and click <emphasis><property moreinfo="none">Next</property>.</emphasis></para> - </listitem> - - <listitem> - <para>On the <emphasis> - <property moreinfo="none">Add and Remove</property> - </emphasis> page move the created project to the right and click <emphasis> - <property moreinfo="none">Finish</property>.</emphasis></para> - - <figure float="0"> - <title>Deploying the Portlet Application</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_13.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>It will deploy the portlet application and start <property moreinfo="none">JBoss - AS</property>.</para> - </listitem> - - <listitem> - <para>Use the <emphasis>http://localhost:8080/portal/portal/default/default</emphasis> URL to see your - portlet in the browser.</para> - - <figure float="0"> - <title>Java Portlet in the Browser Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_14.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </orderedlist> - </section> - -</section> - - -<section id="jsf_portlet" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/jsf_portlet.xml"> - <title>Creating and Deploying a JSF Portlet</title> - - <para>This chapter will explain how you can configure a JSF portlet within a JSF project with JBoss Portlet capabilities - and then deploy it to <property moreinfo="none">JBoss Portal</property>.</para> - - <section id="jsf_portlet1"> - <title>Creating a JSF Project with JBoss Portlet Capabilities</title> - <para>You can create a JSF project with JBoss Portlet capabilities in two ways:</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>Create a dynamic Web project with the <emphasis><property moreinfo="none">JavaServer Faces</property></emphasis> - and <emphasis><property moreinfo="none">JBoss JSF Portlet</property></emphasis> facets enabled ( - <link linkend="create_dyn_web_proj_jsf">the steps to proceed</link>)</para> - </listitem> - <listitem><para>Or create a JSF project using the wizard JBoss JSF Tools provides, then enable - JSF and JBoss Portlet facets and add JBoss Portlet capabilities ( - <link linkend="create_jsf_proj">the steps to proceed</link>)</para></listitem> - </orderedlist> - - <para>Refer to the further sections for the procedures on how to do this.</para> - - <section id="create_dyn_web_proj_jsf"> - <title>Creating a Dynamic Web Project with the JBoss Portlet Capabilities</title> - - <para>The basic steps to create a dynamic Web project with the JBoss Portlet capabilities are as follows:</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>Start the <emphasis><property moreinfo="none">Dynamic Web Project</property></emphasis> wizard navigating to - <emphasis><property moreinfo="none">File > New > Other > Web > Dynamic Web Project</property>.</emphasis></para> - - <tip> - <title>Tip:</title> - <para>You can also select the <property moreinfo="none">Java EE</property> perspective and then go to - <emphasis><property moreinfo="none">File > New > Dynamic Web Project</property>.</emphasis></para> - </tip> - - <figure float="0"> - <title>Setting the JSF Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>Specify the project name and set the target runtime to <property moreinfo="none">JBoss Portal</property> by following the points 3, 4 and 5 in the - <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure.</para> - </listitem> - - <listitem> - <para>In the <emphasis><property moreinfo="none">Configuration</property></emphasis> - area, click <emphasis><property moreinfo="none">Modify</property></emphasis> and enable <emphasis><property moreinfo="none">JavaServer Faces</property>,</emphasis> - <emphasis><property moreinfo="none">JBoss Core Portlet</property></emphasis> and <emphasis><property moreinfo="none">JBoss JSF Portlet</property></emphasis> facets. - Hit <emphasis><property moreinfo="none">OK</property>.</emphasis></para> - - <figure float="0"> - <title>Enabling the Portlet Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>You may leave the next two wizard pages with defaults, just press <emphasis><property moreinfo="none">Next</property></emphasis> to proceed.</para> - </listitem> - - <listitem> - <para>On the <property moreinfo="none">JBoss Portlet Capabilities</property> page, select <emphasis> - <property moreinfo="none">Portlet Target Runtime Provider</property></emphasis> and click <emphasis><property moreinfo="none">Next</property>.</emphasis></para> - - <figure float="0"> - <title>JBoss Portlet Capabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - <para>All types of the portlet implementation library are described more closely in the wiki article at: - <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para> - </tip> - </listitem> - - <listitem> - <para>Next wizard page is for configuring JSF capabilities. You can leave everything as it - is here.</para> - - <figure float="0"> - <title>JSF Capabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>On the <property moreinfo="none">JBoss JSF Portlet Capabilities</property> page, select - <emphasis><property moreinfo="none">JSF Portlet Target Runtime Provider</property></emphasis> as the JSF portlet implementation library. It will - copy Portlet Bridge libraries from the server runtime to the project classpath.</para> - - <figure float="0"> - <title>JBoss JSF PortletCapabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - <para>On this page, it is also possible to add the RichFaces libraries from the RichFaces distribution by checking - <emphasis><property moreinfo="none">Add/Change Richfaces Libraries</property>.</emphasis></para> - </tip> - - <note> - <title>Note:</title> - <para>You can select the <emphasis><property moreinfo="none">JSF Portletbridge Runtime Provider</property></emphasis> type. Then it - is necessary to set the home of the Portlet Bridge distribution.</para> - <para>For information about all the JSF Portlet facet library providers, refer to the wiki article at: - <ulink url="http://community.jboss.org/wiki/PortletFacetLibraries">http://community.jboss.org/wiki/PortletFacetLibraries</ulink>.</para> - </note> - </listitem> - - <listitem> - <para>Click <emphasis><property moreinfo="none">Finish</property>.</emphasis> The project will be created in the workbench.</para> - </listitem> - </orderedlist> - </section> - - <section id="create_jsf_proj"> - <title>Creating a JSF Project and adding the JBoss Portlet Capabilities</title> - - <para>How to organize a JSF project you can find out in the <ulink url="../../jsf_tools_ref_guide/html_single/index.html#new_jsf_project">JSF Tools User Guide</ulink>. Just - remember to point the target runtime to <property moreinfo="none">JBoss Portal</property> directory location (see - how it is done for a dynamic Web project: steps 3, 4 and 5 in the - <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure).</para> - - <figure float="0"> - <title>Creating New JSF Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>To add the JBoss Portlet capabilities to the created JSF project you should complete the next steps:</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>Right-click the project and click <emphasis> - <property moreinfo="none">Properties</property> - </emphasis> to open the project <property moreinfo="none">Properties</property> sheet. Select <property moreinfo="none">Project Facets</property> - on the left and enable the <emphasis><property moreinfo="none">JavaServer Faces</property>,</emphasis> - <emphasis><property moreinfo="none">JBoss Core Portlet</property></emphasis> and <emphasis><property moreinfo="none">JBoss JSF Portlet</property></emphasis> facets.</para> - - <figure float="0"> - <title>Project Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>Notice, <emphasis> - <property moreinfo="none">"Further configuration available..."</property> - </emphasis> warning appears at the bottom of the screen. It means that next you should configure the JSF Portlet capabilities in the project. - Click the link. The <property moreinfo="none">Modify Faceted Project</property> wizard appears.</para> - </listitem> - - <listitem> - <para>Complete all wizard pages the same way as described in the steps 5, 6, 7 of the - <link linkend="jboss_core_portlet">"Creating a Dynamic Web Project with the JBoss Portlet Capabilities"</link> procedure. - Hit <emphasis><property moreinfo="none">OK</property>.</emphasis></para> - </listitem> - - <listitem> - <para>To apply the changes click <emphasis><property moreinfo="none">Apply</property></emphasis> and then - <emphasis><property moreinfo="none">OK</property></emphasis> to close the project <property moreinfo="none">Properties</property> sheet.</para> - </listitem> - </orderedlist> - </section> - </section> - - <section id="jsf_portlet_to_JSF_project"> - <title>Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">It must be noted that it is possible to change the location of the core jBPM installation + by changing the preference settings. More on this </diffmk:wrapper><link diffmk:change="added" linkend="change_core_jbpm_inst"><diffmk:wrapper diffmk:change="added">see + later</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> in this book.</diffmk:wrapper></para> - <para>The previous section has shown how to create a JSF project with JBoss Portlet and JSF Portlet capabilities enabled. Use - the following procedure to add a JSF portlet to the created project and deploy it to <property moreinfo="none">JBoss Portal</property>.</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>Call the - <property moreinfo="none">Create Portlet</property> wizard by navigating to <emphasis> - <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam - Portlet</property></emphasis> on the context menu of the project (for information about the wizard options, see - <link linkend="jsf_seam_portlet_wizard">"JSF/Seam Portlet Wizard"</link> in the guide reference).</para> - - <figure float="0"> - <title>Calling New Portlet Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - <para>As you see, the JSF and Seam Portlet wizards are merged into one. We have set the JSF - configuration for the project, so the default values in this wizard will be set as for a JSF - portlet.</para> - </tip> - </listitem> - - <listitem> - <para>Leave all the wizard pages with default values by clicking the <emphasis><property moreinfo="none">Next</property></emphasis> button, - on the last one click <emphasis><property moreinfo="none">Finish</property></emphasis> to complete the JSF portlet creation.</para> - </listitem> - - <listitem> - <para>Complete the steps described in the <link linkend="deploying_to_portal">"Deploying a Portlet to JBoss Portal"</link> procedure to - deploy a JSF portlet to <property moreinfo="none">JBoss Portal</property>. Just use the other URL to see it in the browser: - <emphasis>http://localhost:8080/portal/portal/default/JSFPortlet</emphasis>.</para> - - <figure float="0"> - <title>JSF Portlet in the Browser</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </orderedlist> - + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> With that extra knowledge on the project settings, you can create your first test. To do + this, we create the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">com.jbay</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> package in the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">test/java</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> source folder. Then we bring up the context menu on this package and select </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New > Other...</diffmk:wrapper></property> + </emphasis></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Call the JUnit Test Case Creation wizard</diffmk:wrapper></title> + + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/Test_Drive_Proc/test_driv_proc_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> And then </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Java > JUnit > JUnit Test Case</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> to call the specialized JUnite Test case creation wizard.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Call the JUnit Test Case Creation wizard</diffmk:wrapper></title> + + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/Test_Drive_Proc/test_driv_proc_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The wizard looks as follows:</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Create Test Dialog</diffmk:wrapper></title> + + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/Test_Drive_Proc/test_driv_proc_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">By default JUnit 3 version of testing framework is selected. Of course, you can choose + new advanced JUnit 4 version. In this case you'll be prompted to add new JUnit + Library to your build path. To add it automatically just click on the appropriate link. In + the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Class under test</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> section you can specify the class to test.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In this guide we will use JUnit 3 version.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">A First Test Scenario</diffmk:wrapper></title> + + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/Test_Drive_Proc/test_driv_proc_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Then, we call the test class </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">HelloTest</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> and 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"> button to complete.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Next, we should write a simple test scenario as shown on the next figure. Let's + study the code of this test case. </diffmk:wrapper></para> + + <figure diffmk:change="added" float="0" id="hello_test"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">A First Test Scenario</diffmk:wrapper></title> + + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/Test_Drive_Proc/test_driv_proc_6.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the first line of the method, a jBPM process archive object is created. We use a + constructor accepting the filename of the archive. In our case it is the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">hello</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> file we created earlier and which lives in the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">src/main/jpdl</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> folder of our project. After asserting that this object is really created, we + extract a process definition object from it. This object is fed to the constructor of a + process instance object. We have a process instance object, but this process is not yet + started, so we can safely assert that its root token still resides in the start node. After + signalling the token will move to the next state and the process will be in the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">auction</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> state. Finally another signal will end the process. </diffmk:wrapper></para> + + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> After writing this test we can check whether it works as expected by running it .</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Running the Process Test</diffmk:wrapper></title> + + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/Test_Drive_Proc/test_driv_proc_7.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All went well as we have a green light:</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Successful Test Run</diffmk:wrapper></title> + + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/Test_Drive_Proc/test_driv_proc_8.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Of course, this simple scenario was not very interesting, but the purpose of it was to + show how you can reuse your development skills in a very straightforward way when doing + process development. To see how more interesting processes and process test + scenario's can be developed, we suggest you to read the </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.com/jbpm/v3/userguide/"><diffmk:wrapper diffmk:change="added">JBoss jBPM User Guide</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> and to + study the API reference. You can find it in the jBPM download folder. (To get started we + downloaded jbpm-jpdl-3.2.2 in </diffmk:wrapper><link diffmk:change="added" linkend="jboss_jbpm_runtime_installation"><diffmk:wrapper diffmk:change="added">the second + chapter</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">. You should just remember where you extracted it.) All we've mentioned are in the 'javadoc- *' subfolders of the 'doc' folder. + Moreover, some more examples will be given later in this book.</diffmk:wrapper></para> + </section> -</section> - - -<section id="seam_portlet" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/seam_portlet.xml"> - <title>Creating and Deploying a Seam Portlet</title> - - <para>This chapter covers the steps on how to configure a Seam portlet within a Seam - project with the help of the <property moreinfo="none">JBoss Portlet Tools</property> features.</para> - <section id="seam_portlet1"> - <title>Creating a Seam Project with JBoss Portlet Capabilities</title> +</chapter> - <para>Follow one of two ways of creating a Seam project with JBoss Portlet capabilities enabled:</para> - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>Create a dynamic Web project with the <emphasis><property moreinfo="none">Seam</property></emphasis> - and <emphasis><property moreinfo="none">JBoss Portlets</property></emphasis> facets enabled (<link linkend="create_dyn_web_proj_seam">the steps to proceed</link>)</para> - </listitem> - <listitem><para>Or create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides - and follow all the wizard steps to enable JBoss Portlet capabilities (<link linkend="create_seam_proj">the steps to proceed</link>)</para></listitem> - </orderedlist> - - <section id="create_dyn_web_proj_seam"> - <title>Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</title> - - <para>To create a dynamic Web project with Seam and JBoss Portlet capabilities you should take the following steps:</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>In the <emphasis><property moreinfo="none">File</property></emphasis> menu, go to - <emphasis><property moreinfo="none">New > Other > Web > Dynamic Web Project</property>.</emphasis> The <property moreinfo="none">New Dynamic Web Project</property> - wizard starts.</para> - - <figure float="0"> - <title>Creating a New Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>Give the project a name and follow the steps 3, 4, 5 of the - <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure to set the target runtime.</para> - </listitem> - - <listitem> - <para>In the <emphasis><property moreinfo="none">Configuration</property></emphasis> area of the first wizard page, - select <emphasis> - <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project.</para> - - <tip> - <title>Tip:</title> - <para>If you now click the <emphasis><property moreinfo="none">Modify</property></emphasis> button, you should see the - <emphasis><property moreinfo="none">JavaServer Faces</property>,</emphasis> <emphasis><property moreinfo="none">Jboss Portlets</property></emphasis> - and <emphasis><property moreinfo="none">Seam</property></emphasis> facets enabled.</para> - </tip> - - <figure float="0"> - <title>Project Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>The next two pages are for adjusting the project Java and Web modules. - They include the default values, so you can skip them by pressing <emphasis> - <property moreinfo="none">Next</property>.</emphasis></para> - </listitem> - - <listitem> - <para>On the <property moreinfo="none">Jboss Portlet Capabilities</property> page, select - <emphasis><property moreinfo="none">Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library.</para> - - <tip> - <title>Tip:</title> - <para>All types of the portlet implementation library are described more closely in the wiki article at: - <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para> - </tip> - </listitem> - - <listitem> - <para>The next page is for configuring JSF capabilities. As it contains the default values, just click - <emphasis><property moreinfo="none">Next</property></emphasis> to proceed.</para> - </listitem> - - <listitem> - <para>On the <property moreinfo="none">Seam Facet</property> page, set a Seam runtime and - a connection profile.</para> - - <tip> - <title>Tip:</title> - <para>For details about how to set a Seam runtime and a connection profile, see - <ulink url="../../seam/html_single/index.html#seamFacet">"Configure Seam Facet Settings"</ulink> in the Chapter 2, - <ulink url="../../seam/html_single/index.html">"Seam Dev Tools Reference Guide"</ulink>.</para> - </tip> - - <figure float="0"> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>On the <property moreinfo="none">JBoss JSF Portlet Capabilities</property> page, select the - <emphasis><property moreinfo="none">JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library.</para> - - <tip> - <title>Tip:</title> - <para>If you have <property moreinfo="none">JBoss Portlet Bridge</property> downloaded, - alternatively you can select <emphasis><property moreinfo="none">JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to - the <property moreinfo="none">JBoss Portlet Bridge</property> distribution.</para> - </tip> - - <figure float="0"> - <title>Setting Portlet Bridge Provider</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>It will add <property moreinfo="none">JBoss Portlet Bridge</property> libraries to the project classpath.</para> - </listitem> - - <listitem> - <para>Hit <emphasis><property moreinfo="none">Finish</property></emphasis> to complete the project creation.</para> - </listitem> - </orderedlist> - </section> - - <section id="create_seam_proj"> - <title>Creating a Seam Project with JBoss Portlet Capabilities</title> - - <para>The steps to create a Seam project with JBoss Portlet capabilities are as follows:</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>In the <emphasis><property moreinfo="none">File</property></emphasis> menu, go to <emphasis> - <property moreinfo="none">New > Other > Seam > Seam Web Project</property>.</emphasis> The <property moreinfo="none">New Seam Project</property> - wizard appears.</para> - </listitem> - - <listitem> - <para>Next steps are the same as in the <link linkend="create_dyn_web_proj_seam">"Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities"</link> - procedure starting from the step 2.</para> - </listitem> - </orderedlist> - </section> - </section> - <section id="seam_portlet_to_seam_project"> - <title>Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</title> - - <para>The previous section has shown you how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet - and deploy it to <property moreinfo="none">JBoss Portal</property> by following the next procedure:</para> - - <orderedlist continuation="restarts" inheritnum="ignore"> - <listitem> - <para>In the <emphasis><property moreinfo="none">File</property></emphasis> or context menu of the project go to - <emphasis><property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam - Portlet</property>.</emphasis></para> - - <figure float="0"> - <title>Calling the Create Portlet Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>The <property moreinfo="none">Create Portlet</property> wizard starts (for more information about wizard options, see - <link linkend="jsf_seam_portlet_wizard">"JSF/Seam Portlet Wizard"</link> in the guide reference). - As the Seam configuration is set for the project, the wizard puts the values as for Seam portlet.</para> - - <figure float="0"> - <title>Creating Seam Portlet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>Next two pages are filled out with default values, just press <emphasis><property moreinfo="none">Next</property></emphasis> to - proceed. On the last one click <emphasis><property moreinfo="none">Finish</property></emphasis> to complete.</para> - </listitem> - - <listitem> - <para>To deploy and run the portlet on <property moreinfo="none">JBoss Portal</property> complete the steps described in the - <link linkend="deploying_to_portal">"Deploying a Portlet to JBoss Portal"</link> procedure. Just use the following URL to see it in the browser: - <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>.</para> - - <figure float="0"> - <title>Seam Portlet in the Browser Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet7.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </orderedlist> - </section> -</section> - +<chapter id="portlet_tools_tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en-US/portlet_tools_tasks.xml" xreflabel="portlet_tools_tasks"> + <?dbhtml filename="portlet_tools_tasks.html"?> + <title>JBoss Portlet Tools Tasks</title> + + <xi:include href="starting_project.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <xi:include href="jsf_portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="seam_portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + </chapter> + -<chapter id="reference" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/reference.xml" xreflabel="reference"> +<chapter id="reference" xreflabel="reference"> <?dbhtml filename="reference.html"?> <title>Reference</title> @@ -1640,7 +1034,7 @@ </section> </chapter> -<chapter id="summary" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/summary.xml" xreflabel="summary"> +<chapter id="summary" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en-US/summary.xml" xreflabel="summary"> <?dbhtml filename="summary.html"?> <title>Summary</title> @@ -1649,7 +1043,6 @@ The above chapters walked you through the steps on how to organize a web project with JBoss Portlet capabilities enabled, create a Java portlet, JSF or Seam portlet and deploy them to <property moreinfo="none">JBoss Portal</property>. The document also includes the reference of <property moreinfo="none">JBoss Portlet Tools</property> features.</para> - <para>If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome to <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users forum</ulink>.</para> Modified: tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/portlet_tools_tasks.xml =================================================================== --- tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/portlet_tools_tasks.xml 2010-06-08 23:43:43 UTC (rev 22650) +++ tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/portlet_tools_tasks.xml 2010-06-08 23:45:39 UTC (rev 22651) @@ -5,6 +5,8 @@ <xi:include href="starting_project.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="jsf_portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="seam_portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - -</chapter> \ No newline at end of file +<xi:include href="seam_portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + +</chapter> Modified: tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/seam_portlet.xml =================================================================== --- tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/seam_portlet.xml 2010-06-08 23:43:43 UTC (rev 22650) +++ tags/jbosstools-3.1.1.GA/portlet/docs/reference/en-US/seam_portlet.xml 2010-06-08 23:45:39 UTC (rev 22651) @@ -95,7 +95,7 @@ <tip> <title>Tip:</title> <para>For details about how to set a Seam runtime and a connection profile, see - Configure Seam Facet Settings in the Chapter 2, + Configure Seam Facet Settings in the Chapter 2 of the Seam Dev Tools Reference Guide.</para> </tip>

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22650 - in tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US: images/plugins and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 19:43:43 -0400 (Tue, 08 Jun 2010) New Revision: 22650 Added: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/images/plugins/plugins.xml Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/introduction.xml tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/plugins.xml Log: updated for 3.0.1 Added: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/images/plugins/plugins.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/images/plugins/plugins.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/images/plugins/plugins.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -0,0 +1,2569 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="plugins" role="updated"> + <title>Eclipse Plugins</title> + <para>This chapter will introduce you to the functionality that <property>Hibernate + Tools</property> provide within Eclipse. That is a set of wizards and editors for simplifying + the work with <property>Hibernate</property>.</para> + <section> + <title>Introduction</title> + <para>Hibernate Eclipse Tools include wizards for creating Hibernate mapping files, + configuration files (.cfg.xml), revenge.xml as well as wizards for adjusting Console + Configuration and Code Generation. Special structured and XML editors, editors for executing + HQL and Criteria queries are also provided in Hibernate Console. Refer to <link + linkend="hibernate_key_features">Key Features</link> section to find all benefits that you + can take advantage of while using the tools within Eclipse.</para> + <note> + <title>Note:</title> + <para>Please note that these tools do not try to hide any functionality of <property + >Hibernate</property>. The tools make working with <property>Hibernate</property> easier, + but you are still encouraged/required to read the <ulink + url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink> to fully utilize + <property>Hibernate Tools</property> and especially <property>Hibernate</property> it + self.</para> + </note> + </section> + <section id="map_file_wizard"> + <title>Creating a Hibernate Mapping File</title> + <para>Hibernate mapping files are used to specify how your objects are related to database + tables.</para> + <para>To create basic mappings for properties and associations, i. e. generate <emphasis> + <property>.hbm.xml</property> + </emphasis> files, Hibernate Tools provide a basic wizard which you can bring up by navigating + <emphasis> + <property>New > Hibernate XML mapping file</property>.</emphasis></para> + <para>At first you'll be asked to select a package or multiple individual classes to map. + It's also possible to create an empty file, don't select any packages or classes and an + empty .hbm will be created in the specified location</para> + <para id="depth_control">With <property>depth control</property> option you can define dependences depth for + choosing classes (it means to set level of references which is used to collect linked classes + to the selection). </para> + <figure> + <title>Hibernate XML Mapping File Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The next wizard page lists the mappings to be generated. As you see <property>Customers</property>, <property>Orders</property>, <property>Productlines</property> and <property>Products</property> classes added under <property>depth control</property> driving. </para> + <figure> + <title>Mappings to be generated</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0_a.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>This wizard page outputs a generated .hbm files preview.</para> + <figure> + <title>Preview Generated Mapping Files</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0_b.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Pressing <property>Finish</property> creates the files.</para> + </section> + <section id="hib_config_file"> + <title>Creating a Hibernate Configuration File</title> + <para>To be able to reverse engineer, prototype queries, and of course to simply use <property + >Hibernate Core</property> a <emphasis> + <property>hibernate.properties</property> + </emphasis> or <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> file is needed. The <property>Hibernate Tools</property> provide a wizard for + generating the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> file if you do not already have such one.</para> + <para>Start the wizard by clicking <emphasis> + <property>New > Other (Ctrl+N)</property> + </emphasis>, then <emphasis> + <property>Hibernate > Hibernate Configuration File (cfg.xml)</property> + </emphasis> and press <emphasis> + <property>Next</property> + </emphasis> or on a web Seam project in the <property>Web Projects</property> view <emphasis> + <property> WebContent -> New -> File -> Hibernate Configuration 3.0</property> + </emphasis>. After selecting the wanted location for the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> file, you will see the following page:</para> + <figure> + <title>Hibernate Configuration File Wizard</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>The contents in the combo boxes for the JDBC driver class and JDBC URL change + automatically, depending on the Dialect and actual driver you have chosen.</para> + </note> + <para>Enter your configuration information in this dialog. Details about the configuration + options can be found in <ulink + url="http://docs.jboss.org/ejb3/app-server/Hibernate3/reference/en/html_single">Hibernate + Reference Documentation</ulink>.</para> + <para>Press <emphasis> + <property>Finish</property> + </emphasis> to create the configuration file, after optionally creating a Console + configuration, the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> will be automatically opened in an editor. The last option <emphasis> + <property>Create Console Configuration</property> + </emphasis> is enabled by default and when enabled, it will automatically use the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> for the basis of a Console configuration.</para> + </section> + <section id="console_conf"> + <title>Hibernate Console Configuration</title> + <para>A Console configuration describes how the <property>Hibernate plugin</property> should + configure <property>Hibernate</property> and what configuration files, including which + classpath are needed to load the POJO's, JDBC drivers etc. It is required to make usage of + query prototyping, reverse engineering and code generation. You can have multiple named + console configurations. Normally you would just need one per project, but more is definitely + possible if your project requires this.</para> + <section id="creat_console_conf"> + <title>Creating a Hibernate Console Configuration</title> + <para>You create a console configuration by running the <property>Console Configuration + Wizard</property>, shown in the following screenshot. The same wizard will also be used if + you are coming from the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> wizard and had enabled <emphasis> + <property>Create Console Configuration</property> + </emphasis>.</para> + <note> + <title>Note:</title> + <para>The wizard will look at the current selection in the IDE and try and auto-detect the + settings which you then can just approve or modify to suit your needs.</para> + </note> + <para/> + <para>The dialog consists of five tabs: </para> + <itemizedlist> + <listitem> + <para><emphasis> + <property>Main</property> + </emphasis> for the basic/required settings</para> + </listitem> + </itemizedlist> + <figure> + <title> Creating Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The following table describes the available settings on the <emphasis> + <property>Main</property> + </emphasis> tab. The wizard can automatically detect default values for most of these if you + started the wizard with the relevant java project or resource selected.</para> + <table> + <title>Hibernate Console Configuration Parameters</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <thead> + <row> + <entry align="center"> + <para>Parameter</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + <entry align="center"> + <para>Auto detected value</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Name</para> + </entry> + <entry> + <para>The unique name of the console configuration</para> + </entry> + <entry> + <para>Name of the selected project</para> + </entry> + </row> + <row> + <entry> + <para>Type</para> + </entry> + <entry> + <para>Choose between "Core", "Annotations" and "JPA". + Note that the two latter requires running Eclipse IDE with a JDK 5 runtime, + otherwise you will get classloading and/or version errors.</para> + </entry> + <entry> + <para>No default value</para> + </entry> + </row> + <row> + <entry> + <para>Project</para> + </entry> + <entry> + <para>The name of a java project which classpath should be used in the console + configuration</para> + </entry> + <entry> + <para>Name of the selected project</para> + </entry> + </row> + <row> + <entry> + <para>Database connection</para> + </entry> + <entry> + <para>DTP provided connection that you can use instead of what is in cfg.xml and jpa + persistence.xml. It's possible to use either already configured hibernate or + JPA connection or specify a new one here.</para> + </entry> + <entry> + <para>[Hibernate Configured connection]</para> + </entry> + </row> + <row> + <entry> + <para>Property file</para> + </entry> + <entry> + <para>Path to a hibernate.properties file</para> + </entry> + <entry> + <para>First hibernate.properties file found in the selected project</para> + </entry> + </row> + <row> + <entry> + <para>Configuration file</para> + </entry> + <entry> + <para>Path to a hibernate.cfg.xml file</para> + </entry> + <entry> + <para>First hibernate.cfg.xml file found in the selected project</para> + </entry> + </row> + <row> + <entry> + <para>Persistence unit</para> + </entry> + <entry> + <para>Name of the persistence unit to use</para> + </entry> + <entry> + <para>No default value (lets Hibernate Entity Manager find the persistence unit or + it can be defined manually using Browse button)</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <tip> + <title>Tip:</title> + <para>The two latter settings are normally not required if you specify a project and it has + <emphasis> + <property> + <literal> /hibernate.cfg.xml </literal> + </property> + </emphasis> or <emphasis> + <property> + <literal>/META-INF/persistence.xml</literal> + </property> + </emphasis> in its project classpath.</para> + </tip> + <itemizedlist> + <listitem> + <para> + <emphasis> + <property>Options</property> + </emphasis> for the additional/optional settings</para> + </listitem> + </itemizedlist> + <figure> + <title>Options Tab of the Console Configuration Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_2_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The next table describes Hibernate Console Configuration options available on the + <emphasis> + <property>Options</property> + </emphasis> tab.</para> + <table> + <title>Hibernate Console Configuration Options</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <thead> + <row> + <entry align="center"> + <para>Parameter</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + <entry align="center"> + <para>Auto detected value</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Database dialect</para> + </entry> + <entry> + <para>Define a database dialect. It's possible either to write your value or choose + from list. </para> + </entry> + <entry> + <para>No default value</para> + </entry> + </row> + <row> + <entry> + <para>Naming strategy</para> + </entry> + <entry> + <para>Fully qualified classname of a custom NamingStrategy. Only required if you use + a special naming strategy.</para> + </entry> + <entry> + <para>No default value</para> + </entry> + </row> + <row> + <entry> + <para>Entity resolver</para> + </entry> + <entry> + <para>Fully qualified classname of a custom EntityResolver. Only required if you + have special xml entity includes in your mapping files.</para> + </entry> + <entry> + <para>No default value</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <itemizedlist> + <listitem> + <para><emphasis> + <property>Classpath</property> + </emphasis> for classpath</para> + </listitem> + </itemizedlist> + <figure> + <title>Specifying Classpath in Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The following table specifies the parameters of the Classpath tab of the wizard.</para> + <table> + <title>Hibernate Console Configuration Classpath</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" colwidth="1*"/> + <thead> + <row> + <entry align="center"> + <para>Parameter</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + <entry align="center"> + <para>Auto detected value</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Classpath</para> + </entry> + <entry> + <para>The classpath for loading POJO and JDBC drivers; only needed if the default + classpath of the Project does not contain the required classes. Do not add + Hibernate core libraries or dependencies, they are already included. If you get + ClassNotFound errors then check this list for possible missing or redundant + directories/jars.</para> + </entry> + <entry> + <para>Empty</para> + </entry> + </row> + <row> + <entry> + <para>Include default classpath from project</para> + </entry> + <entry> + <para>When enabled the project classpath will be appended to the classpath specified + above</para> + </entry> + <entry> + <para>Enabled</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <itemizedlist> + <listitem> + <para><emphasis> + <property>Mappings</property> + </emphasis> for additional mappings</para> + </listitem> + </itemizedlist> + <figure> + <title>Specifying additional Mappings in Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>Parameters of the Mappings tab of the <property>Hibernate Console Configuration + wizard</property> are explained below:</para> + <table> + <title>Hibernate Console Configuration Mappings</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" colwidth="1*"/> + <thead> + <row> + <entry align="center"> + <para>Parameter</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + <entry align="center"> + <para>Auto detected value</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Mapping files </para> + </entry> + <entry> + <para>List of additional mapping files that should be loaded. Note: A + hibernate.cfg.xml or persistence.xml can also contain mappings. Thus if these are + duplicated here, you will get "Duplicate mapping" errors when using the console + configuration.</para> + </entry> + <entry> + <para>empty</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <itemizedlist> + <listitem> + <para>and the last tab <emphasis> + <property>Common</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Common Tab of the Console Configuration Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>It allows to define general aspects of the launch configuration including storage + location, console encoding and some others.</para> + <para>Clicking <emphasis> + <property>Finish</property> + </emphasis> creates the configuration and shows it in the <property>Hibernate Configurations + view</property>.</para> + <figure> + <title>Console Overview</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="modif_console_conf"> + <title>Modifying a Hibernate Console Configuration </title> + <para>When you created a hibernate console configuration you can modify it in 2 ways: </para> + <itemizedlist> + <listitem> + <para>right click on the configuration in <emphasis> + <property>Hibernate Configurations View->Edit Configuration </property> + </emphasis> or just double click on <property>Console Configuration</property> item.</para> + <figure> + <title>Opening Edit Configuration Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_c.png"/> + </imageobject> + </mediaobject> + </figure> + <para> After clicking you will see the Edit Configuration Wizard that is similar to + <emphasis> + <property>Create Console Configuration</property> + </emphasis>,described in <link linkend="creat_console_conf">Creating a Hibernate Console + Configuration section</link>. </para> + </listitem> + <listitem> + <para>use Properties view for modifying some of Console Configuration properties.</para> + <figure> + <title>Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_b.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The following table describes the available settings in the Properties view. Most + properties are changeable by left click but some are not. <table> + <title>Properties</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <thead> + <row> + <entry align="center"> + <para>Property</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + <entry align="center"> + <para>Is Changeable</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Additional mapping files </para> + </entry> + <entry> + <para>List of additional mapping files that should be loaded. </para> + </entry> + <entry> + <para>False</para> + </entry> + </row> + <row> + <entry> + <para>Configuration file</para> + </entry> + <entry> + <para>Path to a hibernate.cfg.xml file</para> + </entry> + <entry> + <para>False</para> + </entry> + </row> + <row> + <entry> + <para>Connection</para> + </entry> + <entry> + <para>DTP provided connection that you can use instead of what is in cfg.xml + and jpa persistence.xml. It's possible to use either already configured + hibernate or JPA connection or specify a new one here.</para> + </entry> + <entry> + <para>True</para> + </entry> + </row> + <row> + <entry> + <para>Name</para> + </entry> + <entry> + <para>The unique name of the console configuration</para> + </entry> + <entry> + <para>True</para> + </entry> + </row> + <row> + <entry> + <para>Project</para> + </entry> + <entry> + <para>The name of a java project which classpath should be used in the console + configuration</para> + </entry> + <entry> + <para>True</para> + </entry> + </row> + <row> + <entry> + <para>Properties file</para> + </entry> + <entry> + <para>Path to a hibernate.properties file</para> + </entry> + <entry> + <para>False</para> + </entry> + </row> + <row> + <entry> + <para>Type</para> + </entry> + <entry> + <para>Choose between "CORE", "ANNOTATIONS" and + "JPA" according to the method of relational mapping you want to + use. Note that the two latter requires running Eclipse IDE with a JDK 5 + runtime, otherwise you will get classloading and/or version errors.</para> + </entry> + <entry> + <para>True</para> + </entry> + </row> + </tbody> + </tgroup> + </table></para> + </listitem> + </itemizedlist> + </section> + <section id='closing_conf_config'> + <title>Closing Hibernate Console Configuration</title> + <para>To close <property>Hibernate Console Configuration</property> you need do right click your configuration + and choose <property>Close Configuration</property> option </para> + <figure> + <title>Close Hibernate Console Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_d.png"/> + </imageobject> + </mediaobject> + </figure> + <para>While closing configuration the connection with database will be closed, jar libs will + be unlock (for Windows) and other resources will set as free. </para> + </section> + </section> + <section id="refeng_codegen" role="updated"> + <title>Reverse Engineering and Code Generation</title> + <para>A "click-and-generate" reverse engineering and code generation facility is + available. This facility allows you to generate a range of artifacts based on database or an + already existing Hibernate configuration, be that mapping files or annotated classes. Some of + these are POJO Java source file, Hibernate <emphasis> + <property>.hbm.xml</property> + </emphasis>, <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> generation and schema documentation.</para> + <para>To start working with this process, start the <property>Hibernate Code + Generation</property> which is available in the toolbar via the <property + >Hibernate</property> icon or via the <emphasis> + <property>Run > Hibernate Code Generation</property> + </emphasis> menu item.</para> + <section id="code_gen"> + <title>Code Generation Launcher</title> + <para>When you click on <emphasis> + <property>Open Hibernate Code Generation Dialog...</property> + </emphasis> the standard Eclipse launcher dialog will appear. In this dialog you can create, + edit and delete named Hibernate code generation "launchers".</para> + <figure id="hib_code_gen"> + <title>Getting Hibernate Code Generation Wizard</title> + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/plugins/plugins_6.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_6.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para/> + <figure> + <title>Hibernate Code Generation Wizard</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_7.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_7.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The first time you create a code generation launcher you should give it a meaningful + name, otherwise the default prefix <emphasis> + <property>New_Generation</property> + </emphasis> will be used.</para> + <tip> + <title>Tip:</title> + <para>The "At least one exporter option must be selected" is just a warning + stating that for this launch to work you need to select an exporter on the Exporter tab. + When an exporter has been selected the warning will disappear.</para> + </tip> + <para>The dialog also have the standard tabs <emphasis> + <property>Refresh</property> + </emphasis> and <emphasis> + <property>Common</property> + </emphasis> that can be used to configure which directories should be automatically + refreshed and various general settings launchers, such as saving them in a project for + sharing the launcher within a team.</para> + <para>On the <emphasis> + <property>Main</property> + </emphasis> tab you see the following fields:</para> + <table> + <title>Code generation "Main" tab fields</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" colwidth="0.5*"/> + <thead> + <row> + <entry align="center"> + <para>Field</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Console Configuration</para> + </entry> + <entry> + <para>The name of the console configuration which should be used when code + generating</para> + </entry> + </row> + <row> + <entry> + <para>Output directory</para> + </entry> + <entry> + <para>Path to a directory where all output will be written by default. It's possible + to enter absolute directory path, for example - "d:/temp". Be aware that existing + files will be overwritten, so be sure to specify the correct directory.</para> + </entry> + </row> + <row> + <entry> + <para>Reverse engineer from JDBC Connection</para> + </entry> + <entry> + <para>If enabled, the tools will reverse engineer the database available via the + connection information in the selected Hibernate Console Configuration and + generate code based on the database schema. If not enabled, the code generation + will just be based on the mappings already specified in the Hibernate Console + configuration.</para> + </entry> + </row> + <row> + <entry> + <para>Package</para> + </entry> + <entry> + <para>The package name here is used as the default package name for any entities + found when reverse engineering</para> + </entry> + </row> + <row> + <entry> + <para>reveng.xml</para> + </entry> + <entry> + <para>Path to a reveng.xml file. A reveng.xml file allows you to control certain + aspects of the reverse engineering. e.g. how jdbc types are mapped to hibernate + types and especially important which tables are included/excluded from the + process. Clicking "setup" allows you to select an existing reveng.xml file or + create a new one. See more details about the reveng.xml file in <xref + linkend="reverseengineering"/>.</para> + </entry> + </row> + <row> + <entry> + <para>reveng. strategy</para> + </entry> + <entry> + <para>If reveng.xml does not provide enough customization you can provide your own + implementation of an ReverseEngineeringStrategy. The class needs to be in the + classpath of the Console Configuration, otherwise you will get class not found + exceptions. See <xref linkend="custom-reveng-strategy"/> for details and an + example of a custom strategy.</para> + </entry> + </row> + <row> + <entry> + <para>Generate basic typed composite ids</para> + </entry> + <entry> + <para>A table that has a multi-column primary key a <composite-id> mapping + will always be created. If this option is enabled and there are matching + foreign-keys each key column is still considered a 'basic' scalar (string, long, + etc.) instead of a reference to an entity. If you disable this option a + <code><key-many-to-one></code> instead. Note: a + <code><many-to-one></code> property is still created, but is simply marked + as non-updatable and non-insertable.</para> + </entry> + </row> + <row> + <entry> + <para>Detect optimistic lock columns</para> + </entry> + <entry> + <para>Automatically detect optimistic lock columns. Controllable via reveng. + strategy; the current default is to use columns named VERSION or TIMESTAMP.</para> + </entry> + </row> + <row> + <entry> + <para>Detect many-to-many tables</para> + </entry> + <entry> + <para>Automatically detect many-to-many tables. Controllable via reveng. + strategy.</para> + </entry> + </row> + <row> + <entry> + <para>Detect one-to-one associations</para> + </entry> + <entry> + <para> Reverse engineering detects one-to-one associations via primary key and both + hbm.xml and annotation generation generates the proper code for it. </para> + <para> The detection is enabled by default (except for Seam 1.2 and Seam 2.0) + reverse engineering. For Hibernate Tools generation there is a checkbox to disable + if not wanted. </para> + </entry> + </row> + <row> + <entry> + <para>Use custom templates</para> + </entry> + <entry> + <para>If enabled, the Template directory will be searched first when looking up the + templates, allowing you to redefine how the individual templates process the + hibernate mapping model.</para> + </entry> + </row> + <row> + <entry> + <para>Template directory</para> + </entry> + <entry> + <para>A path to a directory with custom templates</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + <section id="exportes"> + <title>Exporters</title> + <para>The <emphasis> + <property>Exporters</property> + </emphasis> tab is used to specify which type of code that should be generated. Each + selection represents an Exporter that is responsible for generating the code, hence the + name.</para> + <figure> + <title>Selecting Exporters</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_8.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_8.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The following table describes in short the various exporters. Remember you can + add/remove any Exporters depending on your needs.</para> + <table> + <title>Code generation "Exporter" tab fields</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <thead> + <row> + <entry align="center"> + <para>Field</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Domain code</para> + </entry> + <entry> + <para>Generates POJO's for all the persistent classes and components found in the + given Hibernate configuration.</para> + </entry> + </row> + <row> + <entry> + <para>DAO code</para> + </entry> + <entry> + <para>Generates a set of DAO's for each entity found.</para> + </entry> + </row> + <row> + <entry> + <para>Hibernate XML Mappings</para> + </entry> + <entry> + <para>Generate mapping (hbm.xml) files for each entity.</para> + </entry> + </row> + <row> + <entry> + <para>Hibernate XML Configuration</para> + </entry> + <entry> + <para>Generate a hibernate.cfg.xml file. Used to keep the hibernate.cfg.xml update + with any new found mapping files.</para> + </entry> + </row> + <row> + <entry> + <para>Schema Documentation (.html)</para> + </entry> + <entry> + <para>Generates a set of html pages that documents the database schema and some of + the mappings.</para> + </entry> + </row> + <row> + <entry> + <para>Generic Exporter (hbmtemplate)</para> + </entry> + <entry> + <para>Fully customizable exporter which can be used to perform custom + generation.</para> + </entry> + </row> + <row> + <entry> + <para>Schema Export (.ddl)</para> + </entry> + <entry> + <para>Generates the appropriate SQL DDL and allows you to store the result in a file + or export it directly to the database.</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <para>Each Exporter listens to certain properties and these can be setup in the <emphasis> + <property>Properties</property> + </emphasis> section where you can add/remove predefined or customer properties for each of + the exporters. The following table lists the time of writing predefined properties:</para> + <para> + <table> + <title>Exporter Properties</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>jdk5</para> + </entry> + <entry> + <para>Generate Java 5 syntax</para> + </entry> + </row> + <row> + <entry> + <para>ejb3</para> + </entry> + <entry> + <para>Generate EJB 3 annotations</para> + </entry> + </row> + <row> + <entry> + <para>for_each</para> + </entry> + <entry> + <para>Specifies for which type of model elements the exporter should create a file + and run through the templates. Possible values are: entity, component, + configuration</para> + </entry> + </row> + <row> + <entry> + <para>template_path</para> + </entry> + <entry> + <para>Custom template directory for this specific exporter. You can use Eclipse + variables.</para> + </entry> + </row> + <row> + <entry> + <para>template_name</para> + </entry> + <entry> + <para>Name for template relative to the template path</para> + </entry> + </row> + <row> + <entry> + <para>outputdir</para> + </entry> + <entry> + <para>Custom output directory for this specific exporter. You can use Eclipse + variables.</para> + </entry> + </row> + <row> + <entry> + <para>file_pattern</para> + </entry> + <entry> + <para>Pattern to use for the generated files, relatively for the output dir. + Example: {package-name}/{class-name}.java .</para> + </entry> + </row> + <row> + <entry> + <para>dot.executable</para> + </entry> + <entry> + <para>Executable to run GraphViz (only relevant, but optional for Schema + documentation)</para> + </entry> + </row> + <row> + <entry> + <para>drop</para> + </entry> + <entry> + <para>Output will contain drop statements for the tables, indices and + constraints</para> + </entry> + </row> + <row> + <entry> + <para>delimiter</para> + </entry> + <entry> + <para>If specified the statements will be dumped to this file</para> + </entry> + </row> + <row> + <entry> + <para>create</para> + </entry> + <entry> + <para>Output will contain create statements for the tables, indices and + constraints</para> + </entry> + </row> + <row> + <entry> + <para>scriptToConsole</para> + </entry> + <entry> + <para>The script will be output to Console</para> + </entry> + </row> + <row> + <entry> + <para>exportToDatabase</para> + </entry> + <entry> + <para>Executes the generated statements against the database</para> + </entry> + </row> + <row> + <entry> + <para>outputFileName</para> + </entry> + <entry> + <para>If specified the statements will be dumped to this file</para> + </entry> + </row> + <row> + <entry> + <para>haltOnError</para> + </entry> + <entry> + <para>Halts the build process if an error occurs</para> + </entry> + </row> + <row> + <entry> + <para>format</para> + </entry> + <entry> + <para>Applies basic formatting to the statements</para> + </entry> + </row> + <row> + <entry> + <para>schemaUpdate</para> + </entry> + <entry> + <para>Updates a schema</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para>To add a property to the chosen Exporter click the <emphasis> + <property>Add</property> + </emphasis> button in the <property>Properties</property> section. In the appeared dialog + you should select the property from the proposed list and the value for it.</para> + <figure> + <title>Adding the Property for Schema Export (.ddl)</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_8a.png"/> + </imageobject> + </mediaobject> + </figure> + <tip> + <title>Tip:</title> + <para>If the property is a directory, it is possible to browse directories in the Value + field.</para> + </tip> + <figure> + <title>Specifying the Property Value</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_8b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="map_config_editor"> + <title>Hibernate Mapping and Configuration File Editor</title> + <para>The <property>Hibernate Mapping File editor</property> provides XML editing functionality + for the <emphasis> + <property>hbm.xml </property> + </emphasis> and <emphasis> + <property>cfg.xml</property> + </emphasis> files. The editor is based on the Eclipse WTP tools and extends its functionality + to provide Hibernate specific code completion.</para> + <figure> + <title>XML Editing Functionality</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_9.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_9.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <section> + <title>Java property/class completion</title> + <para>Package, class, and field completion is enabled for relevant XML attributes. The + auto-completion detects its context and limits the completion for e.g. + <code><property></code> and only shows the properties/fields available in the + enclosing <code><class></code> , <code><subclass></code> etc. It is also + possible to navigate from the <emphasis> + <property>hbm.xml</property> + </emphasis> files to the relevant class/field in java code.</para> + <figure> + <title>Navigation Functionality</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG" + scale="80"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>This is done via the standard hyperlink navigation functionality in Eclipse; per default + it is done by pressing F3 while the cursor is on a class/field or by pressing <emphasis> + <property>Ctrl</property> + </emphasis> and the mouse button to perform the same navigation.</para> + <para>For java completion and navigation to work the file needs to reside inside an Eclipse + Java project, otherwise no completion will occur.</para> + <note> + <title>Note:</title> + <para>Java completion does not require a Hibernate console configuration to be used.</para> + </note> + </section> + <section> + <title>Table/Column completion</title> + <para>Table and column completion is also available for all table and column attributes. </para> + <figure> + <title>Table and Column Completion</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_11.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_11.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <important> + <title>Important:</title> + <para>Table/Column completion requires a proper configured hibernate console configuration + and this configuration should be the default for the project where the <emphasis> + <property>hbm.xml</property> + </emphasis> resides.</para> + </important> + <para>You can check which console configuration is selected under the Properties of a project + and look under the <emphasis> + <property>Hibernate Settings</property> + </emphasis> page. When a proper configuration is selected it will be used to fetch the + table/column names in the background.</para> + <note> + <title>Note:</title> + <para>Currently it is not recommended to use this feature on large databases since it does + not fetch the information iteratively. It will be improved in future versions.</para> + </note> + </section> + <section> + <title>Configuration property completion</title> + <para>In <emphasis> + <property>cfg.xml</property> + </emphasis> code completion for the value of <code><property> name</code> attributes + is available.</para> + <figure> + <title>Property Completion</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_12.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_12.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="map_config_struct_editor"> + <title>Structured Hibernate Mapping and Configuration File Editor</title> + <para>The structured editor represents the file in the tree form. It also allows to modify the + structure of the file and its elements with the help of tables provided on the right-hand + area.</para> + <para>To open any mapping file in the editor, choose <emphasis> + <property>Open With > Hibernate 3.0 XML Editor</property> + </emphasis> option from the context menu of the file. The editor should look as + follows:</para> + <figure> + <title>Structured hbm.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_12_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>For the configuration file you should choose <emphasis> + <property>Open With > Hibernate Configuration 3.0 XML Editor</property> + </emphasis>option.</para> + <figure> + <title>Structured cfg.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_12_b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="properties_editor"> + <title>JBoss Tools Properties Editor</title> + <para>The editor is meant for editing <literal>.properties</literal> files. It contains two + tabs: the <property>Properties</property> (UI) tab and the <property>Source</property> tab for + manual editing.</para> + <para>For <literal>hibernate.properties</literal> file <property>JBoss Tools Properties + Editor</property> provides content assist which is available both for hibernate properties + and property values. You can make use of the content assist while editing the file in the + Source view and in the Properties view of the editor.</para> + <para>To add the property in the <property>Properties</property> view, click the <emphasis> + <property>Add</property> + </emphasis> button.</para> + <figure> + <title>Adding the Property</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the <emphasis> + <property>Name</property> + </emphasis> field press <emphasis> + <property>Ctrl+Space</property> + </emphasis> to invoke the content assist. It will suggest <emphasis> + <property>'hibernate.'</property> + </emphasis> which is the prefix for all hibernate properties. After selecting <emphasis> + <property>'hibernate.'</property> + </emphasis> and invoking the content assist again, other prefixes and properties are displayed + as the proposals with a description of each one.</para> + <figure> + <title>Content Assist for Properties Names</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>When invoking the content assist in the <emphasis> + <property>Value</property> + </emphasis> field, it also provides a list of proposals.</para> + <figure> + <title>Content Assist for Properties Values</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the <property>Source</property> view of the editor, content assist also could be + invoked both for properties names and values:</para> + <figure> + <title>Content Assist in the Source view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property4.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>Content Assist in the Source view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property5.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="rev_xml_editor"> + <title>Reveng.xml Editor</title> + <para>A <emphasis> + <property>reveng.xml </property> + </emphasis> file is used to customize and control how reverse engineering is performed by the + tools. The plugins provide an editor to ease the editing of this file and hence used to + configure the reverse engineering process.</para> + <para>The editor is intended to allow easy definition of type mappings, table include/excludes + and specific override settings for columns, e.g. define an explicit name for a column when the + default naming rules are not applicable.</para> + <note> + <title>Note:</title> + <para> Not all the features of the <emphasis> + <property>.reveng.xml </property> + </emphasis> file are exposed or fully implemented in the editor, but the main functionality + is there. To understand the full flexibility of the <emphasis> + <property>reveng.xml</property> + </emphasis>, please see <xref linkend="hibernaterevengxmlfile"/> + </para> + </note> + <para>The editor is activated as soon as an <emphasis> + <property>.reveng.xml </property> + </emphasis> file is opened. To get an initial <emphasis> + <property>reveng.xml </property> + </emphasis> file the <property>Reverse Engineering File Wizard</property> can be started via + <emphasis> + <property>Ctrl+N</property> + </emphasis> and <emphasis> + <property>Hibernate > Hibernate Reverse Engineering File (reveng.xml)</property> + </emphasis> then.</para> + <figure> + <title>ChooseReverse Engineering File Wizard </title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_22.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_22.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>Or you can get it via the <property>Code Generation Launcher</property> by checking the + proper section in the <emphasis> + <property>Main</property> + </emphasis> tab of the <link linkend="hib_code_gen">Hibernate Code Generation + Wizard</link>.</para> + <para>The following screenshot shows the <emphasis> + <property>Overview</property> + </emphasis> page where the wanted console configuration is selected (auto-detected if + Hibernate 3 support is enabled for the project)</para> + <figure> + <title>Overview Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_13.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_13.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The <emphasis> + <property>Table Filter</property> + </emphasis> page allows you to specify which tables to include and exclude. Pressing + <emphasis> + <property>Refresh</property> + </emphasis> shows the tables from the database that have not yet been excluded.</para> + <figure> + <title>Table Filters Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_14.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_14.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The <emphasis> + <property>Type Mappings</property> + </emphasis> page is used for specifying type mappings from JBDC types to any Hibernate type + (including usertypes) if the default rules are not applicable. Here again to see the database + tables press <emphasis> + <property>Refresh</property> + </emphasis> button underneath. More about type mappings you can find further in the <link + linkend="type_map">Type Mappings</link> section.</para> + <figure> + <title>Type Mappings Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_15.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_15.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The <emphasis> + <property>Table and Columns</property> + </emphasis> page allows you to explicit set e.g. which hibernatetype and propertyname that + should be used in the reverse engineered model. For more details on how to configure the + tables while reverse engineering read the <link linkend="tab_and_col">Specific table + configuration</link> section.</para> + <figure> + <title>Table and Columns Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_16.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_16.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>Now that you have configured all necessary parts, you can learn how to work with <property + >Hibernate Console Perspective</property>.</para> + </section> + <section id="hib_console"> + <title>Hibernate Console Perspective</title> + <para>The <property>Hibernate Console Perspective</property> combines a set of views which allow + you to see the structure of your mapped entities/classes, edit HQL queries, execute the + queries, and see the results. To use this perspective you need to create a <link + linkend="console_conf">Console configuration</link>.</para> + <section> + <title>Viewing the entity structure</title> + <para>To view your new configuration and entity/class structure, switch to <property>Hibernate + Configurations View</property>. Expanding the tree allows you to browse the class/entity + structure and see the relationships.</para> + <figure> + <title>Hibernate Console Perspective</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_17.png"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_17.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The <property>Console Configuration</property> does not dynamically adjust to changes + done in mappings and java code. To reload the configuration select the configuration and + click the <emphasis> + <property>Reload</property> + </emphasis> button in the view toolbar or in the context menu.</para> + <para>Besides, it's possible to open source and mapping files for objects showed in + <property>Hibernate Configurations View</property>. Just bring up the context menu for a + necessary object and select <emphasis> + <property>Open Source File</property> + </emphasis> to see appropriate Java class or <emphasis> + <property>Open Mapping File</property> + </emphasis> to open a proper <emphasis> + <property>.hbm.xml</property>.</emphasis></para> + <figure> + <title>Opening Source for Objects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_17_a.png"/> + </imageobject> + </mediaobject> + </figure> + <section id="map_diagram"> + <title>Mapping Diagram</title> + <para>In order to get a visual feel on how entities are related as well as view their + structures, a <property>Mapping Diagram</property> is provided. It is available by right + clicking on the entity you want a mapping diagram for and then choosing <emphasis> + <property>Mapping Diagram</property>.</emphasis></para> + <figure> + <title>Mapping Diagram</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_18.png"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_18.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To make <property>Mapping Diagram</property> usage easier you can use <property + >Rules</property>, <property>Grid</property>,<property>Snap to Geometry</property> + checkboxes in the <emphasis> + <property>View</property> + </emphasis> menu. </para> + <figure> + <title>View menu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/map_diagram1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you will select <emphasis> + <property>Rules</property> + </emphasis> checkbox, the view print page scale will be added to the page. The numbers on + the scale show its size in inches.If you click on the scale a <emphasis> + <property>Ruler Guide</property> + </emphasis> will appear on the diagram. You can connect any diagram item to it.To connect + the items you should move their tops to the Ruler Guide. And while moving the ruler guide, + the items will be moved together with it as a whole.</para> + <figure> + <title>Moving the Ruler guide</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/map_diagram2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you'll select <emphasis> + <property>Grid</property> + </emphasis> checkbox, the grid will appear on the diagram.</para> + <figure> + <title>Grid on Mapping diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/map_diagram3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The checkbox <emphasis> + <property>Snap to Geometry</property> + </emphasis> helps to put the items of the diagram into allineation with the grid.</para> + <para>For better navigating through the diagram use <property>Outline view</property> which + is available in the structural and graphical modes.</para> + <figure> + <title>Navigating in the Structural Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To switch over between the modes use the buttons in the top-right corner of the + <property>Outline view</property>.</para> + <figure> + <title>Navigating in the Graphical Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_b.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The options in the context menu of the mapping diagram are listed in the next + table.</para> + <table> + <title>Context Menu Options of the Mapping Diagram</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + <thead> + <row> + <entry align="center"> + <para>Icon</para> + </entry> + <entry align="center"> + <para>Command</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toggleConnections.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Show|Hide connections</para> + </entry> + <entry>Allows to select what types of connections should be shown on the diagram: <itemizedlist> + <listitem> + <para>Property Mappings</para> + </listitem> + <listitem> + <para>Class Mappings</para> + </listitem> + <listitem> + <para>Associations</para> + </listitem> + <listitem> + <para>Foreign key constraints</para> + </listitem> + </itemizedlist></entry> + </row> + <row> + <entry> + <para/> + </entry> + <entry> + <para>Select All</para> + </entry> + <entry> + <para>Makes all the diagram elements selected</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/autoLayout.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Auto layout</para> + </entry> + <entry> + <para>Used to dispose all the items of the diagram in a standard manner</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/exportAsImage.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Export as Image</para> + </entry> + <entry> + <para>Allows to export a diagram as <emphasis><property>.png + </property>,</emphasis> + <emphasis> + <property>.jpeg</property> + </emphasis> or <emphasis> + <property>.bmp </property> + </emphasis></para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <para>When you open the context menu while clicking an item on the diagram, it quite differs + from the one described before.</para> + <figure> + <title>Context Menu in Mapping Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_g.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The next table describes all the extra options in the menu of mapping items:</para> + <table> + <title>Extra Options in the Context Menu of Mapping Item</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + <thead> + <row> + <entry align="center"> + <para>Icon</para> + </entry> + <entry align="center"> + <para>Command</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/openSourceFile_but.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Open Source File</para> + </entry> + <entry> + <para>Makes it possible to open a source file for a chosen object/element. The + selected element will be highlighted in the open file.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/openMappingFile_but.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Open Mapping File</para> + </entry> + <entry> + <para>Makes it possible to open a mapping file for a chosen object/element. The + selected element will be highlighted in the open file.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/visibleState.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Show|Hide shape(s)</para> + </entry> + <entry> + <para>Used to hide/show an item on the mapping diagram</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/expandState.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Expand|Collapse shape(s)</para> + </entry> + <entry> + <para>Used for expanding/collapsing fields of the item</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <tip> + <title>Tip:</title> + <para>All the described types of the context menu are also available in the <property + >Outline</property> view.</para> + </tip> + <para>The below table lists the actions that could be performed using the keyboard keys (or + keys combinations).</para> + <table> + <title>Hibernate Mapping Diagram Shortcut Keys</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="3*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <thead> + <row> + <entry align="center"> + <para>Command</para> + </entry> + <entry align="center"> + <para>Binding</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Scroll the diagram content</para> + </entry> + <entry> + <para>Ctrl + Shift + arrows</para> + </entry> + </row> + <row> + <entry> + <para>Collapse/Expand selected item(s)</para> + </entry> + <entry> + <para> Enter </para> + </entry> + </row> + <row> + <entry> + <para>Show/Hide selected item(s)</para> + </entry> + <entry> + <para> + </para> + </entry> + </row> + <row> + <entry> + <para>Sort items in alphabetical order or return the initial state</para> + </entry> + <entry> + <para>Space</para> + </entry> + </row> + <row> + <entry> + <para>Navigate between the items</para> + </entry> + <entry> + <para>Arrows</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <para>It's possible to save the diagram in the eclipse workspace. Click the usual + <emphasis> + <property>File > Save As</property> + </emphasis> option, the wizard will ask you to set the location within you project where + to save the file and give the name for the diagram. The item's names concatenated + with the ampersand symbols are set as the default name for a diagram. The file is saved + with the <literal>.hibernate</literal> extension.</para> + <figure> + <title>The Diagram saved in the Workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/saveDiagram.png"/> + </imageobject> + </mediaobject> + </figure> + <tip> + <title>Note:</title> + <para>If you restart the Eclipse with the mapping diagram opened, the mapping diagram will + be restored with the message like on the figure below. To view the diagram content, you + should perform the refreshing.</para> + </tip> + <figure> + <title>The Diagram after Restarting the Eclipse</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagram1.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>The Diagram after Refreshing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagram2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>There are some useful commands in the toolbar.</para> + <figure> + <title>The Diagram View Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagramToolbar.png"/> + </imageobject> + </mediaobject> + </figure> + <para>They are described in the table below.</para> + <table> + <title>Command in Diagram View Toolbar </title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + <thead> + <row> + <entry align="center"> + <para>Icon</para> + </entry> + <entry align="center"> + <para>Command</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarRefresh.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Refresh Visual Mapping</para> + </entry> + <entry> + <para>It update <property>Mapping Diagram</property> if <property>Console + Configuration</property> was changed. </para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarZoom.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Zoom Box</para> + </entry> + <entry> + <para>Used to define scale of the diagram. Also it's used for <property>Mapping + Diagram</property> printing. If you want to put the whole <property + >diagram</property> to one print page, you need select <property + >Page</property> option in the <property>Zoom Box</property>.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarAutolayout.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Auto layout</para> + </entry> + <entry> + <para>Used to arrange all diagram items in a standard manner.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarShowHideConnections.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Show|Hide connections</para> + </entry> + <entry> + <para>Used to show or hide connection on the diagram. Moreover you can choose what + type of connections must be present on the diagram (<property>Property + Mappings</property>, <property>Class Mappings</property>, <property + >Associations</property> or <property>Foreign key constraints</property>) + .</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarExpandCollapse.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Expand|Collapse</para> + </entry> + <entry> + <para>Used for expanding/collapsing fields of the item.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarShowHideShapes.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para> Show|Hide shape(s)</para> + </entry> + <entry> + <para>Used to hide/show an item on the mapping diagram.</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + </section> + <section> + <title>Prototyping Queries</title> + <para>Queries can be prototyped by entering them into the <property>HQL</property> or + <property>Criteria Editor</property>. To execute a query you should click the green run + button in the editor toolbar or press <emphasis> + <property>Ctrl+Enter</property> + </emphasis>.</para> + <section id="hql_and_criteria_editors"> + <title>HQL Editor and Hibernate Criteria Editor</title> + <para>To open the query editors right-click your project <property>Console + Configuration</property> and select <property>HQL Editor</property> (or <property + >Hibernate Criteria Editor</property>).</para> + <figure> + <title>Opening HQL Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/prototypingQueries.png"/> + </imageobject> + </mediaobject> + </figure> + <tip> + <title>Tip:</title> + <para>If the context menu items are disabled then you need at first to create a <property + >Session Factory</property>. That is done by simply expanding the <property>Session + Factory</property> node.</para> + </tip> + <para>When open the editors they should automatically detect the chosen Console + Configuration.</para> + <para>To get a prefill query for any entity (or any entity child node) listed in the + <emphasis> + <property>Session Factory</property> + </emphasis> you should double-click it. This will open the <property>HQL Editor</property> + with the associated query.</para> + <para>Choosing <emphasis> + <property>HQL Editor</property> + </emphasis> in the context menu for any entity (or any entity child node) will also open + the HQL editor with the associated query. If you choose <emphasis> + <property>Hibernate Criteria Editor</property> + </emphasis> in the context menu, it will open <property>Hibernate Criteria + Editor</property> with the associated criteria.</para> + <figure> + <title>Generating Simple Queries</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_19.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>It's also possible to copy a portion of code from <emphasis> + <property>.java</property> + </emphasis> file into the <property>HQL</property> or <property>Criteria + editor</property>. To do this make use of the Quick Fix option (<emphasis> + <property>Ctrl + 1</property>)</emphasis>.</para> + <figure> + <title>Quick Fix Option Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_b.png"/> + </imageobject> + </mediaobject> + </figure> + <para>You can also update the original java code according to changes in the HQL or Criteria + editor. For that you should save your HQL/Criteria query and submit the replacing in + appeared confirmation dialog.</para> + <figure> + <title>Updating Java Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_c.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Also you can pin <property>HQL editor</property> and <property>Criteria + editor</property> for one tab in <property>Hibernate Query Result</property> view. For + that you need click on <property>Stick result to one tab</property> + button(<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/sticky_but.png"/> + </imageobject> + </inlinemediaobject> ). In the issue query executions results will be shown in one tab (no + more will be opened). </para> + <para> Moreover you are able to rename tab in <property>Hibernate Query Result</property>. + Click the tab, and type a new name in <property>Property View->Tab name field</property>. </para> + <figure> + <title>Tab Renaming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_d.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Error Handling</title> + <para>Errors during creation of the <property>Session Factory</property> or running the + queries (e.g. if your configuration or query is incorrect) will be shown in a message + dialog or inclined in the view that detected the error, you may get more information about + the error in the <property>Error Log View</property> on the right pane.</para> + <para>Results of a query will be shown in the <property>Hibernate Query Result + View</property> and details of possible errors (syntax errors, database errors, etc.) + can be seen in the <property>Error Log View</property>.</para> + <note> + <title>Note:</title> + <para>HQL queries are executed by default using <literal>list()</literal> thus without any + limit of the size of the output the query could return a large result set. You might run + out of memory. To avoid this you can put a value in the Max results field to reduce the + number of elements returned.</para> + </note> + </section> + <section> + <title>Dynamic Query Translator</title> + <para>If the <property>Hibernate Dynamic Query Translator View</property> is visible while + writing in the <property>HQL Editor</property> it will show the generated SQL for a HQL + query.</para> + <figure> + <title>Hibernate Dynamic Query Translator View</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_20.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_20.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The translation is done each time you stop typing into the editor, if there are errors + in the HQL the parse exception will be shown embedded in the view.</para> + </section> + </section> + <section> + <title>Properties View</title> + <para>As you can see on the figure,when clicking on class/entity <property>Properties + view</property> shows the number of query results as well as the time of executing.</para> + <figure> + <title>Properties View</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_21_a.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_21_a.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>It also displays the structure of any persistent object selected in the <property + >Hibernate Query Results View</property>. Editing is not yet supported.</para> + <figure> + <title>Properties View for Selected Object</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_21_b.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_21_b.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>You can also use <property>Properties view</property> when clicking on the configuration + itself in Hibernate Configuration View( <link linkend="modif_console_conf">Modifying a + Hibernate Console Configuration section</link>). </para> + </section> + </section> + <section id="jpa_annotations"> + <title>Hibernate:add JPA annotations refactoring </title> + <para>Using this wizard you can add the next Hibernate annotations to the class: <emphasis> + <property>@Column</property> + </emphasis>,<emphasis> + <property>@Entity</property> + </emphasis>,<emphasis> + <property>@ManyToOne</property> + </emphasis>,<emphasis> + <property>@OneToMany</property> + </emphasis>,<emphasis> + <property>@OneToOne</property> + </emphasis>,<emphasis> + <property>@ManyToMany</property> + </emphasis>,<emphasis> + <property>@MappedSuperclass</property> + </emphasis>,<emphasis> + <property>@Id</property> + </emphasis>,<emphasis> + <property>@GeneratedValue</property> + </emphasis> ,<emphasis> + <property>@Version </property> + </emphasis> + </para> + <itemizedlist> + <listitem> + <para><emphasis> + <property>@Column</property> + </emphasis> is added to all String properties.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@Entity</property> + </emphasis> is always declared before any class where it doesn't present.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@ManyToOne</property> + </emphasis>,<emphasis> + <property>@OneToMany</property> + </emphasis>,<emphasis> + <property>@OneToOne</property> + </emphasis>,<emphasis> + <property>@ManyToMany</property> + </emphasis> - this annotations are declared according to the classes hierarchy.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@MappedSuperclass</property> + </emphasis> is added to abstract superclasses.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@Id</property> + </emphasis>,<emphasis> + <property>@GeneratedValue</property> + </emphasis> are added automatically only to the properties under the name "Id",where they + don't present.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@Version</property> + </emphasis> is declared in case you select <link linkend="optim_lock">Enable optimistic + locking</link>.</para> + </listitem> + </itemizedlist> + <note> + <title>Note:</title> + <para>This section doesn't cover the meaning of the <property>Hibernate annotations</property> + , for more information read <ulink + url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/">Hibernate + Annotations Documentation</ulink> .</para> + </note> + <para>To open this wizard you should right click the class you want to enrich with annotations + <emphasis> + <property>>Source>Generate Hibernate/JPA annotations</property> + </emphasis>. You will see the Hibernate:add JPA annotations dialog. </para> + <figure> + <title>Starting Hibernate:add JPA annotations dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations1.png"/> + </imageobject> + </mediaobject> + </figure> + <para> In the top of it you can see the list of all classes that will be passed through + refactoring. Besides the class you have selected in this list you can also find its + superclasses and the classes that objects present in the current class as properties. If you + want to add new classes or package to the list of classes, you should click the <property + >Back</property> button. In result you will see <property>Add classes and + packages</property> page.</para> + <figure> + <title>Add classes and packages page </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations1_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Here you can add one more classes or whole package, moreover you can limit dependencies + depth by selecting <property>depth control</property> option (more about this option you will + find in <link linkend="depth_control">Creating a Hibernate Mapping File</link>). When finished + just press the <property>Next</property> button and you will be returned to <property>The + following classes will be changed</property> page and will be able to continue work with + it.</para> + <para>By default the tags are added to the fields of selected classes. But you can change this + option to <emphasis> + <property>Getters</property> + </emphasis>in <emphasis> + <property> Preferred location of Annotations</property> + </emphasis> dropdownlist and then all the annotations will be added to the getter methods. If + you choose <emphasis> + <property>Auto select from class preference</property> + </emphasis> then the annotations are added according to the majority of the already existed + ones positions. </para> + <para> If it's nessecary to map your String properties to the columns that length differ from + the default value(255) ,change <emphasis> + <property>Default string length field</property> + </emphasis> and <code>@Column(length = your length)</code> will be created before every String + property. </para> + <para id="optim_lock">You can add optimistic locking capability to an entity bean by selecting + <emphasis> + <property>Enable optimistic locking</property> + </emphasis> checkbox. This operation will add version property to all the selected classes. + The property will be also annotated with @Version ,getter and setter will be created. If the + property is already exists,it won't be created ,but the getters,setters will be generated. If + there is already @MappedSuperclass with version in the base class of the current class - + <emphasis> + <property>"version"</property> + </emphasis> is not inserted into the current class. </para> + <para>After defining all necessary settings in the current step press <emphasis> + <property>Next</property> + </emphasis> and follow the next wizard steps. </para> + <figure> + <title>Hibernate:add JPA annotations view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The view represents two windows: one with the source code and and the second with + refactored one. With the help of <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt1.png"/> + </imageobject> + </inlinemediaobject> ,<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt2.png"/> + </imageobject> + </inlinemediaobject> ,<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt3.png"/> + </imageobject> + </inlinemediaobject> ,<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt4.png"/> + </imageobject> + </inlinemediaobject> buttons you can quickly navigate between the differences in the code. If + you don't agree with some changes you can't undo them but you can remove the class from the + list of classes that need refactoring. </para> + <figure> + <title>List of classes that need refactoring</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To apply the changes click <emphasis> + <property>Finish</property> + </emphasis>.</para> + </section> + <section id="debug_log"> + <title>Enable debug logging in the plugins</title> + <para>It is possible to configure the eclipse plugin to route all logging made by the plugins + and hibernate code it self to the <property>Error Log View</property> in Eclipse.</para> + <para><property>Error Log View</property> is very useful tool to solve any problem which appears in Hibernate Tools Plugins. + You can use if there are troubles with setting up <property>Hibernate Console Configuration</property>.</para> + <para>This is done by editing the <emphasis> + <property>hibernate-log4j.properties</property> + </emphasis> in <emphasis> + <property>org.hibernate.eclipse/ directory/jar</property> + </emphasis>. This file includes a default configuration that only logs WARN and above to a set + of custom appenders (PluginFileAppender and PluginLogAppender). You can change these settings + to be as verbose or silent as you please - see <ulink url="http://www.hibernate.org/5.html" + >Hibernate Documentation</ulink> for interesting categories and Log4j documentation.</para> + <section> + <title>Relevant Resources Links</title> + <para>Find more on how to configure logging via a log4j property file in <ulink + url="http://supportweb.cs.bham.ac.uk/docs/tutorials/docsystem/build/tutorials/..." + >Log4j documentation</ulink>.</para> + </section> + </section> + <section id="dali_integration"> + <title>Hibernate support for Dali plugins in Eclipse WTP</title> + <para>Starting from 3.0.0 Alpha1 version of <property>JBoss Tools</property> Hibernate plugins + support Eclipse Dali integration what now makes it possible to use a Hibernate as a complete + JPA development platform.</para> + <para>When starting a new JPA project from <emphasis> + <property>New > Other > JPA > JPA Project</property> + </emphasis> (or simply <emphasis> + <property>New > JPA Project</property> + </emphasis> in <property>JPA Perspective</property>), the first wizard page looks as + follows.</para> + <figure> + <title>Starting JPA Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>It's possible here to select a target runtime and change the project configuration, + or you can leave everything as it is.</para> + <para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the + proper database connection, if it is defined, or add a new one by clicking the <emphasis> + <property>Add connection</property> + </emphasis> link.</para> + <para>Hitting <emphasis> + <property>Finish</property> + </emphasis> will generate the project.</para> + <figure> + <title>Targeting at Hibernate Platform</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration2.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, a + Hibernate Console Configuration for the project is created automatically when the wizard + finishes its work. It allows a full usage of <property>Hibernate Tools</property> features + without additional setup.</para> + </note> + <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. + For that find <emphasis> + <property>JPA Tools > Generate Tables from Entities/Generate Entities from Tables</property> + </emphasis> options in the context menu of your JPA project.</para> + <figure> + <title>Generate DDL/Entities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration3.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>Please, remember to put the proper database driver to the classpath of your + project.</para> + </note> + <para>The <property>Generate Entities wizard</property> first will ask you to choose the + directory where all output will be written.</para> + <figure> + <title>Generate Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To generate entities you can use:</para> + <itemizedlist> + <listitem> + <para>a Hibernate Console Configuration (proposed by default)</para> + <para>Just make sure that the <emphasis> + <property>Use Console Configuration</property> + </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> + <property>Console configurations</property> + </emphasis> list box.</para> + <figure> + <title>Generate Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration5.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para>or a DTP connection directly</para> + <para>Just uncheck <emphasis> + <property>Use Console Configuration</property> + </emphasis> and adjust database settings.</para> + </listitem> + </itemizedlist> + <para>All the same you do with Generate Entities Wizard you can do with Generate DDL wizard. + Special feature for Generate DDL wizard is possible automatic execution of Generation DDL in + the database. </para> + <figure> + <title>Generate DDL Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para> + </section> +</chapter> Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/introduction.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/introduction.xml 2010-06-08 23:38:52 UTC (rev 22649) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/introduction.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<chapter id="preface"> +<chapter id="introduction"> <title>Introduction</title> Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master.xml 2010-06-08 23:38:52 UTC (rev 22649) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -50,7 +50,7 @@ </copyright> <releaseinfo> - Version: 3.3.0.GA + Version: 3.3.1.GA </releaseinfo> Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master_output.xml 2010-06-08 23:38:52 UTC (rev 22649) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master_output.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -49,7 +49,7 @@ </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 3.3.0.GA + Version: 3.3.1.GA </diffmk:wrapper></releaseinfo> @@ -470,23 +470,22 @@ can take advantage of while using the tools within Eclipse.</para> <note> <title>Note:</title> - <para><diffmk:wrapper diffmk:change="changed">Please note that these tools do not try to hide any functionality of </diffmk:wrapper><property moreinfo="none">Hibernate</property>. The tools make working with <property moreinfo="none">Hibernate</property><diffmk:wrapper diffmk:change="changed"> easier, - but you are still encouraged/required to read the </diffmk:wrapper><ulink url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink> to fully utilize + <para>Please note that these tools do not try to hide any functionality of <property moreinfo="none">Hibernate</property>. The tools make working with <property moreinfo="none">Hibernate</property> easier, + but you are still encouraged/required to read the <ulink url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink> to fully utilize <property moreinfo="none">Hibernate Tools</property> and especially <property moreinfo="none">Hibernate</property> it self.</para> </note> - <section diffmk:change="added" id="download_base_project"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Download base project</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can download example projects which are used as base for this chapter.</diffmk:wrapper></para> - <para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JPA base project</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is available </diffmk:wrapper><ulink diffmk:change="added" url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools/docs/refe..."><diffmk:wrapper diffmk:change="added">here</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> - and base </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Java project</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is situated </diffmk:wrapper><ulink diffmk:change="added" url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools/docs/refe..."><diffmk:wrapper diffmk:change="added">here</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Also you need start </diffmk:wrapper><ulink diffmk:change="added" url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools/docs/refe..."><diffmk:wrapper diffmk:change="added">database</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</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">How to run database you can know in </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/3.0.1.GA/en/GettingStartedGuide/html/first_se..."><diffmk:wrapper diffmk:change="added">Getting Started Guide</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <section id="download_base_project"> + <title>Download base project</title> + <para><diffmk:wrapper diffmk:change="changed">You can download example projects which are used for this chapter.</diffmk:wrapper></para> + <para><property moreinfo="none">JPA base project</property><diffmk:wrapper diffmk:change="added"> is available on </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/resources/"><diffmk:wrapper diffmk:change="added">documentation resources page </diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> + together with </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/resources/TestHibernateproject_for_hibernate_..."><diffmk:wrapper diffmk:change="added">base Java project</diffmk:wrapper></ulink>.</para> + <para>Also you need start <ulink url="http://docs.jboss.org/tools/resources/GSG_database.zip">database</ulink>.</para> + <note> + <title>Note:</title> + <para>How to run database you can know in <ulink url="http://docs.jboss.org/tools/3.0.1.GA/en/GettingStartedGuide/html/first_se...">Getting Started Guide</ulink>.</para> </note> </section> - </section> <section id="map_file_wizard"> <title>Creating a Hibernate Mapping File</title> @@ -494,15 +493,15 @@ tables.</para> <para>To create basic mappings for properties and associations, i. e. generate <emphasis> <property moreinfo="none">.hbm.xml</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> files, Hibernate Tools provide a basic wizard which you can bring up by navigating - </diffmk:wrapper><emphasis> + </emphasis> files, Hibernate Tools provide a basic wizard which you can bring up by navigating + <emphasis> <property moreinfo="none">New > Hibernate XML mapping file</property>.</emphasis></para> - <para><diffmk:wrapper diffmk:change="changed">At first you'll be asked to select a package or multiple individual classes to map. + <para>At first you'll be asked to select a package or multiple individual classes to map. It's also possible to create an empty file, don't select any packages or classes and an - empty .hbm will be created in the specified location</diffmk:wrapper></para> - <para diffmk:change="added" id="depth_control"><diffmk:wrapper diffmk:change="added">With </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">depth control</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> option you can define dependences depth for - choosing classes (it means to set level of references which is used to collect linked classes - to the selection). </diffmk:wrapper></para> + empty .hbm will be created in the specified location</para> + <para id="depth_control">With <property moreinfo="none">depth control</property><diffmk:wrapper diffmk:change="changed"> option you can define + dependences depth for choosing classes (it means to set level of references which is used to + collect linked classes to the selection). </diffmk:wrapper></para> <figure float="0"> <title>Hibernate XML Mapping File Wizard</title> <mediaobject> @@ -511,7 +510,9 @@ </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="added">The next wizard page lists the mappings to be generated. As you see </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Customers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Orders</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Productlines</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> classes added under </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">depth control</diffmk:wrappe! r></property><diffmk:wrapper diffmk:change="added"> driving. </diffmk:wrapper></para> + <para>The next wizard page lists the mappings to be generated. As you see <property moreinfo="none">Customers</property>, <property moreinfo="none">Orders</property>, <property moreinfo="none">Productlines</property><diffmk:wrapper diffmk:change="changed"> and + </diffmk:wrapper><property moreinfo="none">Products</property> classes added under <property moreinfo="none">depth control</property><diffmk:wrapper diffmk:change="changed"> + driving. </diffmk:wrapper></para> <figure float="0"> <title>Mappings to be generated</title> <mediaobject> @@ -520,21 +521,20 @@ </imageobject> </mediaobject> </figure> - - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This wizard page outputs a generated .hbm files preview.</diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Preview Generated Mapping Files</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/plugins_0_b.png"></imagedata> + <para>This wizard page outputs a generated .hbm files preview.</para> + <figure float="0"> + <title>Preview Generated Mapping Files</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0_b.png"></imagedata> </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="added">Pressing </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> creates the files.</diffmk:wrapper></para> + <para>Pressing <property moreinfo="none">Finish</property> creates the files.</para> </section> <section id="hib_config_file"> <title>Creating a Hibernate Configuration File</title> - <para><diffmk:wrapper diffmk:change="changed">To be able to reverse engineer, prototype queries, and of course to simply use </diffmk:wrapper><property moreinfo="none">Hibernate Core</property> a <emphasis> + <para>To be able to reverse engineer, prototype queries, and of course to simply use <property moreinfo="none">Hibernate Core</property> a <emphasis> <property moreinfo="none">hibernate.properties</property> </emphasis> or <emphasis> <property moreinfo="none">hibernate.cfg.xml</property> @@ -548,7 +548,7 @@ <property moreinfo="none">Hibernate > Hibernate Configuration File (cfg.xml)</property> </emphasis> and press <emphasis> <property moreinfo="none">Next</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> or on a web Seam project in the </diffmk:wrapper><property moreinfo="none">Web Projects</property><diffmk:wrapper diffmk:change="changed"> view </diffmk:wrapper><emphasis> + </emphasis> or on a web Seam project in the <property moreinfo="none">Web Projects</property> view <emphasis> <property moreinfo="none"> WebContent -> New -> File -> Hibernate Configuration 3.0</property> </emphasis>. After selecting the wanted location for the <emphasis> <property moreinfo="none">hibernate.cfg.xml</property> @@ -593,407 +593,408 @@ possible if your project requires this.</para> <section id="creat_console_conf"> <title>Creating a Hibernate Console Configuration</title> - <para><diffmk:wrapper diffmk:change="changed">You can create a console configuration by running the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Console Configuration - Wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">, shown in the following screenshot. The same wizard will also be used if - you are coming from the </diffmk:wrapper><emphasis> + <para>You can create a console configuration by running the <property moreinfo="none">Console Configuration + Wizard</property>, shown in the following screenshot. The same wizard will also be used if + you are coming from the <emphasis> <property moreinfo="none">hibernate.cfg.xml</property> </emphasis> wizard and had enabled <emphasis> <property moreinfo="none">Create Console Configuration</property> </emphasis>.</para> - <note diffmk:change="added"> + <note> <title>Note:</title> - <para><diffmk:wrapper diffmk:change="changed">The wizard will look at the current selection in the IDE and try and auto-detect the - settings which you then can just approve or modify to suit your needs.</diffmk:wrapper></para> + <para>The wizard will look at the current selection in the IDE and try and auto-detect the + settings which you then can just approve or modify to suit your needs.</para> </note> <para></para> <para>The dialog consists of five tabs: </para> - <itemizedlist diffmk:change="added"> - <listitem diffmk:change="added"> + <itemizedlist> + <listitem> <para><emphasis> <property moreinfo="none">Main</property> </emphasis> for the basic/required settings</para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title> Creating Hibernate Console Configuration</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"></imagedata> </imageobject> </mediaobject> </figure> <para>The following table describes the available settings on the <emphasis> <property moreinfo="none">Main</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> tab. The wizard can automatically detect the default values for most of them if you - started the wizard with the relevant java project or resource selected.</diffmk:wrapper></para> - <table diffmk:change="added"> + </emphasis><diffmk:wrapper diffmk:change="changed"> tab. The wizard can automatically detect the default values for most of them if + you started the wizard with the relevant java project or resource selected.</diffmk:wrapper></para> + <table> <title>Hibernate Console Configuration Parameters</title> - <tgroup cols="3" diffmk:change="added"> + <tgroup cols="3"> <colspec align="left" colnum="1" colwidth="1*"></colspec> <colspec colnum="2" colwidth="3*"></colspec> <colspec align="left" colnum="3" colwidth="1*"></colspec> - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry align="center" diffmk:change="added"> + <thead> + <row> + <entry align="center"> <para>Parameter</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Auto detected value</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <tbody> + <row> + <entry> <para>Name</para> </entry> - <entry diffmk:change="added"> + <entry> <para>The unique name of the console configuration</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Name of the selected project</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Type</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">Choose between "Core", "Annotations" and "JPA". + <entry> + <para>Choose between "Core", "Annotations" and "JPA". Note that the two latter requires running Eclipse IDE with a JDK 5 runtime, - otherwise you will get classloading and/or version errors.</diffmk:wrapper></para> + otherwise you will get classloading and/or version errors.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>No default value</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Project</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">The name of a java project which classpath should be used in the console - configuration</diffmk:wrapper></para> + <entry> + <para>The name of a java project which classpath should be used in the console + configuration</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Name of the selected project</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Database connection</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">DTP provided connection that you can use instead of what is in cfg.xml and jpa + <entry> + <para>DTP provided connection that you can use instead of what is in cfg.xml and jpa persistence.xml. It's possible to use either already configured hibernate or - JPA connection or specify a new one here.</diffmk:wrapper></para> + JPA connection or specify a new one here.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>[Hibernate Configured connection]</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Property file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Path to a hibernate.properties file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>First hibernate.properties file found in the selected project</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Configuration file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Path to a hibernate.cfg.xml file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>First hibernate.cfg.xml file found in the selected project</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Persistence unit</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Name of the persistence unit to use</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">No default value (let Hibernate Entity Manager find the persistence unit or - it can be defined manually using Browse button)</diffmk:wrapper></para> + <entry> + <para><diffmk:wrapper diffmk:change="changed">No default value (let Hibernate Entity Manager find the persistence unit or it + can be defined manually using Browse button)</diffmk:wrapper></para> </entry> </row> </tbody> </tgroup> </table> - <tip diffmk:change="added"> + <tip> <title>Tip:</title> - <para><diffmk:wrapper diffmk:change="changed">The two latter settings are usually not required if you specify a project and it has + <para><diffmk:wrapper diffmk:change="changed">The two latter settings are usually not required if you specify a project and it has </diffmk:wrapper><emphasis> - <property diffmk:change="added" moreinfo="none"> + <property moreinfo="none"> <literal moreinfo="none"> /hibernate.cfg.xml </literal> </property> </emphasis> or <emphasis> - <property diffmk:change="added" moreinfo="none"> + <property moreinfo="none"> <literal moreinfo="none">/META-INF/persistence.xml</literal> </property> </emphasis> in its project classpath.</para> </tip> - <itemizedlist diffmk:change="added"> - <listitem diffmk:change="added"> - <para diffmk:change="added"> - <emphasis diffmk:change="added"> + <itemizedlist> + <listitem> + <para> + <emphasis> <property moreinfo="none">Options</property> </emphasis> for the additional/optional settings</para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title>Options Tab of the Console Configuration Wizard</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <imagedata fileref="images/plugins/plugins_2_a.png"></imagedata> </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">The next table describes Hibernate Console Configuration options available on the - </diffmk:wrapper><emphasis> + <para>The next table describes Hibernate Console Configuration options available on the + <emphasis> <property moreinfo="none">Options</property> </emphasis> tab.</para> - <table diffmk:change="added"> + <table> <title>Hibernate Console Configuration Options</title> - <tgroup cols="3" diffmk:change="added"> + <tgroup cols="3"> <colspec align="left" colnum="1" colwidth="1*"></colspec> <colspec colnum="2" colwidth="3*"></colspec> <colspec align="left" colnum="3" colwidth="1*"></colspec> - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry align="center" diffmk:change="added"> + <thead> + <row> + <entry align="center"> <para>Parameter</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Auto detected value</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">Database dialect</diffmk:wrapper></para> + <tbody> + <row> + <entry> + <para>Database dialect</para> </entry> <entry> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Define a database dialect. It's possible either to write your value or choose - from list. </diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="changed">Define a database dialect. It's possible either to write your value or + choose from list. </diffmk:wrapper></para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">No default value</diffmk:wrapper></para> + <entry> + <para>No default value</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Naming strategy</diffmk:wrapper></para> + <row> + <entry> + <para>Naming strategy</para> </entry> <entry> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Fully qualified classname of a custom NamingStrategy. Only required if you use - a special naming strategy.</diffmk:wrapper></para> + <para>Fully qualified classname of a custom NamingStrategy. Only required if you use + a special naming strategy.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>No default value</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Entity resolver</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">Fully qualified classname of a custom EntityResolver. Only required if you - have special xml entity includes in your mapping files.</diffmk:wrapper></para> + <entry> + <para>Fully qualified classname of a custom EntityResolver. Only required if you + have special xml entity includes in your mapping files.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>No default value</para> </entry> </row> </tbody> </tgroup> </table> - <itemizedlist diffmk:change="added"> - <listitem diffmk:change="added"> + <itemizedlist> + <listitem> <para><emphasis> <property moreinfo="none">Classpath</property> </emphasis> for classpath</para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title>Specifying Classpath in Hibernate Console Configuration</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"></imagedata> </imageobject> </mediaobject> </figure> <para>The following table specifies the parameters of the Classpath tab of the wizard.</para> - <table diffmk:change="added"> + <table> <title>Hibernate Console Configuration Classpath</title> - <tgroup cols="3" diffmk:change="added"> + <tgroup cols="3"> <colspec align="left" colnum="1" colwidth="1*"></colspec> <colspec colnum="2" colwidth="3*"></colspec> <colspec colnum="3" colwidth="1*"></colspec> - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry align="center" diffmk:change="added"> + <thead> + <row> + <entry align="center"> <para>Parameter</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Auto detected value</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <tbody> + <row> + <entry> <para>Classpath</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">The classpath for loading POJO and JDBC drivers; only needed if the default + <entry> + <para>The classpath for loading POJO and JDBC drivers; only needed if the default classpath of the Project does not contain the required classes. Do not add Hibernate core libraries or dependencies, they are already included. If you get ClassNotFound errors then check this list for possible missing or redundant - directories/jars.</diffmk:wrapper></para> + directories/jars.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Empty</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Include default classpath from project</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">When enabled the project classpath will be appended to the classpath specified - above</diffmk:wrapper></para> + <entry> + <para>When enabled the project classpath will be appended to the classpath specified + above</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Enabled</para> </entry> </row> </tbody> </tgroup> </table> - <itemizedlist diffmk:change="added"> - <listitem diffmk:change="added"> + <itemizedlist> + <listitem> <para><emphasis> <property moreinfo="none">Mappings</property> </emphasis> for additional mappings</para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title>Specifying additional Mappings in Hibernate Console Configuration</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"></imagedata> </imageobject> </mediaobject> </figure> - <para>Parameters of the Mappings tab of the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Console Configuration - wizard</diffmk:wrapper></property> are explained below:</para> - <table diffmk:change="added"> + <para>Parameters of the Mappings tab of the <property moreinfo="none">Hibernate Console Configuration + wizard</property> are explained below:</para> + <table> <title>Hibernate Console Configuration Mappings</title> - <tgroup cols="3" diffmk:change="added"> + <tgroup cols="3"> <colspec align="left" colnum="1" colwidth="1*"></colspec> <colspec colnum="2" colwidth="3*"></colspec> <colspec colnum="3" colwidth="1*"></colspec> - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry align="center" diffmk:change="added"> + <thead> + <row> + <entry align="center"> <para>Parameter</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Auto detected value</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <tbody> + <row> + <entry> <para>Mapping files </para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">List of additional mapping files that should be loaded. Note: A + <entry> + <para>List of additional mapping files that should be loaded. Note: A hibernate.cfg.xml or persistence.xml can also contain mappings. Thus if these are duplications here, you will get "Duplicate mapping" errors when using the console - configuration.</diffmk:wrapper></para> + configuration.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>empty</para> </entry> </row> </tbody> </tgroup> </table> - <itemizedlist diffmk:change="added"> - <listitem diffmk:change="added"> + <itemizedlist> + <listitem> <para>and the last tab <emphasis> <property moreinfo="none">Common</property> </emphasis></para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title>Common Tab of the Console Configuration Wizard</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <imagedata fileref="images/plugins/plugins_4_a.png"></imagedata> </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">It allows to define general aspects of the launch configuration including storage - location, console encoding and some others.</diffmk:wrapper></para> + <para>It allows to define general aspects of the launch configuration including storage + location, console encoding and some others.</para> <para>Clicking <emphasis> <property moreinfo="none">Finish</property> - </emphasis> creates the configuration and shows it in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Configurations - view</diffmk:wrapper></property>.</para> - <figure diffmk:change="added" float="0"> + </emphasis> creates the configuration and shows it in the <property moreinfo="none">Hibernate Configurations + view</property>.</para> + <figure float="0"> <title>Console Overview</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata> </imageobject> </mediaobject> </figure> </section> <section id="modif_console_conf"> - <title><diffmk:wrapper diffmk:change="changed">Modifying a Hibernate Console Configuration </diffmk:wrapper></title> - <para><diffmk:wrapper diffmk:change="changed">When you created a hibernate console configuration you can modify it in 2 ways: </diffmk:wrapper></para> + <title>Modifying a Hibernate Console Configuration </title> + <para>When you created a hibernate console configuration you can modify it in 2 ways: </para> <itemizedlist> <listitem> - <para><diffmk:wrapper diffmk:change="changed">right-click on the configuration in </diffmk:wrapper><emphasis> - <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Configurations View->Edit Configuration </diffmk:wrapper></property> - </emphasis><diffmk:wrapper diffmk:change="added"> or just double-click on </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Console Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> item.</diffmk:wrapper></para> + <para>right-click on the configuration in <emphasis> + <property moreinfo="none">Hibernate Configurations View->Edit Configuration </property> + </emphasis> or just double-click on <property moreinfo="none">Console Configuration</property><diffmk:wrapper diffmk:change="changed"> + item.</diffmk:wrapper></para> <figure float="0"> <title>Opening Edit Configuration Wizard</title> <mediaobject> @@ -1002,11 +1003,11 @@ </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed"> After clicking you will see the Edit Configuration Wizard that is similar to - </diffmk:wrapper><emphasis> + <para> After clicking you will see the Edit Configuration Wizard that is similar to + <emphasis> <property moreinfo="none">Create Console Configuration</property> - </emphasis>,described in <link linkend="creat_console_conf"><diffmk:wrapper diffmk:change="changed">Creating a Hibernate Console - Configuration section</diffmk:wrapper></link><diffmk:wrapper diffmk:change="changed">. </diffmk:wrapper></para> + </emphasis>,described in <link linkend="creat_console_conf">Creating a Hibernate Console + Configuration section</link>. </para> </listitem> <listitem> <para>use Properties view for modifying some of Console Configuration properties.</para> @@ -1018,107 +1019,107 @@ </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">The following table describes the available settings in the Properties view. Most - properties are changeable by left click but some are not. </diffmk:wrapper><table> + <para>The following table describes the available settings in the Properties view. Most + properties are changeable by left click but some are not. <table> <title>Properties</title> - <tgroup cols="3" diffmk:change="added"> + <tgroup cols="3"> <colspec align="left" colnum="1" colwidth="1*"></colspec> <colspec colnum="2" colwidth="3*"></colspec> <colspec align="left" colnum="3" colwidth="1*"></colspec> - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry align="center" diffmk:change="added"> + <thead> + <row> + <entry align="center"> <para>Property</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Is Changeable</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <tbody> + <row> + <entry> <para>Additional mapping files </para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">List of additional mapping files that should be loaded. </diffmk:wrapper></para> + <entry> + <para>List of additional mapping files that should be loaded. </para> </entry> - <entry diffmk:change="added"> + <entry> <para>False</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Configuration file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Path to a hibernate.cfg.xml file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>False</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Connection</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">DTP provided connection that you can use instead of what is in cfg.xml + <entry> + <para>DTP provided connection that you can use instead of what is in cfg.xml and jpa persistence.xml. It's possible to use either already configured - hibernate or JPA connection or specify a new one here.</diffmk:wrapper></para> + hibernate or JPA connection or specify a new one here.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>True</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Name</para> </entry> - <entry diffmk:change="added"> + <entry> <para>The unique name of the console configuration</para> </entry> - <entry diffmk:change="added"> + <entry> <para>True</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Project</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">The name of a java project which classpath should be used in the console - configuration</diffmk:wrapper></para> + <entry> + <para>The name of a java project which classpath should be used in the console + configuration</para> </entry> - <entry diffmk:change="added"> + <entry> <para>True</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Properties file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Path to a hibernate.properties file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>False</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Type</para> </entry> - <entry diffmk:change="added"> + <entry> <para><diffmk:wrapper diffmk:change="changed">Choose between "CORE", "ANNOTATIONS" and "JPA" according to the method of relational mapping you want to - use. Note, the two latter requires running Eclipse IDE with a JDK 5 - runtime, otherwise you will get classloading and/or version errors.</diffmk:wrapper></para> + use. Note, the two latter requires running Eclipse IDE with a JDK 5 runtime, + otherwise you will get classloading and/or version errors.</diffmk:wrapper></para> </entry> - <entry diffmk:change="added"> + <entry> <para>True</para> </entry> </row> @@ -1128,34 +1129,34 @@ </listitem> </itemizedlist> </section> - <section diffmk:change="added" id="closing_conf_config"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Closing Hibernate Console Configuration</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To close </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Console Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you need do right-click your configuration - and choose </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Close Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> option </diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Close Hibernate Console Configuration</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/plugins_4_d.png"></imagedata> + <section id="closing_conf_config"> + <title>Closing Hibernate Console Configuration</title> + <para>To close <property moreinfo="none">Hibernate Console Configuration</property><diffmk:wrapper diffmk:change="changed"> you need do right-click + your configuration and choose </diffmk:wrapper><property moreinfo="none">Close Configuration</property> option </para> + <figure float="0"> + <title>Close Hibernate Console Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_d.png"></imagedata> </imageobject> </mediaobject> </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">While closing configuration the connection with database will be closed, jar libs will - be unlock (for Windows) and other resources will set as free. </diffmk:wrapper></para> + <para>While closing configuration the connection with database will be closed, jar libs will + be unlock (for Windows) and other resources will set as free. </para> </section> </section> <section id="refeng_codegen" role="updated"> <title>Reverse Engineering and Code Generation</title> - <para><diffmk:wrapper diffmk:change="changed">A "click-and-generate" reverse engineering and code generation facility is + <para>A "click-and-generate" reverse engineering and code generation facility is available. This facility allows you to generate a range of artifacts based on database or an already existing Hibernate configuration, be that mapping files or annotated classes. Some of - these are POJO Java source file, Hibernate </diffmk:wrapper><emphasis> + these are POJO Java source file, Hibernate <emphasis> <property moreinfo="none">.hbm.xml</property> </emphasis>, <emphasis> <property moreinfo="none">hibernate.cfg.xml</property> </emphasis> generation and schema documentation.</para> <para>To start working with this process, start the <property moreinfo="none">Hibernate Code - Generation</property><diffmk:wrapper diffmk:change="changed"> which is available in the toolbar via the </diffmk:wrapper><property moreinfo="none">Hibernate</property> icon or via the <emphasis> + Generation</property> which is available in the toolbar via the <property moreinfo="none">Hibernate</property> icon or via the <emphasis> <property moreinfo="none">Run > Hibernate Code Generation</property> </emphasis> menu item.</para> <section id="code_gen"> @@ -1193,9 +1194,9 @@ </emphasis> will be used.</para> <tip> <title>Tip:</title> - <para><diffmk:wrapper diffmk:change="changed">The "At least one exporter option must be selected" is just a warning + <para>The "At least one exporter option must be selected" is just a warning stating that for this launch to work you need to select an exporter on the Exporter tab. - When an exporter has been selected the warning will disappear.</diffmk:wrapper></para> + When an exporter has been selected the warning will disappear.</para> </tip> <para>The dialog also have the standard tabs <emphasis> <property moreinfo="none">Refresh</property> @@ -1238,9 +1239,9 @@ <para>Output directory</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Path to a directory where all output will be written by default. It's possible + <para>Path to a directory where all output will be written by default. It's possible to enter absolute directory path, for example - "d:/temp". Be aware that existing - files will be overwritten, so be sure to specify the correct directory.</diffmk:wrapper></para> + files will be overwritten, so be sure to specify the correct directory.</para> </entry> </row> <row> @@ -1293,13 +1294,13 @@ <para>Generate basic typed composite ids</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">A table that has a multi-column primary key a <composite-id> mapping + <para>A table that has a multi-column primary key a <composite-id> mapping will always be created. If this option is enabled and there are matching foreign-keys each key column is still considered a 'basic' scalar (string, long, etc.) instead of a reference to an entity. If you disable this option a - </diffmk:wrapper><code><key-many-to-one></code><diffmk:wrapper diffmk:change="changed"> instead. Note: a - </diffmk:wrapper><code><many-to-one></code><diffmk:wrapper diffmk:change="changed"> property is still created, but is simply marked - as non-updatable and non-insertable.</diffmk:wrapper></para> + <code><key-many-to-one></code> instead. Note: a + <code><many-to-one></code> property is still created, but is simply marked + as non-updatable and non-insertable.</para> </entry> </row> <row> @@ -1672,11 +1673,11 @@ </figure> <section> <title>Java property/class completion</title> - <para><diffmk:wrapper diffmk:change="changed">Package, class, and field completion is enabled for relevant XML attributes. The + <para>Package, class, and field completion is enabled for relevant XML attributes. The auto-completion detects its context and limits the completion for e.g. - </diffmk:wrapper><code><property></code><diffmk:wrapper diffmk:change="changed"> and only shows the properties/fields available in the - enclosing </diffmk:wrapper><code><class></code><diffmk:wrapper diffmk:change="changed"> , </diffmk:wrapper><code><subclass></code><diffmk:wrapper diffmk:change="changed"> etc. It is also - possible to navigate from the </diffmk:wrapper><emphasis> + <code><property></code> and only shows the properties/fields available in the + enclosing <code><class></code> , <code><subclass></code> etc. It is also + possible to navigate from the <emphasis> <property moreinfo="none">hbm.xml</property> </emphasis> files to the relevant class/field in java code.</para> <figure float="0"> @@ -1737,8 +1738,8 @@ <title>Configuration property completion</title> <para>In <emphasis> <property moreinfo="none">cfg.xml</property> - </emphasis> code completion for the value of <code><property> name</code><diffmk:wrapper diffmk:change="changed"> attributes - is available.</diffmk:wrapper></para> + </emphasis> code completion for the value of <code><property> name</code> attributes + is available.</para> <figure float="0"> <title>Property Completion</title> <mediaobject> @@ -1783,14 +1784,14 @@ </section> <section id="properties_editor"> <title>JBoss Tools Properties Editor</title> - <para>The editor is meant for editing <literal moreinfo="none">.properties</literal><diffmk:wrapper diffmk:change="changed"> files. It contains two - tabs: the </diffmk:wrapper><property moreinfo="none">Properties</property><diffmk:wrapper diffmk:change="changed"> (UI) tab and the </diffmk:wrapper><property moreinfo="none">Source</property><diffmk:wrapper diffmk:change="changed"> tab for - manual editing.</diffmk:wrapper></para> - <para>For <literal moreinfo="none">hibernate.properties</literal> file <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Tools Properties - Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> provides content assist which is available both for hibernate properties + <para>The editor is meant for editing <literal moreinfo="none">.properties</literal> files. It contains two + tabs: the <property moreinfo="none">Properties</property> (UI) tab and the <property moreinfo="none">Source</property> tab for + manual editing.</para> + <para>For <literal moreinfo="none">hibernate.properties</literal> file <property moreinfo="none">JBoss Tools Properties + Editor</property> provides content assist which is available both for hibernate properties and property values. You can make use of the content assist while editing the file in the - Source view and in the Properties view of the editor.</diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change="changed">To add the property in the </diffmk:wrapper><property moreinfo="none">Properties</property> view, click the <emphasis> + Source view and in the Properties view of the editor.</para> + <para>To add the property in the <property moreinfo="none">Properties</property> view, click the <emphasis> <property moreinfo="none">Add</property> </emphasis> button.</para> <figure float="0"> @@ -1805,12 +1806,12 @@ <property moreinfo="none">Name</property> </emphasis> field press <emphasis> <property moreinfo="none">Ctrl+Space</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> to invoke the content assist. It will suggest </diffmk:wrapper><emphasis> + </emphasis> to invoke the content assist. It will suggest <emphasis> <property moreinfo="none">'hibernate.'</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> which is the prefix for all hibernate properties. After selecting </diffmk:wrapper><emphasis> + </emphasis> which is the prefix for all hibernate properties. After selecting <emphasis> <property moreinfo="none">'hibernate.'</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> and invoking the content assist again, other prefixes and properties are displayed - as the proposals with a description of each one.</diffmk:wrapper></para> + </emphasis> and invoking the content assist again, other prefixes and properties are displayed + as the proposals with a description of each one.</para> <figure float="0"> <title>Content Assist for Properties Names</title> <mediaobject> @@ -1830,8 +1831,8 @@ </imageobject> </mediaobject> </figure> - <para>In the <property moreinfo="none">Source</property><diffmk:wrapper diffmk:change="changed"> view of the editor, content assist also could be - invoked both for properties names and values:</diffmk:wrapper></para> + <para>In the <property moreinfo="none">Source</property> view of the editor, content assist also could be + invoked both for properties names and values:</para> <figure float="0"> <title>Content Assist in the Source view</title> <mediaobject> @@ -1873,8 +1874,8 @@ <property moreinfo="none">.reveng.xml </property> </emphasis> file is opened. To get an initial <emphasis> <property moreinfo="none">reveng.xml </property> - </emphasis> file the <property moreinfo="none">Reverse Engineering File Wizard</property><diffmk:wrapper diffmk:change="changed"> can be started via - </diffmk:wrapper><emphasis> + </emphasis> file the <property moreinfo="none">Reverse Engineering File Wizard</property> can be started via + <emphasis> <property moreinfo="none">Ctrl+N</property> </emphasis> and <emphasis> <property moreinfo="none">Hibernate > Hibernate Reverse Engineering File (reveng.xml)</property> @@ -1912,8 +1913,8 @@ </figure> <para>The <emphasis> <property moreinfo="none">Table Filter</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> page allows you to specify which tables to include and exclude. Pressing - </diffmk:wrapper><emphasis> + </emphasis> page allows you to specify which tables to include and exclude. Pressing + <emphasis> <property moreinfo="none">Refresh</property> </emphasis> shows the tables from the database that have not yet been excluded.</para> <figure float="0"> @@ -1962,7 +1963,7 @@ </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">Now that you have configured all necessary parts, you can learn how to work with </diffmk:wrapper><property moreinfo="none">Hibernate Console Perspective</property>.</para> + <para>Now that you have configured all necessary parts, you can learn how to work with <property moreinfo="none">Hibernate Console Perspective</property>.</para> </section> <section id="hib_console"> <title>Hibernate Console Perspective</title> @@ -2023,10 +2024,10 @@ </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">To make </diffmk:wrapper><property moreinfo="none">Mapping Diagram</property> usage easier you can use <property moreinfo="none">Rules</property><diffmk:wrapper diffmk:change="changed">, </diffmk:wrapper><property moreinfo="none">Grid</property>,<property moreinfo="none">Snap to Geometry</property><diffmk:wrapper diffmk:change="changed"> - checkboxes in the </diffmk:wrapper><emphasis> + <para>To make <property moreinfo="none">Mapping Diagram</property> usage easier you can use <property moreinfo="none">Rules</property>, <property moreinfo="none">Grid</property>,<property moreinfo="none">Snap to Geometry</property> + checkboxes in the <emphasis> <property moreinfo="none">View</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> menu. </diffmk:wrapper></para> + </emphasis> menu. </para> <figure float="0"> <title>View menu</title> <mediaobject> @@ -2037,12 +2038,12 @@ </figure> <para>If you will select <emphasis> <property moreinfo="none">Rules</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> checkbox, the view print page scale will be added to the page. The numbers on - the scale show its size in inches.If you click on the scale a </diffmk:wrapper><emphasis> + </emphasis> checkbox, the view print page scale will be added to the page. The numbers on + the scale show its size in inches.If you click on the scale a <emphasis> <property moreinfo="none">Ruler Guide</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> will appear on the diagram. You can connect any diagram item to it.To connect + </emphasis> will appear on the diagram. You can connect any diagram item to it.To connect the items you should move their tops to the Ruler Guide. And while moving the ruler guide, - the items will be moved together with it as a whole.</diffmk:wrapper></para> + the items will be moved together with it as a whole.</para> <figure float="0"> <title>Moving the Ruler guide</title> <mediaobject> @@ -2065,8 +2066,8 @@ <para>The checkbox <emphasis> <property moreinfo="none">Snap to Geometry</property> </emphasis> helps to put the items of the diagram into allineation with the grid.</para> - <para>For better navigating through the diagram use <property moreinfo="none">Outline view</property><diffmk:wrapper diffmk:change="changed"> which - is available in the structural and graphical modes.</diffmk:wrapper></para> + <para>For better navigating through the diagram use <property moreinfo="none">Outline view</property> which + is available in the structural and graphical modes.</para> <figure float="0"> <title>Navigating in the Structural Mode</title> <mediaobject> @@ -2085,8 +2086,8 @@ </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">The options in the context menu of the mapping diagram are listed in the next - table.</diffmk:wrapper></para> + <para>The options in the context menu of the mapping diagram are listed in the next + table.</para> <table> <title>Context Menu Options of the Mapping Diagram</title> <tgroup cols="3"> @@ -2120,7 +2121,7 @@ <entry> <para>Show|Hide connections</para> </entry> - <entry><diffmk:wrapper diffmk:change="added">Allows to select what types of connections should be shown on the diagram: </diffmk:wrapper><itemizedlist> + <entry>Allows to select what types of connections should be shown on the diagram: <itemizedlist> <listitem> <para>Property Mappings</para> </listitem> @@ -2140,27 +2141,27 @@ <para></para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Select All</diffmk:wrapper></para> + <para>Select All</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Makes all the diagram elements selected</diffmk:wrapper></para> + <para>Makes all the diagram elements selected</para> </entry> </row> <row> <entry> <para> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/autoLayout.png"></imagedata> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/autoLayout.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Auto layout</diffmk:wrapper></para> + <para>Auto layout</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Used to dispose all the items of the diagram in a standard manner</diffmk:wrapper></para> + <para>Used to dispose all the items of the diagram in a standard manner</para> </entry> </row> <row> @@ -2177,8 +2178,8 @@ <para>Export as Image</para> </entry> <entry> - <para>Allows to export a diagram as <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">.png - </diffmk:wrapper></property>,</emphasis> + <para>Allows to export a diagram as <emphasis><property moreinfo="none">.png + </property>,</emphasis> <emphasis> <property moreinfo="none">.jpeg</property> </emphasis> or <emphasis> @@ -2189,8 +2190,8 @@ </tbody> </tgroup> </table> - <para><diffmk:wrapper diffmk:change="changed">When you open the context menu while clicking an item on the diagram, it quite differs - from the one described before.</diffmk:wrapper></para> + <para>When you open the context menu while clicking an item on the diagram, it quite differs + from the one described before.</para> <figure float="0"> <title>Context Menu in Mapping Item</title> <mediaobject> @@ -2225,17 +2226,17 @@ <para> <inlinemediaobject> <imageobject> - <imagedata fileref="images/plugins/openSourceFile_but.png"/> + <imagedata fileref="images/plugins/openSourceFile_but.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Open Source File</diffmk:wrapper></para> + <para>Open Source File</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Makes it possible to open a source file for a chosen object/element. The - selected element will be highlighted in the open file.</diffmk:wrapper></para> + <para>Makes it possible to open a source file for a chosen object/element. The + selected element will be highlighted in the open file.</para> </entry> </row> <row> @@ -2243,17 +2244,17 @@ <para> <inlinemediaobject> <imageobject> - <imagedata fileref="images/plugins/openMappingFile_but.png"/> + <imagedata fileref="images/plugins/openMappingFile_but.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Open Mapping File</diffmk:wrapper></para> + <para>Open Mapping File</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Makes it possible to open a mapping file for a chosen object/element. The - selected element will be highlighted in the open file.</diffmk:wrapper></para> + <para>Makes it possible to open a mapping file for a chosen object/element. The + selected element will be highlighted in the open file.</para> </entry> </row> <row> @@ -2261,16 +2262,16 @@ <para> <inlinemediaobject> <imageobject> - <imagedata fileref="images/plugins/visibleState.png"/> + <imagedata fileref="images/plugins/visibleState.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Show|Hide shape(s)</diffmk:wrapper></para> + <para>Show|Hide shape(s)</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Used to hide/show an item on the mapping diagram</diffmk:wrapper></para> + <para>Used to hide/show an item on the mapping diagram</para> </entry> </row> <row> @@ -2278,16 +2279,16 @@ <para> <inlinemediaobject> <imageobject> - <imagedata fileref="images/plugins/expandState.png"/> + <imagedata fileref="images/plugins/expandState.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Expand|Collapse shape(s)</diffmk:wrapper></para> + <para>Expand|Collapse shape(s)</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Used for expanding/collapsing fields of the item</diffmk:wrapper></para> + <para>Used for expanding/collapsing fields of the item</para> </entry> </row> </tbody> @@ -2297,8 +2298,8 @@ <title>Tip:</title> <para>All the described types of the context menu are also available in the <property moreinfo="none">Outline</property> view.</para> </tip> - <para><diffmk:wrapper diffmk:change="changed">The below table lists the actions that could be performed using the keyboard keys (or - keys combinations).</diffmk:wrapper></para> + <para>The below table lists the actions that could be performed using the keyboard keys (or + keys combinations).</para> <table> <title>Hibernate Mapping Diagram Shortcut Keys</title> <tgroup cols="2"> @@ -2358,13 +2359,13 @@ </tbody> </tgroup> </table> - <para><diffmk:wrapper diffmk:change="changed">It's possible to save the diagram in the eclipse workspace. Click the usual - </diffmk:wrapper><emphasis> + <para>It's possible to save the diagram in the eclipse workspace. Click the usual + <emphasis> <property moreinfo="none">File > Save As</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> option, the wizard will ask you to set the location within you project where + </emphasis> option, the wizard will ask you to set the location within you project where to save the file and give the name for the diagram. The item's names concatenated with the ampersand symbols are set as the default name for a diagram. The file is saved - with the </diffmk:wrapper><literal moreinfo="none">.hibernate</literal> extension.</para> + with the <literal moreinfo="none">.hibernate</literal> extension.</para> <figure float="0"> <title>The Diagram saved in the Workspace</title> <mediaobject> @@ -2375,9 +2376,9 @@ </figure> <tip> <title>Note:</title> - <para><diffmk:wrapper diffmk:change="changed">If you restart the Eclipse with the mapping diagram opened, the mapping diagram will + <para>If you restart the Eclipse with the mapping diagram opened, the mapping diagram will be restored with the message like on the figure below. To view the diagram content, you - should perform the refreshing.</diffmk:wrapper></para> + should perform the refreshing.</para> </tip> <figure float="0"> <title>The Diagram after Restarting the Eclipse</title> @@ -2395,141 +2396,141 @@ </imageobject> </mediaobject> </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">There are some useful commands in the toolbar.</diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Diagram View Toolbar</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/diagramToolbar.png"></imagedata> + <para>There are some useful commands in the toolbar.</para> + <figure float="0"> + <title>The Diagram View Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagramToolbar.png"></imagedata> </imageobject> </mediaobject> </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">They are described in the table below.</diffmk:wrapper></para> - <table diffmk:change="added"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Command in Diagram View Toolbar </diffmk:wrapper></title> - <tgroup cols="3" diffmk:change="added"> - <colspec align="left" colnum="1" colwidth="1*" diffmk:change="added"></colspec> - <colspec align="left" colnum="2" colwidth="1*" diffmk:change="added"></colspec> - <colspec align="left" colnum="3" colwidth="3*" diffmk:change="added"></colspec> - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry align="center" diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Icon</diffmk:wrapper></para> + <para>They are described in the table below.</para> + <table> + <title>Command in Diagram View Toolbar </title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="1*"></colspec> + <colspec align="left" colnum="3" colwidth="3*"></colspec> + <thead> + <row> + <entry align="center"> + <para>Icon</para> </entry> - <entry align="center" diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Command</diffmk:wrapper></para> + <entry align="center"> + <para>Command</para> </entry> - <entry align="center" diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></para> + <entry align="center"> + <para>Description</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> - <para diffmk:change="added"> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/toolbarRefresh.png"></imagedata> + <tbody> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarRefresh.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Refresh Visual Mapping</diffmk:wrapper></para> + <entry> + <para>Refresh Visual Mapping</para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">It update </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Mapping Diagram</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> if </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Console - Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> was changed. </diffmk:wrapper></para> + <entry> + <para>It update <property moreinfo="none">Mapping Diagram</property> if <property moreinfo="none">Console + Configuration</property> was changed. </para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> - <para diffmk:change="added"> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/toolbarZoom.png"></imagedata> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarZoom.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Zoom Box</diffmk:wrapper></para> + <entry> + <para>Zoom Box</para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to define scale of the diagram. Also it's used for </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Mapping - Diagram</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> printing. If you want to put the whole </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">diagram</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to one print page, you need select </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Page</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> option in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Zoom Box</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <entry> + <para>Used to define scale of the diagram. Also it's used for <property moreinfo="none">Mapping + Diagram</property> printing. If you want to put the whole <property moreinfo="none">diagram</property> to one print page, you need select <property moreinfo="none">Page</property> option in the <property moreinfo="none">Zoom Box</property>.</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> - <para diffmk:change="added"> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/toolbarAutolayout.png"></imagedata> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarAutolayout.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Auto layout</diffmk:wrapper></para> + <entry> + <para>Auto layout</para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to arrange all diagram items in a standard manner.</diffmk:wrapper></para> + <entry> + <para>Used to arrange all diagram items in a standard manner.</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> - <para diffmk:change="added"> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/toolbarShowHideConnections.png"></imagedata> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarShowHideConnections.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Show|Hide connections</diffmk:wrapper></para> + <entry> + <para>Show|Hide connections</para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to show or hide connection on the diagram. Moreover you can choose what - type of connections must be present on the diagram (</diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Property - Mappings</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Class Mappings</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Associations</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Foreign key constraints</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">) - .</diffmk:wrapper></para> + <entry> + <para>Used to show or hide connection on the diagram. Moreover you can choose what + type of connections must be present on the diagram (<property moreinfo="none">Property + Mappings</property>, <property moreinfo="none">Class Mappings</property>, <property moreinfo="none">Associations</property> or <property moreinfo="none">Foreign key constraints</property>) + .</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> - <para diffmk:change="added"> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/toolbarExpandCollapse.png"></imagedata> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarExpandCollapse.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Expand|Collapse</diffmk:wrapper></para> + <entry> + <para>Expand|Collapse</para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used for expanding/collapsing fields of the item.</diffmk:wrapper></para> + <entry> + <para>Used for expanding/collapsing fields of the item.</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> - <para diffmk:change="added"> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/toolbarShowHideShapes.png"></imagedata> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarShowHideShapes.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Show|Hide shape(s)</diffmk:wrapper></para> + <entry> + <para> Show|Hide shape(s)</para> </entry> - <entry diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to hide/show an item on the mapping diagram.</diffmk:wrapper></para> + <entry> + <para>Used to hide/show an item on the mapping diagram.</para> </entry> </row> </tbody> @@ -2540,14 +2541,14 @@ <section> <title>Prototyping Queries</title> <para>Queries can be prototyped by entering them into the <property moreinfo="none">HQL</property> or - <property moreinfo="none">Criteria Editor</property><diffmk:wrapper diffmk:change="changed">. To execute a query you should click the green run - button in the editor toolbar or press </diffmk:wrapper><emphasis> + <property moreinfo="none">Criteria Editor</property>. To execute a query you should click the green run + button in the editor toolbar or press <emphasis> <property moreinfo="none">Ctrl+Enter</property> </emphasis>.</para> <section id="hql_and_criteria_editors"> <title>HQL Editor and Hibernate Criteria Editor</title> - <para><diffmk:wrapper diffmk:change="changed">To open the query editors right-click your project </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Console - Configuration</diffmk:wrapper></property> and select <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">HQL Editor</diffmk:wrapper></property> (or <property moreinfo="none">Hibernate Criteria Editor</property>).</para> + <para>To open the query editors right-click your project <property moreinfo="none">Console + Configuration</property> and select <property moreinfo="none">HQL Editor</property> (or <property moreinfo="none">Hibernate Criteria Editor</property>).</para> <figure float="0"> <title>Opening HQL Editor</title> <mediaobject> @@ -2558,93 +2559,93 @@ </figure> <tip> <title>Tip:</title> - <para>If the context menu items are disabled then you need at first to create a <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Session Factory</diffmk:wrapper></property>. That is done by simply expanding the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Session - Factory</diffmk:wrapper></property> node.</para> + <para>If the context menu items are disabled then you need at first to create a <property moreinfo="none">Session Factory</property>. That is done by simply expanding the <property moreinfo="none">Session + Factory</property> node.</para> </tip> - <para><diffmk:wrapper diffmk:change="changed">When open the editors they should automatically detect the chosen Console - Configuration.</diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change="changed">To get a prefill query for any entity (or any entity child node) listed in the - </diffmk:wrapper><emphasis> + <para>When open the editors they should automatically detect the chosen Console + Configuration.</para> + <para>To get a prefill query for any entity (or any entity child node) listed in the + <emphasis> <property moreinfo="none">Session Factory</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> you should double-click it. This will open the </diffmk:wrapper><property moreinfo="none">HQL Editor</property><diffmk:wrapper diffmk:change="changed"> - with the associated query.</diffmk:wrapper></para> + </emphasis> you should double-click it. This will open the <property moreinfo="none">HQL Editor</property> + with the associated query.</para> <para>Choosing <emphasis> <property moreinfo="none">HQL Editor</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> in the context menu for any entity (or any entity child node) will also open - the HQL editor with the associated query. If you choose </diffmk:wrapper><emphasis> + </emphasis> in the context menu for any entity (or any entity child node) will also open + the HQL editor with the associated query. If you choose <emphasis> <property moreinfo="none">Hibernate Criteria Editor</property> - </emphasis> in the context menu, it will open <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Criteria - Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> with the associated criteria.</diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> + </emphasis> in the context menu, it will open <property moreinfo="none">Hibernate Criteria + Editor</property> with the associated criteria.</para> + <figure float="0"> <title>Generating Simple Queries</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG" scale="80"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG"></imagedata> </imageobject> </mediaobject> </figure> <para>It's also possible to copy a portion of code from <emphasis> <property moreinfo="none">.java</property> - </emphasis> file into the <property moreinfo="none">HQL</property><diffmk:wrapper diffmk:change="changed"> or </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Criteria - editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">. To do this make use of the Quick Fix option (</diffmk:wrapper><emphasis> + </emphasis> file into the <property moreinfo="none">HQL</property> or <property moreinfo="none">Criteria + editor</property>. To do this make use of the Quick Fix option (<emphasis> <property moreinfo="none">Ctrl + 1</property>)</emphasis>.</para> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title>Quick Fix Option Demonstration</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <imagedata fileref="images/plugins/plugins_19_b.png"></imagedata> </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">You can also update the original java code according to changes in the HQL or Criteria + <para>You can also update the original java code according to changes in the HQL or Criteria editor. For that you should save your HQL/Criteria query and submit the replacing in - appeared confirmation dialog.</diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> + appeared confirmation dialog.</para> + <figure float="0"> <title>Updating Java Code</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <imagedata fileref="images/plugins/plugins_19_c.png"></imagedata> </imageobject> </mediaobject> </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Also you can pin </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">HQL editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Criteria - editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> for one tab in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Query Result</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view. For - that you need click on </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Stick result to one tab</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> - button(</diffmk:wrapper><inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/sticky_but.png"></imagedata> + <para>Also you can pin <property moreinfo="none">HQL editor</property> and <property moreinfo="none">Criteria + editor</property> for one tab in <property moreinfo="none">Hibernate Query Result</property> view. For + that you need click on <property moreinfo="none">Stick result to one tab</property> + button(<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/sticky_but.png"></imagedata> </imageobject> - </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ). In the issue query executions results will be shown in one tab (no - more will be opened). </diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Moreover you are able to rename tab in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Query Result</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. - Click the tab, and type a new name in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Property View->Tab name field</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tab Renaming</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/plugins_19_d.png"></imagedata> + </inlinemediaobject> ). In the issue query executions results will be shown in one tab (no + more will be opened). </para> + <para> Moreover you are able to rename tab in <property moreinfo="none">Hibernate Query Result</property>. + Click the tab, and type a new name in <property moreinfo="none">Property View->Tab name field</property>. </para> + <figure float="0"> + <title>Tab Renaming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_d.png"></imagedata> </imageobject> </mediaobject> </figure> </section> <section> <title>Error Handling</title> - <para>Errors during creation of the <property moreinfo="none">Session Factory</property><diffmk:wrapper diffmk:change="changed"> or running the + <para>Errors during creation of the <property moreinfo="none">Session Factory</property> or running the queries (e.g. if your configuration or query is incorrect) will be shown in a message dialog or inclined in the view that detected the error, you may get more information about - the error in the </diffmk:wrapper><property moreinfo="none">Error Log View</property> on the right pane.</para> - <para>Results of a query will be shown in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Query Result - View</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> and details of possible errors (syntax errors, database errors, etc.) - can be seen in the </diffmk:wrapper><property moreinfo="none">Error Log View</property>.</para> - <note diffmk:change="added"> + the error in the <property moreinfo="none">Error Log View</property> on the right pane.</para> + <para>Results of a query will be shown in the <property moreinfo="none">Hibernate Query Result + View</property> and details of possible errors (syntax errors, database errors, etc.) + can be seen in the <property moreinfo="none">Error Log View</property>.</para> + <note> <title>Note:</title> - <para>HQL queries are executed by default using <literal moreinfo="none">list()</literal><diffmk:wrapper diffmk:change="changed"> thus without any + <para>HQL queries are executed by default using <literal moreinfo="none">list()</literal> thus without any limit of the size of the output the query could return a large result set. You might run out of memory. To avoid this you can put a value in the Max results field to reduce the - number of elements returned.</diffmk:wrapper></para> + number of elements returned.</para> </note> </section> <section> @@ -2669,8 +2670,8 @@ </section> <section> <title>Properties View</title> - <para>As you can see on the figure,when clicking on class/entity <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Properties - view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> shows the number of query results as well as the time of executing.</diffmk:wrapper></para> + <para>As you can see on the figure,when clicking on class/entity <property moreinfo="none">Properties + view</property> shows the number of query results as well as the time of executing.</para> <figure float="0"> <title>Properties View</title> <mediaobject> @@ -2682,7 +2683,7 @@ </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">It also displays the structure of any persistent object selected in the </diffmk:wrapper><property moreinfo="none">Hibernate Query Results View</property>. Editing is not yet supported.</para> + <para>It also displays the structure of any persistent object selected in the <property moreinfo="none">Hibernate Query Results View</property>. Editing is not yet supported.</para> <figure float="0"> <title>Properties View for Selected Object</title> <mediaobject> @@ -2694,14 +2695,14 @@ </imageobject> </mediaobject> </figure> - <para>You can also use <property moreinfo="none">Properties view</property><diffmk:wrapper diffmk:change="changed"> when clicking on the configuration - itself in Hibernate Configuration View( </diffmk:wrapper><link linkend="modif_console_conf"><diffmk:wrapper diffmk:change="changed">Modifying a - Hibernate Console Configuration section</diffmk:wrapper></link>). </para> + <para>You can also use <property moreinfo="none">Properties view</property> when clicking on the configuration + itself in Hibernate Configuration View( <link linkend="modif_console_conf">Modifying a + Hibernate Console Configuration section</link>). </para> </section> </section> <section id="jpa_annotations"> - <title><diffmk:wrapper diffmk:change="changed">Hibernate:add JPA annotations refactoring </diffmk:wrapper></title> - <para><diffmk:wrapper diffmk:change="changed">Using this wizard you can add the next Hibernate annotations to the class: </diffmk:wrapper><emphasis> + <title>Hibernate:add JPA annotations refactoring </title> + <para>Using this wizard you can add the next Hibernate annotations to the class: <emphasis> <property moreinfo="none">@Column</property> </emphasis>,<emphasis> <property moreinfo="none">@Entity</property> @@ -2743,7 +2744,7 @@ <property moreinfo="none">@OneToOne</property> </emphasis>,<emphasis> <property moreinfo="none">@ManyToMany</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> - this annotations are declared according to the classes hierarchy.</diffmk:wrapper></para> + </emphasis> - this annotations are declared according to the classes hierarchy.</para> </listitem> <listitem> <para><emphasis> @@ -2755,113 +2756,113 @@ <property moreinfo="none">@Id</property> </emphasis>,<emphasis> <property moreinfo="none">@GeneratedValue</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> are added automatically only to the properties under the name "Id",where they - don't present.</diffmk:wrapper></para> + </emphasis> are added automatically only to the properties under the name "Id",where they + don't present.</para> </listitem> <listitem> <para><emphasis> <property moreinfo="none">@Version</property> - </emphasis> is declared in case you select <link linkend="optim_lock"><diffmk:wrapper diffmk:change="changed">Enable optimistic - locking</diffmk:wrapper></link>.</para> + </emphasis> is declared in case you select <link linkend="optim_lock">Enable optimistic + locking</link>.</para> </listitem> </itemizedlist> <note> <title>Note:</title> - <para><diffmk:wrapper diffmk:change="changed">This section doesn't cover the meaning of the </diffmk:wrapper><property moreinfo="none">Hibernate annotations</property> - , for more information read <ulink url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/"><diffmk:wrapper diffmk:change="changed">Hibernate - Annotations Documentation</diffmk:wrapper></ulink> .</para> + <para>This section doesn't cover the meaning of the <property moreinfo="none">Hibernate annotations</property> + , for more information read <ulink url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/">Hibernate + Annotations Documentation</ulink> .</para> </note> - <para><diffmk:wrapper diffmk:change="changed">To open this wizard you should right click the class you want to enrich with annotations - </diffmk:wrapper><emphasis> + <para>To open this wizard you should right click the class you want to enrich with annotations + <emphasis> <property moreinfo="none">>Source>Generate Hibernate/JPA annotations</property> - </emphasis><diffmk:wrapper diffmk:change="changed">. You will see the Hibernate:add JPA annotations dialog. </diffmk:wrapper></para> + </emphasis>. You will see the Hibernate:add JPA annotations dialog. </para> <figure float="0"> - <title><diffmk:wrapper diffmk:change="changed">Starting Hibernate:add JPA annotations dialog</diffmk:wrapper></title> + <title>Starting Hibernate:add JPA annotations dialog</title> <mediaobject> <imageobject> <imagedata fileref="images/plugins/annotations1.png"></imagedata> </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="added"> In the top of it you can see the list of all classes that will be passed through + <para> In the top of it you can see the list of all classes that will be passed through refactoring. Besides the class you have selected in this list you can also find its superclasses and the classes that objects present in the current class as properties. If you - want to add new classes or package to the list of classes, you should click the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Back</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. In result you will see </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add classes and - packages</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> page.</diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Add classes and packages page </diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/annotations1_a.png"></imagedata> + want to add new classes or package to the list of classes, you should click the <property moreinfo="none">Back</property> button. In result you will see <property moreinfo="none">Add classes and + packages</property> page.</para> + <figure float="0"> + <title>Add classes and packages page </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations1_a.png"></imagedata> </imageobject> </mediaobject> </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Here you can add one more classes or whole package, moreover you can limit dependencies - depth by selecting </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">depth control</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> option (more about this option you will - find in </diffmk:wrapper><link diffmk:change="added" linkend="depth_control"><diffmk:wrapper diffmk:change="added">Creating a Hibernate Mapping File</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">). When finished - just press the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button and you will be returned to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">The - following classes will be changed</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> page and will be able to continue work with - it.</diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change="changed">By default the tags are added to the fields of selected classes. But you can change this - option to </diffmk:wrapper><emphasis> + <para>Here you can add one more classes or whole package, moreover you can limit dependencies + depth by selecting <property moreinfo="none">depth control</property> option (more about this option you will + find in <link linkend="depth_control">Creating a Hibernate Mapping File</link>). When finished + just press the <property moreinfo="none">Next</property> button and you will be returned to <property moreinfo="none">The + following classes will be changed</property> page and will be able to continue work with + it.</para> + <para>By default the tags are added to the fields of selected classes. But you can change this + option to <emphasis> <property moreinfo="none">Getters</property> </emphasis>in <emphasis> <property moreinfo="none"> Preferred location of Annotations</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> dropdownlist and then all the annotations will be added to the getter methods. If - you choose </diffmk:wrapper><emphasis> + </emphasis> dropdownlist and then all the annotations will be added to the getter methods. If + you choose <emphasis> <property moreinfo="none">Auto select from class preference</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> then the annotations are added according to the majority of the already existed - ones positions. </diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change="changed"> If it's nessecary to map your String properties to the columns that length differ from - the default value(255) ,change </diffmk:wrapper><emphasis> + </emphasis> then the annotations are added according to the majority of the already existed + ones positions. </para> + <para> If it's nessecary to map your String properties to the columns that length differ from + the default value(255) ,change <emphasis> <property moreinfo="none">Default string length field</property> - </emphasis> and <code>@Column(length = your length)</code><diffmk:wrapper diffmk:change="changed"> will be created before every String - property. </diffmk:wrapper></para> - <para id="optim_lock"><diffmk:wrapper diffmk:change="changed">You can add optimistic locking capability to an entity bean by selecting - </diffmk:wrapper><emphasis> + </emphasis> and <code>@Column(length = your length)</code> will be created before every String + property. </para> + <para id="optim_lock">You can add optimistic locking capability to an entity bean by selecting + <emphasis> <property moreinfo="none">Enable optimistic locking</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> checkbox. This operation will add version property to all the selected classes. + </emphasis> checkbox. This operation will add version property to all the selected classes. The property will be also annotated with @Version ,getter and setter will be created. If the property is already exists,it won't be created ,but the getters,setters will be generated. If there is already @MappedSuperclass with version in the base class of the current class - - </diffmk:wrapper><emphasis> + <emphasis> <property moreinfo="none">"version"</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> is not inserted into the current class. </diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change="changed">After defining all necessary settings in the current step press </diffmk:wrapper><emphasis> + </emphasis> is not inserted into the current class. </para> + <para>After defining all necessary settings in the current step press <emphasis> <property moreinfo="none">Next</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> and follow the next wizard steps. </diffmk:wrapper></para> + </emphasis> and follow the next wizard steps. </para> <figure float="0"> <title>Hibernate:add JPA annotations view</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <imagedata fileref="images/plugins/annotations2.png"></imagedata> </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">The view represents two windows: one with the source code and and the second with - refactored one. With the help of </diffmk:wrapper><inlinemediaobject> - <imageobject diffmk:change="added"> + <para>The view represents two windows: one with the source code and and the second with + refactored one. With the help of <inlinemediaobject> + <imageobject> <imagedata fileref="images/plugins/butt1.png"></imagedata> </imageobject> </inlinemediaobject> ,<inlinemediaobject> - <imageobject diffmk:change="added"> + <imageobject> <imagedata fileref="images/plugins/butt2.png"></imagedata> </imageobject> </inlinemediaobject> ,<inlinemediaobject> - <imageobject diffmk:change="added"> + <imageobject> <imagedata fileref="images/plugins/butt3.png"></imagedata> </imageobject> </inlinemediaobject> ,<inlinemediaobject> - <imageobject diffmk:change="added"> + <imageobject> <imagedata fileref="images/plugins/butt4.png"></imagedata> </imageobject> - </inlinemediaobject><diffmk:wrapper diffmk:change="changed"> buttons you can quickly navigate between the differences in the code. If + </inlinemediaobject> buttons you can quickly navigate between the differences in the code. If you don't agree with some changes you can't undo them but you can remove the class from the - list of classes that need refactoring. </diffmk:wrapper></para> + list of classes that need refactoring. </para> <figure float="0"> <title>List of classes that need refactoring</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <imagedata fileref="images/plugins/annotations3.png"></imagedata> </imageobject> </mediaobject> @@ -2874,10 +2875,10 @@ <title>Enable debug logging in the plugins</title> <para>It is possible to configure the eclipse plugin to route all logging made by the plugins and hibernate code it self to the <property moreinfo="none">Error Log View</property> in Eclipse.</para> - <para><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Error Log View</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is very useful tool to solve any problem which appears in Hibernate Tools Plugins. - You can use if there are troubles with setting up </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Console Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> - <para diffmk:change="added">This is done by editing the <emphasis> - <property moreinfo="none">hibernate-log4j.properties</property> + <para><property moreinfo="none">Error Log View</property><diffmk:wrapper diffmk:change="changed"> is very useful tool to solve any problem which appears + in Hibernate Tools Plugins. You can use if there are troubles with setting up </diffmk:wrapper><property moreinfo="none">Hibernate Console Configuration</property>.</para> + <para>This is done by editing the <emphasis> + <property moreinfo="none">hibernate-log4j.properties</property> </emphasis> in <emphasis> <property moreinfo="none">org.hibernate.eclipse/ directory/jar</property> </emphasis>. This file includes a default configuration that only logs WARN and above to a set @@ -2893,191 +2894,193 @@ <para>Starting from 3.0.0 Alpha1 version of <property moreinfo="none">JBoss Tools</property> Hibernate plugins support Eclipse Dali integration what now makes it possible to use a Hibernate as a complete JPA development platform.</para> - <section diffmk:change="added" id="jpa_project_with_hibernate"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating JPA project with Hibernate support</diffmk:wrapper></title> - <para>When starting a new JPA project from <emphasis> - <property moreinfo="none">New > Other > JPA > JPA Project</property> - </emphasis> (or simply <emphasis> - <property moreinfo="none">New > JPA Project</property> - </emphasis> in <property moreinfo="none">JPA Perspective</property>), the first wizard page looks as - follows.</para> - <figure float="0"> - <title>Starting JPA Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para><diffmk:wrapper diffmk:change="changed">It's possible here to select a target runtime and change the project configuration, - or you can leave everything as it is.</diffmk:wrapper></para> - <para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the - proper database connection, if it is defined, or add a new one by clicking the <emphasis> - <property moreinfo="none">Add connection</property> - </emphasis> link.</para> - <para>Hitting <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> will generate the project.</para> - <figure float="0"> - <title>Targeting at Hibernate Platform</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - <para><diffmk:wrapper diffmk:change="changed">Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, a - Hibernate Console Configuration for the project is created automatically when the wizard - finishes its work. It allows a full usage of </diffmk:wrapper><property moreinfo="none">Hibernate Tools</property><diffmk:wrapper diffmk:change="changed"> features - without additional setup.</diffmk:wrapper></para> - </note> + <section id="jpa_project_with_hibernate"> + <title>Creating JPA project with Hibernate support</title> + <para>When starting a new JPA project from <emphasis> + <property moreinfo="none">New > Other > JPA > JPA Project</property> + </emphasis> (or simply <emphasis> + <property moreinfo="none">New > JPA Project</property> + </emphasis> in <property moreinfo="none">JPA Perspective</property><diffmk:wrapper diffmk:change="changed">), the first wizard page looks as + follows.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title>Starting JPA Project</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><diffmk:wrapper diffmk:change="changed">It's possible here to select a target runtime and change the project configuration, + or you can leave everything as it is.</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="changed">On the JPA Facet page you should choose Hibernate as a target platform. Also select the + proper database connection, if it is defined, or add a new one by clicking the </diffmk:wrapper><emphasis> + <property moreinfo="none">Add connection</property> + </emphasis> link.</para> + <para>Hitting <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> will generate the project.</para> + <figure diffmk:change="added" float="0"> + <title>Targeting at Hibernate Platform</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note diffmk:change="added"> + <title>Note:</title> + <para><diffmk:wrapper diffmk:change="changed">Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, + a Hibernate Console Configuration for the project is created automatically when the wizard + finishes its work. It allows a full usage of </diffmk:wrapper><property moreinfo="none">Hibernate Tools</property><diffmk:wrapper diffmk:change="changed"> features + without additional setup.</diffmk:wrapper></para> + </note> </section> - <section diffmk:change="added" id="generate_ddl_entities_with_hibernate"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Generating DDL and Entities</diffmk:wrapper></title> - <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. - For that find <emphasis> - <property moreinfo="none">JPA Tools > Generate Tables from Entities/Generate Entities from Tables</property> - </emphasis> options in the context menu of your JPA project.</para> - <figure float="0"> - <title>Generate DDL/Entities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - <para>Please, remember to put the proper database driver to the classpath of your - project.</para> - </note> - <para>The <property moreinfo="none">Generate Entities wizard</property><diffmk:wrapper diffmk:change="changed"> first will ask you to choose the - directory where all output will be written.</diffmk:wrapper></para> - <figure float="0"> - <title>Generate Entities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>To generate entities you can use:</para> - <itemizedlist> - <listitem> - <para>a Hibernate Console Configuration (proposed by default)</para> - <para>Just make sure that the <emphasis> - <property moreinfo="none">Use Console Configuration</property> - </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> - <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Console configurations</diffmk:wrapper></property> - </emphasis> list box.</para> - <figure float="0"> - <title>Generate Entities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para>or a DTP connection directly</para> - <para>Just uncheck <emphasis> - <property moreinfo="none">Use Console Configuration</property> - </emphasis> and adjust database settings.</para> - </listitem> - </itemizedlist> - <para><diffmk:wrapper diffmk:change="changed">All the same you do with Generate Entities Wizard you can do with Generate DDL wizard. - Special feature for Generate DDL wizard is possible automatic execution of Generation DDL in - the database. </diffmk:wrapper></para> - <figure float="0"> - <title>Generate DDL Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para> - </section> - <section diffmk:change="added" id="hibernate_annotations_support"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Hibernate Annotations Support</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Also Hibernate Annotations are supported in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Dali Java Persistence Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. - The next annotations are integrated with </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JPA Details</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view:</diffmk:wrapper></para> - <itemizedlist diffmk:change="added"> - <listitem diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Id Generator annotations - </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@GenericGenerator</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@GeneratedValue</diffmk:wrapper></property></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">@GenericGenerator support in Dali</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/dali_integration7.png"></imagedata> - + <section id="generate_ddl_entities_with_hibernate"> + <title>Generating DDL and Entities</title> + <para><diffmk:wrapper diffmk:change="changed">By enabling Hibernate platform specific features you can now generate DDL and Entities. + For that find </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JPA Tools > Generate Tables from Entities/Generate Entities from + Tables</diffmk:wrapper></property> + </emphasis> options in the context menu of your JPA project.</para> + <figure diffmk:change="added" float="0"> + <title>Generate DDL/Entities</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note diffmk:change="added"> + <title>Note:</title> + <para><diffmk:wrapper diffmk:change="changed">Please, remember to put the proper database driver to the classpath of your + project.</diffmk:wrapper></para> + </note> + <para>The <property moreinfo="none">Generate Entities wizard</property><diffmk:wrapper diffmk:change="changed"> first will ask you to choose the + directory where all output will be written.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title>Generate Entities Wizard</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>To generate entities you can use:</para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para>a Hibernate Console Configuration (proposed by default)</para> + <para>Just make sure that the <emphasis> + <property moreinfo="none">Use Console Configuration</property> + </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> + <property moreinfo="none">Console configurations</property> + </emphasis> list box.</para> + <figure diffmk:change="added" float="0"> + <title>Generate Entities Wizard</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration5.png"></imagedata> </imageobject> - - </mediaobject> - </figure> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">@GeneratedValue support in Dali</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/dali_integration8.png"></imagedata> - </imageobject> - - </mediaobject> - </figure> - </listitem> - <listitem diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Property annotations- </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@DiscriminatorFormula</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@Generated Annotation</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@Index annotation</diffmk:wrapper></property></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">@Index support in Dali</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/dali_integration9.png"></imagedata> - </imageobject> - - </mediaobject> - </figure> - - </listitem> - <listitem diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Mapping Queries annotations - </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@NamedQuery</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@NamedNativeQuery</diffmk:wrapper></property></para> - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Add New Named Query Dialog with Hibernate Support</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/dali_integration10.png"></imagedata> - </imageobject> - - </mediaobject> - </figure> - - - - <figure diffmk:change="added" float="0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">@NamedQuery support in Dali</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/dali_integration11.png"></imagedata> - </imageobject> - - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">More information about Hibernate Annotation you can find in </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/"><diffmk:wrapper diffmk:change="added">Hibernate Annotations Reference Guide</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para> - - </section> - <section diffmk:change="added"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Relevant Resources Links</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">There is full information about native Dali plugin features on </diffmk:wrapper><ulink diffmk:change="added" url="http://help.eclipse.org/galileo/index.jsp?nav=/8"><diffmk:wrapper diffmk:change="added">Eclipse Documentation page</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para>or a DTP connection directly</para> + <para>Just uncheck <emphasis> + <property moreinfo="none">Use Console Configuration</property> + </emphasis> and adjust database settings.</para> + </listitem> + </itemizedlist> + <para><diffmk:wrapper diffmk:change="changed">All the same you do with Generate Entities Wizard you can do with Generate DDL wizard. + Special feature for Generate DDL wizard is possible automatic execution of Generation DDL in + the database. </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title>Generate DDL Wizard</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para> </section> - + <section id="hibernate_annotations_support"> + <title>Hibernate Annotations Support</title> + <para>Also Hibernate Annotations are supported in <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Dali Java Persistence + Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">. The next annotations are integrated with </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JPA + Details</diffmk:wrapper></property> view:</para> + <itemizedlist> + <listitem> + <para>Id Generator annotations - <property moreinfo="none">@GenericGenerator</property> and <property moreinfo="none">@GeneratedValue</property></para> + <figure float="0"> + <title>@GenericGenerator support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>@GeneratedValue support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Property annotations- <property moreinfo="none">@DiscriminatorFormula</property>, <property moreinfo="none">@Generated Annotation</property>, <property moreinfo="none">@Index annotation</property></para> + <figure float="0"> + <title>@Index support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Mapping Queries annotations - <property moreinfo="none">@NamedQuery</property> and <property moreinfo="none">@NamedNativeQuery</property></para> + <figure float="0"> + <title>Add New Named Query Dialog with Hibernate Support</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>@NamedQuery support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Association annotations in an </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">embeddable</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> object (</diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@OneToOne</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@ManyToOne</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@OneToMany</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@ManyToMany</diffmk:wrapper></property><diffmk:! wrapper diffmk:change="added">)</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Hibernate Support for Embeddable Object</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/plugins/dali_integration12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>More information about Hibernate Annotation you can find in <ulink url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/"><diffmk:wrapper diffmk:change="changed">Hibernate + Annotations Reference Guide</diffmk:wrapper></ulink>. </para> + </section> + <section> + <title>Relevant Resources Links</title> + <para>There is full information about native Dali plugin features on <ulink url="http://help.eclipse.org/galileo/index.jsp?nav=/8"><diffmk:wrapper diffmk:change="changed">Eclipse Documentation + page</diffmk:wrapper></ulink>.</para> + </section> </section> - </chapter> @@ -5803,9 +5806,9 @@ <para>The rest chapters have shown the aspects of using the <property moreinfo="none">Hibernate Tools</property> via Ant tasks.</para> - - <para>Please, visit <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss - Tools Users Forum</ulink> to leave questions or/and suggestions on the topic. Your + <para>Please, visit <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss + Tools Users Forum</ulink> to leave questions or/and suggestions on the topic. Your feedback is always appreciated.</para> </section> </section> Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/plugins.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/plugins.xml 2010-06-08 23:38:52 UTC (rev 22649) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/plugins.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -23,16 +23,21 @@ </note> <section id="download_base_project"> <title>Download base project</title> - <para>You can download example projects which are used as base for this chapter.</para> - <para><property>JPA base project</property> is available <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools/docs/refe...">here</ulink> - and base <property>Java project</property> is situated <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools/docs/refe...">here</ulink>.</para> - <para>Also you need start <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools/docs/refe...">database</ulink>.</para> + <para>You can download example projects which are used for this chapter.</para> + <para><property>JPA base project</property> is available on <ulink + url="http://docs.jboss.org/tools/resources/">documentation resources page </ulink> + together with <ulink + url="http://docs.jboss.org/tools/resources/TestHibernateproject_for_hibernate_..." + >base Java project</ulink>.</para> + <para>Also you need start <ulink url="http://docs.jboss.org/tools/resources/GSG_database.zip" + >database</ulink>.</para> <note> <title>Note:</title> - <para>How to run database you can know in <ulink url="http://docs.jboss.org/tools/3.0.1.GA/en/GettingStartedGuide/html/first_se...">Getting Started Guide</ulink>.</para> + <para>How to run database you can know in <ulink + url="http://docs.jboss.org/tools/3.0.1.GA/en/GettingStartedGuide/html/first_se..." + >Getting Started Guide</ulink>.</para> </note> </section> - </section> <section id="map_file_wizard"> <title>Creating a Hibernate Mapping File</title> @@ -46,9 +51,9 @@ <para>At first you'll be asked to select a package or multiple individual classes to map. It's also possible to create an empty file, don't select any packages or classes and an empty .hbm will be created in the specified location</para> - <para id="depth_control">With <property>depth control</property> option you can define dependences depth for - choosing classes (it means to set level of references which is used to collect linked classes - to the selection). </para> + <para id="depth_control">With <property>depth control</property> option you can define + dependences depth for choosing classes (it means to set level of references which is used to + collect linked classes to the selection). </para> <figure> <title>Hibernate XML Mapping File Wizard</title> <mediaobject> @@ -57,7 +62,10 @@ </imageobject> </mediaobject> </figure> - <para>The next wizard page lists the mappings to be generated. As you see <property>Customers</property>, <property>Orders</property>, <property>Productlines</property> and <property>Products</property> classes added under <property>depth control</property> driving. </para> + <para>The next wizard page lists the mappings to be generated. As you see <property + >Customers</property>, <property>Orders</property>, <property>Productlines</property> and + <property>Products</property> classes added under <property>depth control</property> + driving. </para> <figure> <title>Mappings to be generated</title> <mediaobject> @@ -66,7 +74,6 @@ </imageobject> </mediaobject> </figure> - <para>This wizard page outputs a generated .hbm files preview.</para> <figure> <title>Preview Generated Mapping Files</title> @@ -175,8 +182,8 @@ </figure> <para>The following table describes the available settings on the <emphasis> <property>Main</property> - </emphasis> tab. The wizard can automatically detect the default values for most of them if you - started the wizard with the relevant java project or resource selected.</para> + </emphasis> tab. The wizard can automatically detect the default values for most of them if + you started the wizard with the relevant java project or resource selected.</para> <table> <title>Hibernate Console Configuration Parameters</title> <tgroup cols="3"> @@ -276,8 +283,8 @@ <para>Name of the persistence unit to use</para> </entry> <entry> - <para>No default value (let Hibernate Entity Manager find the persistence unit or - it can be defined manually using Browse button)</para> + <para>No default value (let Hibernate Entity Manager find the persistence unit or it + can be defined manually using Browse button)</para> </entry> </row> </tbody> @@ -285,7 +292,7 @@ </table> <tip> <title>Tip:</title> - <para>The two latter settings are usually not required if you specify a project and it has + <para>The two latter settings are usually not required if you specify a project and it has <emphasis> <property> <literal> /hibernate.cfg.xml </literal> @@ -341,8 +348,8 @@ <para>Database dialect</para> </entry> <entry> - <para>Define a database dialect. It's possible either to write your value or choose - from list. </para> + <para>Define a database dialect. It's possible either to write your value or + choose from list. </para> </entry> <entry> <para>No default value</para> @@ -541,7 +548,8 @@ <listitem> <para>right-click on the configuration in <emphasis> <property>Hibernate Configurations View->Edit Configuration </property> - </emphasis> or just double-click on <property>Console Configuration</property> item.</para> + </emphasis> or just double-click on <property>Console Configuration</property> + item.</para> <figure> <title>Opening Edit Configuration Wizard</title> <mediaobject> @@ -663,8 +671,8 @@ <entry> <para>Choose between "CORE", "ANNOTATIONS" and "JPA" according to the method of relational mapping you want to - use. Note, the two latter requires running Eclipse IDE with a JDK 5 - runtime, otherwise you will get classloading and/or version errors.</para> + use. Note, the two latter requires running Eclipse IDE with a JDK 5 runtime, + otherwise you will get classloading and/or version errors.</para> </entry> <entry> <para>True</para> @@ -676,10 +684,10 @@ </listitem> </itemizedlist> </section> - <section id='closing_conf_config'> + <section id="closing_conf_config"> <title>Closing Hibernate Console Configuration</title> - <para>To close <property>Hibernate Console Configuration</property> you need do right-click your configuration - and choose <property>Close Configuration</property> option </para> + <para>To close <property>Hibernate Console Configuration</property> you need do right-click + your configuration and choose <property>Close Configuration</property> option </para> <figure> <title>Close Hibernate Console Configuration</title> <mediaobject> @@ -2451,10 +2459,11 @@ <title>Enable debug logging in the plugins</title> <para>It is possible to configure the eclipse plugin to route all logging made by the plugins and hibernate code it self to the <property>Error Log View</property> in Eclipse.</para> - <para><property>Error Log View</property> is very useful tool to solve any problem which appears in Hibernate Tools Plugins. - You can use if there are troubles with setting up <property>Hibernate Console Configuration</property>.</para> + <para><property>Error Log View</property> is very useful tool to solve any problem which appears + in Hibernate Tools Plugins. You can use if there are troubles with setting up <property + >Hibernate Console Configuration</property>.</para> <para>This is done by editing the <emphasis> - <property>hibernate-log4j.properties</property> + <property>hibernate-log4j.properties</property> </emphasis> in <emphasis> <property>org.hibernate.eclipse/ directory/jar</property> </emphasis>. This file includes a default configuration that only logs WARN and above to a set @@ -2475,187 +2484,196 @@ JPA development platform.</para> <section id="jpa_project_with_hibernate"> <title>Creating JPA project with Hibernate support</title> - <para>When starting a new JPA project from <emphasis> - <property>New > Other > JPA > JPA Project</property> - </emphasis> (or simply <emphasis> - <property>New > JPA Project</property> - </emphasis> in <property>JPA Perspective</property>), the first wizard page looks as - follows.</para> - <figure> - <title>Starting JPA Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration1.png"/> - </imageobject> - </mediaobject> - </figure> - <para>It's possible here to select a target runtime and change the project configuration, - or you can leave everything as it is.</para> - <para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the - proper database connection, if it is defined, or add a new one by clicking the <emphasis> - <property>Add connection</property> - </emphasis> link.</para> - <para>Hitting <emphasis> - <property>Finish</property> - </emphasis> will generate the project.</para> - <figure> - <title>Targeting at Hibernate Platform</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration2.png"/> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - <para>Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, a - Hibernate Console Configuration for the project is created automatically when the wizard - finishes its work. It allows a full usage of <property>Hibernate Tools</property> features - without additional setup.</para> - </note> + <para>When starting a new JPA project from <emphasis> + <property>New > Other > JPA > JPA Project</property> + </emphasis> (or simply <emphasis> + <property>New > JPA Project</property> + </emphasis> in <property>JPA Perspective</property>), the first wizard page looks as + follows.</para> + <figure> + <title>Starting JPA Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>It's possible here to select a target runtime and change the project configuration, + or you can leave everything as it is.</para> + <para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the + proper database connection, if it is defined, or add a new one by clicking the <emphasis> + <property>Add connection</property> + </emphasis> link.</para> + <para>Hitting <emphasis> + <property>Finish</property> + </emphasis> will generate the project.</para> + <figure> + <title>Targeting at Hibernate Platform</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration2.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, + a Hibernate Console Configuration for the project is created automatically when the wizard + finishes its work. It allows a full usage of <property>Hibernate Tools</property> features + without additional setup.</para> + </note> </section> - <section id="generate_ddl_entities_with_hibernate"> - <title>Generating DDL and Entities</title> - <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. - For that find <emphasis> - <property>JPA Tools > Generate Tables from Entities/Generate Entities from Tables</property> - </emphasis> options in the context menu of your JPA project.</para> - <figure> - <title>Generate DDL/Entities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration3.png"/> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - <para>Please, remember to put the proper database driver to the classpath of your - project.</para> - </note> - <para>The <property>Generate Entities wizard</property> first will ask you to choose the - directory where all output will be written.</para> - <figure> - <title>Generate Entities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration4.png"/> - </imageobject> - </mediaobject> - </figure> - <para>To generate entities you can use:</para> - <itemizedlist> - <listitem> - <para>a Hibernate Console Configuration (proposed by default)</para> - <para>Just make sure that the <emphasis> - <property>Use Console Configuration</property> - </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> - <property>Console configurations</property> - </emphasis> list box.</para> - <figure> - <title>Generate Entities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration5.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para>or a DTP connection directly</para> - <para>Just uncheck <emphasis> - <property>Use Console Configuration</property> - </emphasis> and adjust database settings.</para> - </listitem> - </itemizedlist> - <para>All the same you do with Generate Entities Wizard you can do with Generate DDL wizard. - Special feature for Generate DDL wizard is possible automatic execution of Generation DDL in - the database. </para> - <figure> - <title>Generate DDL Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration6.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para> - </section> - <section id="hibernate_annotations_support"> + <section id="generate_ddl_entities_with_hibernate"> + <title>Generating DDL and Entities</title> + <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. + For that find <emphasis> + <property>JPA Tools > Generate Tables from Entities/Generate Entities from + Tables</property> + </emphasis> options in the context menu of your JPA project.</para> + <figure> + <title>Generate DDL/Entities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration3.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>Please, remember to put the proper database driver to the classpath of your + project.</para> + </note> + <para>The <property>Generate Entities wizard</property> first will ask you to choose the + directory where all output will be written.</para> + <figure> + <title>Generate Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To generate entities you can use:</para> + <itemizedlist> + <listitem> + <para>a Hibernate Console Configuration (proposed by default)</para> + <para>Just make sure that the <emphasis> + <property>Use Console Configuration</property> + </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> + <property>Console configurations</property> + </emphasis> list box.</para> + <figure> + <title>Generate Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration5.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para>or a DTP connection directly</para> + <para>Just uncheck <emphasis> + <property>Use Console Configuration</property> + </emphasis> and adjust database settings.</para> + </listitem> + </itemizedlist> + <para>All the same you do with Generate Entities Wizard you can do with Generate DDL wizard. + Special feature for Generate DDL wizard is possible automatic execution of Generation DDL in + the database. </para> + <figure> + <title>Generate DDL Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para> + </section> + <section id="hibernate_annotations_support"> <title>Hibernate Annotations Support</title> - <para>Also Hibernate Annotations are supported in <property>Dali Java Persistence Tools</property>. - The next annotations are integrated with <property>JPA Details</property> view:</para> - <itemizedlist> - <listitem> - <para>Id Generator annotations - <property>@GenericGenerator</property> and <property>@GeneratedValue</property></para> - <figure> - <title>@GenericGenerator support in Dali</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration7.png"/> - + <para>Also Hibernate Annotations are supported in <property>Dali Java Persistence + Tools</property>. The next annotations are integrated with <property>JPA + Details</property> view:</para> + <itemizedlist> + <listitem> + <para>Id Generator annotations - <property>@GenericGenerator</property> and <property + >@GeneratedValue</property></para> + <figure> + <title>@GenericGenerator support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration7.png"/> </imageobject> - - </mediaobject> - </figure> - <figure> - <title>@GeneratedValue support in Dali</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration8.png"/> - </imageobject> - - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Property annotations- <property>@DiscriminatorFormula</property>, <property>@Generated Annotation</property>, <property>@Index annotation</property></para> - <figure> - <title>@Index support in Dali</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration9.png"/> - </imageobject> - - </mediaobject> - </figure> - - </listitem> - <listitem> - <para>Mapping Queries annotations - <property>@NamedQuery</property> and <property>@NamedNativeQuery</property></para> - <figure> - <title>Add New Named Query Dialog with Hibernate Support</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration10.png"/> - </imageobject> - - </mediaobject> - </figure> - - - - <figure> - <title>@NamedQuery support in Dali</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration11.png"/> - </imageobject> - - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>More information about Hibernate Annotation you can find in <ulink url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/">Hibernate Annotations Reference Guide</ulink>. </para> - - </section> + </mediaobject> + </figure> + <figure> + <title>@GeneratedValue support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration8.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Property annotations- <property>@DiscriminatorFormula</property>, <property + >@Generated Annotation</property>, <property>@Index annotation</property></para> + <figure> + <title>@Index support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration9.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Mapping Queries annotations - <property>@NamedQuery</property> and <property + >@NamedNativeQuery</property></para> + <figure> + <title>Add New Named Query Dialog with Hibernate Support</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration10.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>@NamedQuery support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration11.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Association annotations in an <property>embeddable</property> object (<property + >@OneToOne</property>, <property>@ManyToOne</property>, <property + >@OneToMany</property> or <property>@ManyToMany</property>)</para> + <figure> + <title>Hibernate Support for Embeddable Object</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration12.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>More information about Hibernate Annotation you can find in <ulink + url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/">Hibernate + Annotations Reference Guide</ulink>. </para> + </section> <section> <title>Relevant Resources Links</title> - <para>There is full information about native Dali plugin features on <ulink url="http://help.eclipse.org/galileo/index.jsp?nav=/8">Eclipse Documentation page</ulink>.</para> + <para>There is full information about native Dali plugin features on <ulink + url="http://help.eclipse.org/galileo/index.jsp?nav=/8">Eclipse Documentation + page</ulink>.</para> </section> - </section> - </chapter>

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22649 - in tags/jbosstools-3.1.1.GA/esb/docs: esb_ref_guide and 5 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 19:38:52 -0400 (Tue, 08 Jun 2010) New Revision: 22649 Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Author_Group.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Book_Info.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Feedback.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Preface.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Revision_History.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/08_esb_features.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/09_esb_features.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/10_esb_features.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12a_esb_editor.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12b_esb_editor.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12c_esb_editor.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn1.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn2.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/05a_esb_project_example.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/15AddNew.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/18_select_libraries.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/19_select_runtime.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/20_classpath_container.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/21_source.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/22_Javadoc.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/23_finger_touch.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/24_export_button.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/25_esb_file.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/26_esb_export.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/01_create_esb.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/02_create_esb.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/03_create_esb.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/04_create_esb.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/favicon.ico tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/jbosstools_logo.png tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/introduction.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/master.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/master_output.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/reference.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/summary.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/tasks.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/pom.xml tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/publican.cfg Log: uploading restructured esb guide Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Author_Group.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Author_Group.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Author_Group.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,5 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + <author><firstname>Tatyana</firstname><surname>Romanovich</surname></author></authorgroup> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Book_Info.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Book_Info.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Book_Info.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>ESB Tools Reference Guide</title><subtitle>Provides information relating to the ESB Tools set.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The ESB Tools Reference Guide explains how to use the ESB Tools to create ESB files quickly and with precision.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "ESB_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,14 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Feedback.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Feedback.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Feedback.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,20 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US"> + <title>We Need Feedback!</title> + <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + </indexterm> + <para> + If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...">https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=12310500&issu...</ulink> + </para> + <para> + When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component. + </para> + <para> + If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. + </para> +</section> + + Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Preface.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Preface.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Preface.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></xi:fallback></xi:include></preface> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Revision_History.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Revision_History.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/Revision_History.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/08_esb_features.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/08_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/09_esb_features.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/09_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/10_esb_features.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/10_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12a_esb_editor.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12a_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12b_esb_editor.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12b_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12c_esb_editor.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/12c_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn1.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/05a_esb_project_example.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/05a_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/15AddNew.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/15AddNew.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/18_select_libraries.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/18_select_libraries.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/19_select_runtime.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/19_select_runtime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/20_classpath_container.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/20_classpath_container.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/21_source.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/21_source.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/22_Javadoc.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/22_Javadoc.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/23_finger_touch.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/23_finger_touch.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/24_export_button.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/24_export_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/25_esb_file.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/25_esb_file.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/26_esb_export.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_project/26_esb_export.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/01_create_esb.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/01_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/02_create_esb.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/02_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/03_create_esb.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/03_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/04_create_esb.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/esb_support/04_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/introduction.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/introduction.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/introduction.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction"> + <?dbhtml filename="introduction.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + <keyword>JBoss Tools</keyword> + <keyword>JBDS</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <section> + + <title>What is ESB and JBoss ESB Tools?</title> + + <para>ESB (Enterprise Service Bus) is an abstraction layer on top of the implementation of an + enterprise messaging system that provides the features that Service Oriented + Architectures may be implemented with.</para> + <para>If you want to develop applications using ESB technology <property>JBoss ESB</property> also meets your + needs. Read more about <property>Jboss ESB</property> at <ulink url="http://www.jboss.org/jbossesb">http://www.jboss.org/jbossesb</ulink>.</para> + + + <para><property>JBoss ESB Tools</property> provide an ESB editor and necessary wizard for creating an ESB + file.</para> + <para>In this guide we provide you with the information on <property>JBoss ESB Tools</property> (installation, configuration and deployment) and usage of ESB Editor which allows you to + develop an ESB file much faster and with far fewer errors so sparing your time.</para> + + </section> + +<section> + <title>Key Features of ESB Tools</title> + <para>For a start, we propose you to look through the table of main features of ESB plugin:</para> + + <table> + + <title>Key Functionality of ESB Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" align="left" colwidth="2*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry><para>JBoss Tools Project Examples Wizard</para></entry> + <entry><para>Some kinds of projects with predefined structure are available for usage.</para></entry> + <entry> + <link linkend="ESB_project_wizard">Using ESB Project Examples</link> + </entry> + </row> + + <row> + <entry><para>JBoss Enterprise SOA Platform</para></entry> + <entry><para>The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para></entry> + <entry> + <link linkend="using_SOA">Using and configuring SOA Platform</link> + </entry> + </row> + + <row> + <entry><para>ESB Editor</para></entry> + <entry><para>JBoss ESB tooling has powerful editor features including syntax validation, support for XML Schema and other.</para></entry> +  + </row> + + </tbody> + + </tgroup> + </table> + +</section> + + <section> + <title>Requirements and Installation</title> + + <para>This section will provide you with the information on how to install + JBoss ESB plugin into Eclipse.</para> + + <para>ESB Tools come as one module of JBoss Tools project. Since ESB Tools have a + dependence on other JBoss Tools modules we recommend you to install a bundle + of all <ulink url="http://labs.jboss.com/tools/download.html">JBoss + Tools plug-ins</ulink>. You can find all necessary installation instructions on JBoss Wiki in the <ulink url="http://www.jboss.org/tools/download/installation" + >InstallingJBossTools</ulink> section.</para> + </section> + +</chapter> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/master.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/master.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY reference SYSTEM "reference.xml"> +<!ENTITY summary SYSTEM "summary.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + +]> +<book> + + <bookinfo> + <title>JBoss ESB Tools User Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + <author><firstname>Tatyana</firstname><surname>Romanovich</surname></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.3.1.GA + </releaseinfo> + +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/esb_ref_guide/pdf/ES...">PDF version</ulink> + </para> +</abstract> + +</bookinfo> + <toc/> + + &introduction; + &tasks; + &reference; + &summary; + +</book> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/master_output.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/master_output.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,1117 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY esb_support SYSTEM "esb_support.xml"> +<!ENTITY esb_editor SYSTEM "esb_editor.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>ESB Tools 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>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + <author><firstname>Tatyana</firstname><surname>Romanovich</surname></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.3.1.GA + </diffmk:wrapper></releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/esb_ref_guide/pdf/ES...">PDF version</ulink> + </para> +</abstract> + +</bookinfo> + <toc></toc> + + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/esb/docs/esb_ref_guide/en-US/introduction.xml"> + <?dbhtml filename="introduction.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + <keyword>JBoss Tools</keyword> + <keyword>JBDS</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <section> + + <title>What is ESB?</title> + + <para>ESB (Enterprise Service Bus) - an abstraction layer on top of implementation of an + enterprise messaging system that provides the features Service Oriented + Architectures may be implemented with.</para> + <para>If you want to develop applications using ESB technology JBoss ESB also meets your + needs. The JBoss Tools provide an ESB editor and all necessary wizards for creating an ESB + file.</para> + <para>In this guide we provide you with the information on JBoss ESB support (installation, configuration and deployment) and usage of ESB Editor which allows you to + develop an ESB file much faster and with far fewer errors so sparing your time.</para> + + </section> + +<section> + <title>Key Features of ESB Tools</title> + <para>For a start, we propose you to look through the table of main features of ESB plugin:</para> + + <table> + + <title>Key Functionality of ESB Tools</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 Tools Project Examples Wizard</para></entry> + <entry><para>Some kinds of projects with predefined structure are available for usage.</para></entry> + <entry> + <link linkend="ESB_project_wizard">Creating ESB Project using JBoss Tools Project Examples Wizard</link> + </entry> + </row> + + <row> + <entry><para>JBoss Enterprise SOA Platform</para></entry> + <entry><para>The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para></entry> + <entry> + <link linkend="using_SOA">using and configuring SOA Platform</link> + </entry> + </row> + + <row> + <entry><para>ESB Editor</para></entry> + <entry><para>JBoss ESB tooling has powerful editor features including syntax validation, support for XML Schema and other.</para></entry> + <entry> + <link linkend="esb_editor">ESB editor</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + +</section> + + + <section> + <title>Other relevant resources on the topic</title> + + <para>You can find a set of benefits and other extra information on:</para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb">JBoss ESB</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB + Documentation Library</ulink> + </para> + </listitem> + </itemizedlist> + + <para>The latest <property moreinfo="none">JBoss Tools/JBoss Developer Studio</property> documentation + builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools nightly documentation page</ulink>.</para> + + </section> +</chapter> + + +<chapter id="esb_support" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/esb/docs/esb_ref_guide/en-US/esb_support.xml"> + <?dbhtml filename="esb_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>ESB</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Support</title> + + <para>In this section we will focus on all concepts that <property moreinfo="none">JBoss Tools</property> + integrate for working with JBoss ESB.</para> + + <section> + <title>ESB Tools Installation</title> + + <para>This chapter will provide you with the information on how to install + JBoss ESB plugin into Eclipse.</para> + + <para>ESB Tools come as one module of JBoss Tools project. Since ESB Tools have a + dependence on other JBoss Tools modules we recommend you to install a bundle + of all <ulink url="http://labs.jboss.com/tools/download.html">JBoss + Tools plug-ins</ulink>. You can find all necessary installation instructions on JBoss Wiki in the <ulink url="http://www.jboss.org/tools/download/installation">InstallingJBossTools</ulink> section.</para> + </section> + + <section> + <title>Creating a ESB Project</title> + <para>In this chapter we suggest a step-by-step walk-through of creating a new + ESB project. Let's try to create a new JBoss ESB project.</para> + + <para>We will show you how to use the ESB Project Creation wizard for creating a new ESB project and setting basic ESB classpath.</para> + + <para>Select <emphasis> + <property moreinfo="none">File >New > Project...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property moreinfo="none">ESB > ESB Project</property> + </emphasis> in the dialog opened:</para> + + <figure float="0"> + <title>Select a Wizard dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/01_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings you to the JBoss ESB Project wizard page where a project name, ESB version and target JBoss Runtime are to be specified. Specify, for example, <emphasis> + <property moreinfo="none">helloworld</property> + </emphasis> as a Project name and accept the default ESB version.</para> + <figure float="0"> + <title>JBoss ESB Project wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/02_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>By clicking <emphasis>Modify</emphasis> button you can open <emphasis>Project Facets Wizard</emphasis> page,where you can select + facets that should be enabled for this project. + On the <emphasis>Project Facets Wizard</emphasis> page you can also configure runtime for the application</para> + <figure float="0"> + <title>Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/02a_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Next step provides you an opportunity to configure your project for building a java application</para> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> on this form + </emphasis> brings you to the ESB facet installation page where you can + specify Java Source Directory and ESB Content Directory. ESB Content Directory is a folder that contains the most of + artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options: + </para> + <para>1. Use <emphasis> + <property moreinfo="none">Server Supplied ESB Runtime</property> + </emphasis> + + </para> + <para> 2. Select a ESB runtime from the JBoss ESB runtime list predefined in the preferences. If you choose the first option, make sure that the project has the Target JBoss Runtime set and this runtime has a ESB runtime installed. + </para> + <para>3. Choose ESB Config Vertion. From the version 3.1.0 JBoss ESB Tools supports three different jboss-esb.xsd versions: jbossesb-1.0.1.xsd, jbossesb-1.1.0.xsd and jbossesb-1.2.0.xsd.</para> + <note><title>Note:</title> + <para>If you use ESB 4.7 you should select jbossesb-1.2.0.xsd.</para></note> + <figure float="0"> + <title>Install ESB facet step</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/03_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> and a ESB project with the default <emphasis><property moreinfo="none">jboss-esb.xml</property></emphasis> + will be created. </para> + + <figure float="0"> + <title>The generated ESB project structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/04_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ESB_project_wizard" xreflabel="here"> + <title>Creating ESB Project using JBoss Tools Project Examples Wizard</title> + <para>JBoss Tools provides a Project Example wizard that is an easy way for users to create some kinds of projects to be used as examples with some predefined structure. Let's start + creating a ESB project using this wizard.</para> + + <para>Before creating a ESB project example create JBoss Runtime with name <emphasis><property moreinfo="none"> + JBoss 4.2 Runtime</property></emphasis>, it will be used by your ESB project example. </para> + + <para>Select <emphasis> + <property moreinfo="none">File >New > Others </property> + </emphasis> , in the main menu bar or context menu for selected project and + then <emphasis> + <property moreinfo="none">JBoss Tools > Project Examples</property> + </emphasis> in the New dialog:</para> + + <figure float="0"> + <title>Select a wizard - Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/05_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis><diffmk:wrapper diffmk:change="added"> brings you to the wizard page where you can select a ESB project example from the example list.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Project Example Wizard</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/esb_project/05a_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <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">Under the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Projects</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + section you can find two categories related to ESB:</diffmk:wrapper></para> + + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">ESB</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">ESB for SOA-P 5.0</diffmk:wrapper></para></listitem> + </itemizedlist> + + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">It means that if you use a runtime pointed to a SOA-P 5.0, you should download the examples from + the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB for SOA-P 5.0</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> category in order to avoid the incompatibility errors. + </diffmk:wrapper></para> + </note> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="changed">Here is a list of ready examples available in both categories (ESB and ESB for SOA-P 5.0):</diffmk:wrapper></para> + + <itemizedlist> + + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Example</emphasis><diffmk:wrapper diffmk:change="changed"> - demonstrates the minimal files necessary to make a basic ESB component execute as well as to prove that the ESB is properly configured.</diffmk:wrapper></para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Action Example</emphasis> - demonstrates the use of multiple action invocations from a single configuration. You can use a single Action class and make multiple method calls or use multiple Action classes. </para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld File Action Example</emphasis> - demonstrates using the File gateway feature of the JBoss ESB. Files that are found in a particular directory with a particular extension are sent to a JMS queue with actions for processing.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service consumer1 Example</emphasis> - demonstrates how to consume a 181 Web Service in an ESB action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service producer Example</emphasis> - demonstrates how to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcessor action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks CSV -> XML Example</emphasis> - demonstrates how to transform a comma separated value (CSV) file to an XML.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> POJO Example</emphasis> - demonstrates the use of Smooks performing a simple transformation by converting an XML file into Java POJOs.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML date-manipulation Example</emphasis> - demonstrates how to manually define and apply a Message Transformation within JBoss ESB.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML Example</emphasis> - a very basic example of how to manually define and apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console. </para></listitem> + + </itemizedlist> + + + + <para>We will take as our example <emphasis><property moreinfo="none">JBoss ESB HelloWorld Example</property> </emphasis> ESB and Client project:</para> + + + <figure float="0"> + <title>JBoss Tools ESB Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/06_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>Choose them using the Ctrl button and then click + <emphasis><property moreinfo="none">Finish</property></emphasis>. As a result you will get two projects created:</para> + <figure float="0"> + <title>JBoss ESB Project Examples: helloworld and helloworld_testclient</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/07_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Deploy the HelloWorld ESB project and run a test class in the client Java project to see the test result in the Console view.</para> + </section> + + <section> + <title>Deploying a ESB Project</title> + <para>In this chapter you will see how to deploy a ESB project using the WTP deployment framework.</para> + + <para><diffmk:wrapper diffmk:change="changed">Before deploying the project, open the Servers View by selecting </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Show View > Other > + Server > Servers</diffmk:wrapper></property></emphasis>, + create a JBoss Server in the Server view and start it, and then right click the created JBoss server, + select <emphasis><property moreinfo="none"> </property> Add and Remove Projects</emphasis>, + and add the ESB projects you want to deploy from the left side to the right side in the opened dialog. </para> + + <figure float="0"> + <title>Add and Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/08_esb_project_deploy.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click <emphasis><property moreinfo="none">Finish</property> </emphasis> to add the project to the server. + You also can drag the ESB project from the Project View to the server.</para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Servers View</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/09_esb_runtime_new.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, you have just added the ESB project to the JBoss server module list. Right click the JBoss Server and select <emphasis><property moreinfo="none">Publish</property></emphasis> to publish the project on the server. + You can check the deploying result in the Console view.</para> + <para>The <emphasis><property moreinfo="none">Run</property></emphasis> and <emphasis><property moreinfo="none">Debug</property></emphasis> options work on ESB projects causing a (re)deploy for a user designated server.</para> + <para>You can also use the "Finger touch" 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/esb_project/23_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) and now it is also available for jboss-esb.xml in ESB projects.</para> + <para>You can also deploy your ESB project as an .esb archive. Right-click on the project, choose <emphasis><property moreinfo="none">Export</property></emphasis>:</para> + + <figure float="0"> + <title>Export of ESB project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/24_export_button.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property moreinfo="none">ESB</property></emphasis> > <emphasis><property moreinfo="none">ESB File</property></emphasis> and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para> + + <figure float="0"><title>Choosing ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/25_esb_file.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>And finally export the ESB project to the file system: choose the destination, choose the target runtime if need a specific one and make the appropriate settings for the archive. Then click <emphasis><property moreinfo="none">Finish</property></emphasis>.</para> + + <figure float="0"><title>ESB Export</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/26_esb_export.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Your project is deployed as an .esb archive.</para> + <para>An ESB archive can be created for ESB projects only. It is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB installed.</para> + + + </section> + + <section id="creating_esb_file"> + <title>Creating a ESB File</title> + <para>In this chapter we suggest a step-by-step walk-through of creating your own + simple file. Let's try to organize a new ESB file.</para> + + <para>We will show you how to use the Creation wizard for creating a new ESB file.</para> + + <para>At first you should open any project. Select <emphasis> + <property moreinfo="none">File >New > Other...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property moreinfo="none">ESB > ESB File</property> + </emphasis> in the New dialog:</para> + + <figure float="0"> + <title>Select a wizard - ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/01_create_esb.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings you to the wizard page where a folder, a name and a version for the file should be specified. Choose, for example, <emphasis> + <property moreinfo="none">jboss-esb.xml</property> + </emphasis> as the name and accept the selected projects folder and the default + version.</para> + + <note><title>Note:</title> + <para>From the version 3.1.0 JBoss ESB Tools supports three different jboss-esb.xsd versions: jbossesb-1.0.1.xsd, jbossesb-1.1.0.xsd and jbossesb-1.2.0.xsd. + If you use ESB 4.7 you should select jbossesb-1.2.0.xsd. + </para> + </note> + <figure float="0"> + <title>Folder, Name and Version for ESB file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/02_create_esb.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, your file will be created in the selected projects folder by default. If + you want to change the folder for your future file click <emphasis> + <property moreinfo="none">Browse...</property> + </emphasis> button to set needed folder or simply type it.</para> + + <para>Clicking on <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> results in the file being generated. The wizard creates one xml + file.</para> + + </section> + <section diffmk:change="added" id="creating_esb_action"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating a ESB Action</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">From this chapter you will find out how to create a </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB Action Java File</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">At first you need to open a </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or simple </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Java</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> project. Then you should select </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">File > New>Other</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> in the main menu or from the context project menu. Then click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB > ESB Action</diffmk:wrapper></property></emphasi! s><diffmk:wrapper diffmk:change="added"> in the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New </diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> dialog.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select a wizard - ESB Action</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/esb_support/03_create_esb.png"></imagedata> + </imageobject> + + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">After that click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and you will be brought to the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New ESB Action</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> wizard. In this wizard the class name should be specified, also you can set a package or add a interface as for any Java class.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">New ESB Action wizard</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/esb_support/04_create_esb.png"></imagedata> + </imageobject> + + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">As a result, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB Action Java File</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> will be created in the selected package and it will have </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">org.jboss.soa.esb.actions.AbstractActionPipelineProcessor </diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">as superclass. </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Clicking on </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"> will generate the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB Action</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> class. Also this class will become available in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> wizards.</diffmk:wrapper></para> + </section> + + <section role="updated"> + <title>Configuring ESB Runtime in Preferences</title> + <para>In this chapter you will know how to predefine a JBoss ESB runtime on the Preferences page.</para> + + <para>You may already know, there are two ways to set JBoss ESB runtime when creating a ESB project, + one is to use the project target JBoss runtime, and another is to select a JBoss ESB runtime predefined in JBoss Tools preferences. + Let's configure it.</para> + + <para>Select <emphasis> + <property moreinfo="none">Window >Preferences > JBoss Tools > JBoss ESB Runtime</property> + </emphasis>, to open the JBoss ESB Runtime Preferences page where you can add, remove and Edit a JBoss ESB runtime.</para> + + <figure float="0"> + <title>JBoss ESB Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/10_esb_runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Select <emphasis><property moreinfo="none">Add</property></emphasis> to open a dialog where you can specify the JBoss ESB runtime location, name and version number. It's also possible to define configuration if you point the home location to a Jboss AS or SOA-p, in case you select a standalone ESB runtime location, the configuration combo will be empty and should be ignored. + You can also customize the libraries of the runtime by checking the <emphasis><property moreinfo="none">Customize JBoss ESB Runtime jars</property> </emphasis> checkbox. </para> + + <figure float="0"> + <title>Configure new JBoss ESB Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/11_esb_runtime_new.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The new JBoss ESB Runtime will be configured. Click <emphasis> <property moreinfo="none">OK</property> </emphasis> to finish and save the preferences. + You can use the configuration when creating a JBoss ESB project. </para> + <para>When a ESB runtime is configured for your ESB project you are able to change it to any other using the classpath container page for ESB runtime. To do that, turn to the Package Explorer view and right-click the "JBoss ESB Runtime" library. Select <emphasis><property moreinfo="none">Properties</property></emphasis> and a table listing all available JBoss ESB runtimes will appear:</para> + + <figure float="0"> + <title>Classpath Container Page to change ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/20_classpath_container.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + + <para>Choose one of them to set to the ESB project and click <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + <para>ESB container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file, select <emphasis><property moreinfo="none">Properties</property></emphasis>. Choose <emphasis><property moreinfo="none">Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para> + + <figure float="0"> + <title>Classpath Container: Java Source Attachment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/21_source.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + <para>To change Javadoc Location choose <emphasis><property moreinfo="none">Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property moreinfo="none">package-list</property></emphasis>:</para> + + <figure float="0"> + <title>Classpath Container: Javadoc Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/22_Javadoc.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + + </section> + + + <section id="using_SOA"> + <title>Using and Configuring SOA Platform</title> + + <para>In this chapter you will know what is JBoss Enterprise SOA Platform and how you can configure it to use for your ESB projects. </para> + + <para>JBoss Enterprise SOA Platform delivers a flexible, standards-based platform to integrate applications, SOA services, business events and automate business processes. The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para> + <para>Having configured JBoss Enterprise SOA Platform for your ESB project you don't need to install and configure ESB server and runtime as they are already included.</para> + + <para>Check here to find more details on the platform: <ulink url="http://www.jboss.com/products/platforms/soa">JBoss Enterprise SOA Platform</ulink> and <ulink url="http://www.jboss.com/products/platforms/soa/components">JBoss Enterprise SOA Platform Component Details</ulink>.</para> + <para>You can find out what is SOA here: <ulink url="http://www.jboss.org/jbossesb/resources/SOABasics.html">Basics of SOA</ulink> and <ulink url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and EOA</ulink>.</para> + + <para>To configure the JBoss Enterprise SOA platform select <emphasis> + <property moreinfo="none">Window > Preferences > Server > Runtime Environments</property></emphasis>, that will open the Server Runtime Environments Preferences page where you can add, remove and edit a Server Runtime Environment.</para> + + <figure float="0"> + <title>Configure new Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/13NewServerRuntimeEnv.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select <emphasis><property moreinfo="none">Add</property></emphasis>, choose <emphasis><property moreinfo="none">JBoss 4.2 Runtime</property></emphasis> as a type of runtime environment, check the <emphasis><property moreinfo="none">Create a new local server</property></emphasis> checkbox and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para> + <figure float="0"> + <title>Type of Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/14typeOfRuntime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the next step you can specify a name of the server runtime environment and browse to its location. Click <emphasis><property moreinfo="none">Finish</property></emphasis> to add the server runtime environment.</para> + + + <figure float="0"> + <title>New Server Runtime Environment Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/15AddNew.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now you have your SOA platform configured. To check the configuration create a ESB Project using instructions described <xref linkend="ESB_project_wizard"></xref>. As a result you will have two projects created:</para> + + <figure float="0"> + <title>Helloworld Projects Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/16HelloworldProjects.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Then you will need to add JBoss ESB libraries to your projects to configure the SOA server runtime exactly for your projects. Right-click on your project, select <emphasis><property moreinfo="none">Build Path > Add Libraries</property></emphasis>:</para> + + <figure float="0"> + <title>Add Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/17_Add_new_libraries.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property moreinfo="none">JBoss ESB Libraries</property></emphasis> and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para> + + <figure float="0"> + <title>ESB Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/18_select_libraries.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select the necessary runtime to add to the project classpath:</para> + + + <figure float="0"> + <title>Select a ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/19_select_runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis><property moreinfo="none">Finish</property></emphasis>.</para> + <para>Now you can deploy your Helloworld project to the server and run a test class in the client Java project to see the test result in the Console view.</para> + + + +</section> + </chapter> +<chapter id="esb_editor" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/esb/docs/esb_ref_guide/en-US/esb_editor.xml" xreflabel="esb_editor"> + <?dbhtml filename="esbEditor.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss ESB</keyword> + <keyword>Editor</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Editor</title> + + <para><diffmk:wrapper diffmk:change="changed"> ESB editor has lots of useful features, they are described in details in this chapter. In + addition you'll get to know how </diffmk:wrapper><property moreinfo="none">ESB Editor</property> uses combined + visual and source editing of esb files.</para> + + <section id="esb_file" role="updated"> + + <title>ESB File Editor</title> + <para><property moreinfo="none">ESB File Editor</property> is a powerful and customizable tool. ESB File + Editor allows developing an application using ESB technology.</para> + + <para>ESB file editor has two tabs: Tree and Source.</para> + + <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a + tree format. By selecting any node you can see and edit its properties which will appear + in the right-hand area. For example, a Provider:</para> + <figure float="0"> + <title>Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01_esb_tree_view.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Some properties are represented as links to the associated editors.</para> + + <figure float="0" id="TreeViewLink"> + <title>Property Link to the Associated Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01a_esb_tree_view_and_links.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now when editing ESB actions which refer to other files (Drools, Groovy, Smooks, etc.), + the label for the field turns into a link to launch the editor associated with that type of file.</para> + <figure float="0"> + <title>Property Link to the Associated Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01b_esb_tree_view_and_links.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of + the editor and work in <property moreinfo="none">Source view</property>.</para> + + <figure float="0" id="sourceView"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/02_esb_source_view.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The Source view for the editor displays a text content of the ESB file. It is always + synchronized with <property moreinfo="none">Tree view</property>, so any changes made in one of the + views will immediately appear in the other.</para> + + <para>No matter what view you select, you get full integration with <property moreinfo="none">Outline + view</property>. For example, you can work in the Source view with the help of the + Outline view. The Outline view shows a tree structure of the ESB file. Simply select any + element in the <property moreinfo="none">Outline view</property> and it will jump to the same place in + the Source editor, so you can navigate through the source code with Outline view.</para> + <figure float="0"> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/03_esb_outline_view.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Adding, editing or deleting of some artifacts operations are available right in the + <property moreinfo="none">Tree view</property> . Right-click any node and select one of the + available actions in the context menu. For example, you can easily add a new Provider:</para> + <para></para> + <figure float="0"> + <title>Adding New Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/04_esb_add_provider.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Then you can add Channels and Properties for the Providers the same way or using the forms with <property moreinfo="none">Add</property>, <property moreinfo="none">Edit</property> and + <property moreinfo="none">Remove</property> buttons to the right.</para> + + <para>You can easily add a new Service too:</para> + <figure float="0"> + <title>Adding New Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/05_esb_add_service.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The same way you can create a listener for service and other elements of ESB:</para> + <figure float="0"> + <title>Adding New Listener for Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06_esb_add_listener.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The same actions can be done in the right part of <property moreinfo="none">Tree view</property> tab + (Form editor) using <property moreinfo="none">Add</property>, <property moreinfo="none">Edit</property> and + <property moreinfo="none">Remove</property> buttons.</para> + + <para>Filter can be also edited this way</para> + + <figure float="0"> + <title>Editing Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06a_esb_filter.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>In order to add a new custom Action to your ESB XML file you should select the + Actions node under the Services, then right-click and choose <emphasis> + <property moreinfo="none">New > Custom Action</property>. </emphasis></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Adding New Custom Action in the Tree View</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/11_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Or instead make use of <emphasis> + <property moreinfo="none">Add...</property> + </emphasis> button in the <property moreinfo="none">Form editor</property> on the left.</para> + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Adding New Custom Action in the Form Editor</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/12_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>Some new components are available to support ESB 4.7,such as: + new actions (XsltAction, PersistAction, BpmProcessor, ScriptingAction), + new processors (EJBProcessor), new routers (HttpRouter, JMSRouter, EmailRouter). + </para> + </note> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Then you will see </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add Action</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> wizard. There is a need to specify </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Action name</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Action Java class</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Add Action Wizard</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/esb_editor/12a_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To get a help with finding a proper class you can select </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"> to open </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Select class</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> dialog.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select class dialog</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/esb_editor/12b_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Moreover it's possible to type a </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Process name</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or select it with </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Edit Process </diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> dialog which is called out by clicking </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">. </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Edit Process dialog</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/esb_editor/12c_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="changed">As you can see on the both figures above, the context menu will also prompt you to + insert one of the Actions that are supplied out-of-the-box with </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss + ESB</diffmk:wrapper></property>. After choosing one an appeared <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New Pre-Packed Action </diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">wizard + will ask you to fill out a name field and other fields specific for each Action + property. For example, for </diffmk:wrapper><emphasis> + <property moreinfo="none">Content Based Router</property> + </emphasis> Action the wizard looks as follows:</para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Add Pre-Packed Action Wizard</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/13_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After confirming creating the Action you can see it in the Tree under the <emphasis> + <property moreinfo="none">Actions</property> + </emphasis> node and preview as well as edit its settings in the <property moreinfo="none">Form + editor</property> on the left.</para> + + <figure float="0"> + <title>Form Editor for Content Based Router</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/14_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><property moreinfo="none">ESB editor</property> can recognize some specific objects. On the figure you + can see <emphasis>org.jboss.soa.esb.actions.ContentBasedRouter</emphasis> in the <emphasis> + <property moreinfo="none">Class</property> + </emphasis> section.</para> + + </section> + + <section id="esb_editors_features"> + + <title>ESB Editors Features</title> + <para>JBoss ESB tooling has powerful editor features that help you easily make use of + content and code assist.</para> + <para>This last chapter covers capabilities on how you can use ESB editor.</para> + + <section id="ESBsyntaxvalidation84"> + + <title>ESB syntax validation</title> + <para>When working in <property moreinfo="none">JBoss ESB editor</property> you are constantly provided + with feedback and contextual error checking as you type. In the Source viewer, if at + any point a tag is incorrect or incomplete, an error will be indicated next to the + line and also in the <property moreinfo="none">Problems view</property> below.</para> + + </section> + + <section id="ESBSupportXMLSchema"> + <title>Support for XML Schema</title> + + <para>JBoss ESB Framework fully <link linkend="sourceView">supports XML files based on + schemas as well as DTDs</link>.</para> + <para>The schema checks the child elements of any kind of provider element; the ESB generates errors on startup if you attempt to define an incorrect combination (e.g.: a jms-bus inside an ftp-provider).</para> + <note><title>Note:</title> + <para>The schema used behind ESB editor now uses the latest version available (from SOA-P 4.3). This removes the errors/warnings some users have reported seeing when using SOA-P specific esb.xml files.</para> </note> + + </section> + +  + + <section id="ESBContentAssist"> + + <title>Content Assist for ESB XML file</title> + + <para>When you work with any ESB XML file <property moreinfo="none">Content Assist</property> is + available to help you. It provides pop-up tip to help you complete your code + statements. It allows you to write your code faster and with more accuracy. Content + assist is always available in the Source mode. Simply type <emphasis> + <property moreinfo="none">Ctrl-Space</property> + </emphasis> to see what is available.</para> + + <para>Content Assist for ESB XML file:</para> + <figure float="0"> + <title>Content Assist for ESB XML file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/08_esb_features.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist for attributes:</para> + <figure float="0"> + <title>Content Assist for attributes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/09_esb_features.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> +  + </section> + + <section id="openOn_for_esb"> + <title>OpenOn for ESB XML file</title> + <para>ESB file comes with the OpenOn feature that allows to make use of multiple file references in the file just with a click and the <emphasis> + <property moreinfo="none">Ctrl</property></emphasis> key hold down.</para> + + <para>The OpenOn is implemented for different types of files/pages inside the <literal moreinfo="none"><action></literal> tag: .xsd, .xml, etc.</para> + + <figure float="0"> + <title>OpenOn for smooks configuration file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/openOn2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It is also available for classes:</para> + + <figure float="0"> + <title>OpenOn for classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/openOn1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing"> + + <title>Synchronized Source and Visual Editing</title> + + <para>ESB file can be edited in either source or extra visual modes at the same time.</para> + + <para>JBoss Tools provide you two different editors to speed your development: a + graphical view (<property moreinfo="none">Tree</property>) and source (<property moreinfo="none">Source</property>). + At the same time, you always have full control over esb source file. Any changes you + make in the source view will immediately appear in the tree view. Both views are + synchronized, you can edit the file in any view.</para> + + <figure float="0"> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/10_esb_features.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In summary, this reference supplies you with all necessary information on the + functionality that JBoss ESB Editor provides for work with JBoss ESB.</para> + + <para>We hope, this guide helped you to get started with the JBoss ESB Tools. 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> +</book> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/reference.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/reference.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/reference.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,396 @@ +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="reference" xreflabel="reference" role="updated"> + <?dbhtml filename="reference.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss ESB</keyword> + <keyword>Editor</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>Reference</title> + + <para>This chapter includes detailed reference information about <property>JBoss ESB Tools</property>.</para> + + <section id="esb_file" role="updated"> + + <title>JBoss ESB Editor</title> + + <para> ESB editor has lots of useful features, they are described in details in this chapter.</para> + + <para><property>ESB File Editor</property> is a powerful and customizable tool which + allows developing an application using ESB technology.</para> + + <para>ESB file editor has two tabs: Tree and Source.</para> + + <section> + <title>Source View</title> + + <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of + the editor and work in <property>Source view</property>.</para> + + <figure id="sourceView"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/02_esb_source_view.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The Source view for the editor displays a text content of the ESB file. It is always + synchronized with <property>Tree view</property>, so any changes made in one of the + views will immediately appear in the other.</para> + + <para>No matter what view you select, you get full integration with <property>Outline + view</property>. For example, you can work in the Source view with the help of the + Outline view. The Outline view shows a tree structure of the ESB file. Simply select any + element in the <property>Outline view</property> and it will jump to the same place in + the Source editor, so you can navigate through the source code with Outline view.</para> + <figure> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/03_esb_outline_view.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section> + <title>Tree View</title> + + <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a + tree format. By selecting any node you can see and edit its properties which will appear + in the right-hand area. For example, a Provider:</para> + <figure> + <title>Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01_esb_tree_view.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para>Some properties are represented as links to the associated editors.</para> + + <figure id="TreeViewLink"> + <title>Property Link to the Associated Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01a_esb_tree_view_and_links.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Now when editing ESB actions which refer to other files (Drools, Groovy, Smooks, etc.), + the label for the field turns into a link to launch the editor associated with that type of file.</para> + <figure > + <title>Property Link to the Associated Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01b_esb_tree_view_and_links.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Adding, editing or deleting of some artifacts operations are available right in the + <property>Tree view</property> . Right-click any node and select one of the + available actions in the context menu. For example, you can easily add a new Provider:</para> + <para/> + <figure> + <title>Adding New Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/04_esb_add_provider.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Then you can add Channels and Properties for the Providers the same way or using the forms with <property>Add</property>, <property>Edit</property> and + <property>Remove</property> buttons to the right.</para> + + <para>You can easily add a new Service too:</para> + <figure> + <title>Adding New Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/05_esb_add_service.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The same way you can create a listener for service and other elements of ESB:</para> + <figure> + <title>Adding New Listener for Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06_esb_add_listener.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The same actions can be done in the right part of <property>Tree view</property> tab + (Form editor) using <property>Add</property>, <property>Edit</property> and + <property>Remove</property> buttons.</para> + + <para>Filter can be also edited this way</para> + + <figure> + <title>Editing Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06a_esb_filter.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>In order to add a new custom Action to your ESB XML file you should select the + Actions node under the Services, then right-click and choose <emphasis> + <property>New > Custom Action</property>. </emphasis></para> + + <figure> + <title>Adding New Custom Action in the Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/11_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Or instead make use of <emphasis> + <property>Add...</property> + </emphasis> button in the <property>Form editor</property> on the left.</para> + <figure> + <title>Adding New Custom Action in the Form Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/12_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>Some new components are available to support ESB 4.7,such as: + new actions (XsltAction, PersistAction, BpmProcessor, ScriptingAction), + new processors (EJBProcessor), new routers (HttpRouter, JMSRouter, EmailRouter). + </para> + </note> + <para>Then you will see <property>Add Action</property> wizard. There is a need to specify <property>Action name</property> and <property>Action Java class</property>. </para> + <figure> + <title>Add Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/12a_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To get a help with finding a proper class you can select <emphasis><property>Browse</property></emphasis> to open <property>Select class</property> dialog.</para> + <figure> + <title>Select class dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/12b_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Moreover it's possible to type a <property>Process name</property> or select it with <property>Edit Process </property> dialog which is called out by clicking <emphasis><property>Browse</property></emphasis>. </para> + <figure> + <title>Edit Process dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/12c_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see on the both figures above, the context menu will also prompt you to + insert one of the Actions that are supplied out-of-the-box with <property>JBoss + ESB</property>. After choosing one an appeared <property>New Pre-Packed Action </property>wizard + will ask you to fill out a name field and other fields specific for each Action + property. For example, for <emphasis> + <property>Content Based Router</property> + </emphasis> Action the wizard looks as follows:</para> + + <figure> + <title>Add Pre-Packed Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/13_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>After confirming creating the Action you can see it in the Tree under the <emphasis> + <property>Actions</property> + </emphasis> node and preview as well as edit its settings in the <property>Form + editor</property> on the left.</para> + + <figure> + <title>Form Editor for Content Based Router</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/14_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para><property>ESB editor</property> can recognize some specific objects. On the figure you + can see <emphasis>org.jboss.soa.esb.actions.ContentBasedRouter</emphasis> in the <emphasis> + <property>Class</property> + </emphasis> section.</para> + + </section> + + </section> + + <section id="esb_editors_features"> + + <title>ESB Editor Features</title> + <para>JBoss ESB tooling has powerful editor features that help you easily make use of + content and code assist.</para> + <para>This last chapter covers capabilities on how you can use ESB editor.</para> + + <section id="ESBsyntaxvalidation84"> + + <title>ESB Syntax Validation</title> + <para>When working in <property>JBoss ESB editor</property> you are constantly provided + with feedback and contextual error checking as you type. In the Source viewer, if at + any point a tag is incorrect or incomplete, an error will be indicated next to the + line and also in the <property>Problems view</property> below.</para> + + </section> + + <section id="ESBSupportXMLSchema"> + <title>Support for XML Schema</title> + + <para>JBoss ESB Framework fully <link linkend="sourceView">supports XML files based on + schemas as well as DTDs</link>.</para> + <para>The schema checks the child elements of any kind of provider element; the ESB generates errors on startup if you attempt to define an incorrect combination (e.g.: a jms-bus inside an ftp-provider).</para> + <note><title>Note:</title> + <para>The schema used behind ESB editor now uses the latest version available (from SOA-P 4.3). This removes the errors/warnings some users have reported seeing when using SOA-P specific esb.xml files.</para> </note> + + </section> + +  + + <section id="ESBContentAssist"> + + <title>Content Assist for ESB XML File</title> + + <para>When you work with any ESB XML file <property>Content Assist</property> is + available to help you. It provides pop-up tip to help you complete your code + statements. It allows you to write your code faster and with more accuracy. Content + assist is always available in the Source mode. Simply type <emphasis> + <property>Ctrl-Space</property> + </emphasis> to see what is available.</para> + + <para>Content Assist for ESB XML file:</para> + <figure> + <title>Content Assist for ESB XML file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/08_esb_features.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist for attributes:</para> + <figure> + <title>Content Assist for attributes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/09_esb_features.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> +  + </section> + + <section id="openOn_for_esb"> + <title>OpenOn for ESB XML File</title> + <para>ESB file comes with the OpenOn feature that allows to make use of multiple file references in the file just with a click and the <emphasis> + <property>Ctrl</property></emphasis> key hold down.</para> + + <para>The OpenOn is implemented for different types of files/pages inside the <literal><action></literal> tag: .xsd, .xml, etc.</para> + + <figure> + <title>OpenOn for smooks configuration file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/openOn2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It is also available for classes:</para> + + <figure> + <title>OpenOn for classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/openOn1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing"> + + <title>Synchronized Source and Visual Editing</title> + + <para>ESB file can be edited in either source or extra visual modes at the same time.</para> + + <para>JBoss Tools provide you two different editors to speed your development: a + graphical view (<property>Tree</property>) and source (<property>Source</property>). + At the same time, you always have full control over esb source file. Any changes you + make in the source view will immediately appear in the tree view. Both views are + synchronized, you can edit the file in any view.</para> + + <figure> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/10_esb_features.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + + </section> + </section> +</chapter> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/summary.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/summary.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/summary.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="summary" xreflabel="summary"> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + + <para>On the whole, this reference supplies you with all necessary information on the + functionality that JBoss ESB plugin provides for work with JBoss ESB.</para> + + <para>We hope, this guide helped you to get started with the JBoss ESB Tools. 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> + <title>Other Relevant Resources on the Topic</title> + + <para>You can find a set of benefits and other extra information on:</para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb">JBoss ESB</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB + Documentation Library</ulink> + </para> + </listitem> + </itemizedlist> + + <para>The latest <property>JBoss Tools/JBoss Developer Studio</property> documentation + builds are available on the <ulink url="http://download.jboss.org/jbosstools/nightly-docs/" + > JBoss Tools nightly documentation page</ulink>.</para> + + </section> +</chapter> \ No newline at end of file Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/tasks.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/tasks.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/en-US/tasks.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,549 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="tasks" role="updated"> + <?dbhtml filename="etasks.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>ESB</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Tasks</title> + + <para>In this section we will focus on all concepts that <property>JBoss Tools</property> + integrate for working with JBoss ESB.</para> + + <section> + <title>Creating a ESB Project</title> + <para>In this chapter we suggest a step-by-step walk-through of creating a new + ESB project. Let's try to create a new JBoss ESB project.</para> + + <para>We will show you how to use the ESB Project Creation wizard for creating a new ESB project and setting basic ESB classpath.</para> + + <para>Select <emphasis> + <property>File >New > Project...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property>ESB > ESB Project</property> + </emphasis> in the dialog opened:</para> + + <figure> + <title>Select a Wizard dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/01_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property>Next</property> + </emphasis> brings you to the JBoss ESB Project wizard page where a project name, ESB version and target JBoss Runtime are to be specified. Specify, for example, <emphasis> + <property>helloworld</property> + </emphasis> as a Project name and accept the default ESB version.</para> + <figure> + <title>JBoss ESB Project wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/02_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + <para>By clicking <emphasis>Modify</emphasis> button you can open <emphasis>Project Facets Wizard</emphasis> page,where you can select + facets that should be enabled for this project. + On the <emphasis>Project Facets Wizard</emphasis> page you can also configure runtime for the application</para> + <figure> + <title>Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/02a_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Next step provides you an opportunity to configure your project for building a java application</para> + + <para> Clicking <emphasis> + <property>Next</property> on this form + </emphasis> brings you to the ESB facet installation page where you can + specify Java Source Directory and ESB Content Directory. ESB Content Directory is a folder that contains the most of + artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options: + </para> + <para>1. Use <emphasis> + <property>Server Supplied ESB Runtime</property> + </emphasis> + + </para> + <para> 2. Select a ESB runtime from the JBoss ESB runtime list predefined in the preferences. If you choose the first option, make sure that the project has the Target JBoss Runtime set and this runtime has a ESB runtime installed. + </para> + <para>3. Choose ESB Config Vertion. From the version 3.1.0 JBoss ESB Tools supports three different jboss-esb.xsd versions: jbossesb-1.0.1.xsd, jbossesb-1.1.0.xsd and jbossesb-1.2.0.xsd.</para> + <note><title>Note:</title> + <para>If you use ESB 4.7 you should select jbossesb-1.2.0.xsd.</para></note> + <figure> + <title>Install ESB facet step</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/03_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property>Finish</property> + </emphasis> and a ESB project with the default <emphasis><property>jboss-esb.xml</property></emphasis> + will be created. </para> + + <figure> + <title>The generated ESB project structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/04_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ESB_project_wizard" xreflabel="here"> + <title>Using ESB Project Examples</title> + <para>JBoss Tools provides a Project Example wizard that is an easy way for users to create some kinds of projects to be used as examples with some predefined structure. Let's start + creating a ESB project using this wizard.</para> + + <para>Before creating a ESB project example create JBoss Runtime with name <emphasis><property> + JBoss 4.2 Runtime</property></emphasis>, it will be used by your ESB project example. </para> + + <para>Select <emphasis> + <property>File >New > Others </property> + </emphasis> , in the main menu bar or context menu for selected project and + then <emphasis> + <property>JBoss Tools > Project Examples</property> + </emphasis> in the New dialog:</para> + + <figure> + <title>Select a wizard - Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/05_esb_project_example.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property>Next</property> + </emphasis> brings you to the wizard page where you can select a ESB project example from the example list.</para> + + <figure> + <title>Project Example Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/05a_esb_project_example.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>Under the <property>Projects</property> + section you can find two categories related to ESB:</para> + + <itemizedlist> + <listitem><para>ESB</para></listitem> + <listitem><para>ESB for SOA-P 5.0</para></listitem> + </itemizedlist> + + + <para>It means that if you use a runtime pointed to a SOA-P 5.0, you should download the examples from + the <emphasis> + <property>ESB for SOA-P 5.0</property> + </emphasis> category in order to avoid the incompatibility errors. + </para> + </note> + + <para>Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.</para> + <para>Here is a list of ready examples available in both categories (ESB and ESB for SOA-P 5.0):</para> + + <itemizedlist> + + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Example</emphasis> - demonstrates the minimal files necessary to make a basic ESB component execute as well as to prove that the ESB is properly configured.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Action Example</emphasis> - demonstrates the use of multiple action invocations from a single configuration. You can use a single Action class and make multiple method calls or use multiple Action classes. </para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld File Action Example</emphasis> - demonstrates using the File gateway feature of the JBoss ESB. Files that are found in a particular directory with a particular extension are sent to a JMS queue with actions for processing.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service consumer1 Example</emphasis> - demonstrates how to consume a 181 Web Service in an ESB action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service producer Example</emphasis> - demonstrates how to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcessor action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks CSV -> XML Example</emphasis> - demonstrates how to transform a comma separated value (CSV) file to an XML.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> POJO Example</emphasis> - demonstrates the use of Smooks performing a simple transformation by converting an XML file into Java POJOs.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML date-manipulation Example</emphasis> - demonstrates how to manually define and apply a Message Transformation within JBoss ESB.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML Example</emphasis> - a very basic example of how to manually define and apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console. </para></listitem> + + </itemizedlist> + + + + <para>We will take as our example <emphasis><property>JBoss ESB HelloWorld Example</property> </emphasis> ESB and Client project:</para> + + + <figure> + <title>JBoss Tools ESB Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/06_esb_project_example.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>Choose them using the Ctrl button and then click + <emphasis><property>Finish</property></emphasis>. As a result you will get two projects created:</para> + <figure> + <title>JBoss ESB Project Examples: helloworld and helloworld_testclient</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/07_esb_project_example.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Deploy the HelloWorld ESB project and run a test class in the client Java project to see the test result in the Console view.</para> + </section> + + <section> + <title>Deploying a ESB Project</title> + <para>In this chapter you will see how to deploy a ESB project using the WTP deployment framework.</para> + + <para>Before deploying the project, open the Servers View by selecting <emphasis><property>Window > Show View > Other > + Server > Servers</property></emphasis>, + create a JBoss Server in the Server view and start it, and then right click the created JBoss server, + select <emphasis><property> </property> Add and Remove Projects</emphasis>, + and add the ESB projects you want to deploy from the left side to the right side in the opened dialog. </para> + + <figure> + <title>Add and Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/08_esb_project_deploy.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Click <emphasis><property>Finish</property> </emphasis> to add the project to the server. + You also can drag the ESB project from the Project View to the server.</para> + + <figure> + <title>Servers View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/09_esb_runtime_new.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, you have just added the ESB project to the JBoss server module list. Right click the JBoss Server and select <emphasis><property>Publish</property></emphasis> to publish the project on the server. + You can check the deploying result in the Console view.</para> + <para>The <emphasis><property>Run</property></emphasis> and <emphasis><property>Debug</property></emphasis> options work on ESB projects causing a (re)deploy for a user designated server.</para> + <para>You can also use the "Finger touch" for a quick restart of the project without restarting the server:</para> + <figure> + <title>Finger Touch button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/23_finger_touch.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR) and now it is also available for jboss-esb.xml in ESB projects.</para> + <para>You can also deploy your ESB project as an .esb archive. Right-click on the project, choose <emphasis><property>Export</property></emphasis>:</para> + + <figure> + <title>Export of ESB project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/24_export_button.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property>ESB</property></emphasis> > <emphasis><property>ESB File</property></emphasis> and click <emphasis><property>Next</property></emphasis>:</para> + + <figure><title>Choosing ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/25_esb_file.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>And finally export the ESB project to the file system: choose the destination, choose the target runtime if need a specific one and make the appropriate settings for the archive. Then click <emphasis><property>Finish</property></emphasis>.</para> + + <figure><title>ESB Export</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/26_esb_export.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Your project is deployed as an .esb archive.</para> + <para>An ESB archive can be created for ESB projects only. It is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB installed.</para> + + + </section> + + <section id="creating_esb_file"> + <title>Creating a ESB File</title> + <para>In this chapter we suggest a step-by-step walk-through of creating your own + simple file. Let's try to organize a new ESB file.</para> + + <para>We will show you how to use the Creation wizard for creating a new ESB file.</para> + + <para>At first you should open any project. Select <emphasis> + <property>File >New > Other...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property>ESB > ESB File</property> + </emphasis> in the New dialog:</para> + + <figure> + <title>Select a wizard - ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/01_create_esb.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property>Next</property> + </emphasis> brings you to the wizard page where a folder, a name and a version for the file should be specified. Choose, for example, <emphasis> + <property>jboss-esb.xml</property> + </emphasis> as the name and accept the selected projects folder and the default + version.</para> + + <note><title>Note:</title> + <para>From the version 3.1.0 JBoss ESB Tools supports three different jboss-esb.xsd versions: jbossesb-1.0.1.xsd, jbossesb-1.1.0.xsd and jbossesb-1.2.0.xsd. + If you use ESB 4.7 you should select jbossesb-1.2.0.xsd. + </para> + </note> + <figure> + <title>Folder, Name and Version for ESB file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/02_create_esb.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, your file will be created in the selected projects folder by default. If + you want to change the folder for your future file click <emphasis> + <property>Browse...</property> + </emphasis> button to set needed folder or simply type it.</para> + + <para>Clicking on <emphasis> + <property>Finish</property> + </emphasis> results in the file being generated. The wizard creates one xml + file.</para> + + </section> + <section id="creating_esb_action"> + <title>Creating a ESB Action</title> + <para>From this chapter you will find out how to create a <emphasis><property>ESB Action Java File</property></emphasis>.</para> + <para>At first you need to open a <property>ESB</property> or simple <property>Java</property> project. Then you should select <emphasis><property>File > New>Other</property></emphasis> in the main menu or from the context project menu. Then click <emphasis><property>ESB > ESB Action</property></emphasis> in the <emphasis><property>New </property></emphasis> dialog.</para> + <figure> + <title>Select a wizard - ESB Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/03_create_esb.png"/> + </imageobject> + + </mediaobject> + </figure> + <para>After that click <emphasis><property>Next</property></emphasis> and you will be brought to the <emphasis><property>New ESB Action</property></emphasis> wizard. In this wizard the class name should be specified, also you can set a package or add a interface as for any Java class.</para> + <figure> + <title>New ESB Action wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/04_create_esb.png"/> + </imageobject> + + </mediaobject> + </figure> + <para>As a result, the <property>ESB Action Java File</property> will be created in the selected package and it will have <property>org.jboss.soa.esb.actions.AbstractActionPipelineProcessor </property>as superclass. </para> + <para>Clicking on <emphasis><property>Finish</property></emphasis> will generate the <property>ESB Action</property> class. Also this class will become available in <property>ESB Editor</property> wizards.</para> + </section> + + <section role="updated"> + <title>Configuring ESB Runtime in Preferences</title> + <para>In this chapter you will know how to predefine a JBoss ESB runtime on the Preferences page.</para> + + <para>You may already know, there are two ways to set JBoss ESB runtime when creating a ESB project, + one is to use the project target JBoss runtime, and another is to select a JBoss ESB runtime predefined in JBoss Tools preferences. + Let's configure it.</para> + + <para>Select <emphasis> + <property>Window >Preferences > JBoss Tools > JBoss ESB Runtime</property> + </emphasis>, to open the JBoss ESB Runtime Preferences page where you can add, remove and Edit a JBoss ESB runtime.</para> + + <figure> + <title>JBoss ESB Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/10_esb_runtime.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Select <emphasis><property>Add</property></emphasis> to open a dialog where you can specify the JBoss ESB runtime location, name and version number. It's also possible to define configuration if you point the home location to a Jboss AS or SOA-p, in case you select a standalone ESB runtime location, the configuration combo will be empty and should be ignored. + You can also customize the libraries of the runtime by checking the <emphasis><property>Customize JBoss ESB Runtime jars</property> </emphasis> checkbox. </para> + + <figure> + <title>Configure new JBoss ESB Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/11_esb_runtime_new.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The new JBoss ESB Runtime will be configured. Click <emphasis> <property>OK</property> </emphasis> to finish and save the preferences. + You can use the configuration when creating a JBoss ESB project. </para> + <para>When a ESB runtime is configured for your ESB project you are able to change it to any other using the classpath container page for ESB runtime. To do that, turn to the Package Explorer view and right-click the "JBoss ESB Runtime" library. Select <emphasis><property>Properties</property></emphasis> and a table listing all available JBoss ESB runtimes will appear:</para> + + <figure> + <title>Classpath Container Page to change ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/20_classpath_container.png"/> + </imageobject> + </mediaobject> + </figure> + + + + <para>Choose one of them to set to the ESB project and click <emphasis><property>Ok</property></emphasis>.</para> + <para>ESB container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file, select <emphasis><property>Properties</property></emphasis>. Choose <emphasis><property>Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para> + + <figure> + <title>Classpath Container: Java Source Attachment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/21_source.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.</para> + <para>To change Javadoc Location choose <emphasis><property>Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property>package-list</property></emphasis>:</para> + + <figure> + <title>Classpath Container: Javadoc Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/22_Javadoc.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.</para> + + </section> + + + <section id="using_SOA"> + <title>Using and Configuring SOA Platform</title> + + <para>In this chapter you will know what is JBoss Enterprise SOA Platform and how you can configure it to use for your ESB projects. </para> + + <para>JBoss Enterprise SOA Platform delivers a flexible, standards-based platform to integrate applications, SOA services, business events and automate business processes. The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para> + <para>Having configured JBoss Enterprise SOA Platform for your ESB project you don't need to install and configure ESB server and runtime as they are already included.</para> + + <para>Check here to find more details on the platform: <ulink url="http://www.jboss.com/products/platforms/soa">JBoss Enterprise SOA Platform</ulink> and <ulink url="http://www.jboss.com/products/platforms/soa/components">JBoss Enterprise SOA Platform Component Details</ulink>.</para> + <para>You can find out what is SOA here: <ulink url="http://www.jboss.org/jbossesb/resources/SOABasics.html">Basics of SOA</ulink> and <ulink url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and EOA</ulink>.</para> + + <para>To configure the JBoss Enterprise SOA platform select <emphasis> + <property>Window > Preferences > Server > Runtime Environments</property></emphasis>, that will open the Server Runtime Environments Preferences page where you can add, remove and edit a Server Runtime Environment.</para> + + <figure> + <title>Configure new Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/13NewServerRuntimeEnv.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Select <emphasis><property>Add</property></emphasis>, choose <emphasis><property>JBoss 4.2 Runtime</property></emphasis> as a type of runtime environment, check the <emphasis><property>Create a new local server</property></emphasis> checkbox and click <emphasis><property>Next</property></emphasis>:</para> + <figure> + <title>Type of Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/14typeOfRuntime.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the next step you can specify a name of the server runtime environment and browse to its location. Click <emphasis><property>Finish</property></emphasis> to add the server runtime environment.</para> + + + <figure> + <title>New Server Runtime Environment Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/15AddNew.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Now you have your SOA platform configured. To check the configuration create a ESB Project using instructions described <xref linkend="ESB_project_wizard"/>. As a result you will have two projects created:</para> + + <figure> + <title>Helloworld Projects Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/16HelloworldProjects.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Then you will need to add JBoss ESB libraries to your projects to configure the SOA server runtime exactly for your projects. Right-click on your project, select <emphasis><property>Build Path > Add Libraries</property></emphasis>:</para> + + <figure> + <title>Add Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/17_Add_new_libraries.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property>JBoss ESB Libraries</property></emphasis> and click <emphasis><property>Next</property></emphasis>:</para> + + <figure> + <title>ESB Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/18_select_libraries.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Select the necessary runtime to add to the project classpath:</para> + + + <figure> + <title>Select a ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/19_select_runtime.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis><property>Finish</property></emphasis>.</para> + <para>Now you can deploy your Helloworld project to the server and run a test class in the client Java project to see the test result in the Console view.</para> + + + +</section> + + + + + + + + + + +</chapter> \ No newline at end of file Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/pom.xml =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/pom.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/pom.xml 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,180 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>esb-reference-guide-en-US</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>ESB_Reference_Guide</name> + + <profiles> + <profile> + <id>release</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseTest</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseJBDS</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>${pom.basedir}/target/docbook/staging/css/com/css</cssdir> + </properties> + </profile> + <profile> + <id>diffmk</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf> + </properties> + </profile> + </profiles> + + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.2.1</version> + <extensions>true</extensions> + + <dependencies> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-jdocbook-style</artifactId> + <type>jdocbook-style</type> + <version>1.0.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-docbook-xslt</artifactId> + <version>1.0.0-SNAPSHOT</version> + </dependency> + + + </dependencies> + + <configuration> + <sourceDocumentName>${master}</sourceDocumentName> + <sourceDirectory>${pom.basedir}</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>${xsl-pdf}</stylesheetResource> + <finalName>${project.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>${xsl-chunked}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>${xsl-single}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> +  +  + <docbookVersion>1.72.0</docbookVersion> + </options> + + </configuration> + </plugin> + <plugin> + <artifactId>maven-clean-plugin</artifactId> + <version>2.4</version> + <executions> + <execution> + <id>clean</id> + <phase>package</phase> + <goals> + <goal>clean</goal> + </goals> + </execution> + </executions> + <configuration> + <excludeDefaultDirectories>true</excludeDefaultDirectories> + <filesets> + <fileset> + <directory>${pom.basedir}/target/docbook/publish/en-US/</directory> + <includes> + <include>html/org/</include> + <include>html/org/</include> + <include>html_single/org/</include> + <include>html_single/org/</include> + <include>eclipse/org/</include> + <include>eclipse/org/</include> + </includes> + <followSymlinks>false</followSymlinks> + </fileset> + </filesets> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> +  +  +  + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + <stylesdir>classpath:/xslt</stylesdir> + <cssdir>${pom.basedir}/target/docbook/staging/css/org/css</cssdir> + <master>master.xml</master> + </properties> +</project> Added: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/publican.cfg =================================================================== --- tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/publican.cfg (rev 0) +++ tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/publican.cfg 2010-06-08 23:38:52 UTC (rev 22649) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22648 - tags/jbosstools-3.1.1.GA/esb/docs.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 19:34:22 -0400 (Tue, 08 Jun 2010) New Revision: 22648 Removed: tags/jbosstools-3.1.1.GA/esb/docs/esb_ref_guide/ Log: removing esb ref guide to upload restructured version for 3.0.1

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22647 - in tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US: images/create_new_project and 1 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 19:30:47 -0400 (Tue, 08 Jun 2010) New Revision: 22647 Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/create_new_project.xml tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/debugging_rules.xml tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/editors.xml tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/master_output.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/create_new_project.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/create_new_project.xml 2010-06-08 23:27:46 UTC (rev 22646) +++ tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/create_new_project.xml 2010-06-08 23:30:47 UTC (rev 22647) @@ -1,216 +1,216 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="create_new_project" xreflabel="create_new_project"> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Drools Tools</keyword> - </keywordset> - </chapterinfo> - - <title>Creating a New Drools Project</title> - - <para>In this chapter we are going to show you how to setup an executable sample Drools project - to start using rules immediately.</para> - - - - <section id="sample_drools_project"> - <title>Creating a Sample Drools Project</title> - - <para>First, we suggest that you use <property>Drools perspective</property> which is aimed - at work with Drools specific resources.</para> - - <para>To create a new Drools project follow to <emphasis> - <property>File > New > Drools Project</property>. </emphasis> This will open - <property>New Drools Project wizard</property> like on the figure below.</para> - - <para>On the first page type the project name and click - <emphasis><property>Next</property>.</emphasis></para> - - <figure> - <title>Creating a New Drools Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Next you have a choice to add some default artifacts to it like sample rules, decision - tables or ruleflows and Java classes for them. Let's select first two check - boxes and press <emphasis> - <property>Next</property>. </emphasis></para> - - <figure> - <title>Selecting Drools Project Elements</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Next page asks you to specify a Drools runtime. If you have not yet set it up, you - should do this now by clicking the <emphasis> - <property>Configure Workspace Settings</property> - </emphasis> link.</para> - - <figure> - <title>Configuring Drools Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You should see the <property>Preferences window</property> where you can configure the - workspace settings for Drools runtimes. To create a new runtime, press the <emphasis> - <property>Add</property> - </emphasis> button. The appeared dialog prompts you to enter a - name for a new runtime and a path to the Drools runtime on your file system.</para> - - <note> - <title>Note:</title> - <para>A Drools runtime is a collection of jars on your file system that represent one - specific release of the Drools project jars. While creating a new runtime, you must - either point to the release of your choice, or you can simply create a new runtime - on your file system from the jars included in the Drools Eclipse plugin.</para> - </note> - - <figure> - <title>Adding a New Drools Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project4.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Let's simply create a new Drools 5 runtime from the jars embedded in the - Drools Eclipse plugin. Thus, you should press <emphasis> - <property>Create a new Drools 5 runtime</property> - </emphasis> button and select the folder where you want this runtime to be created and - hit <emphasis> - <property>OK</property>.</emphasis></para> - - <para>You will see the newly created runtime show up in your list of Drools runtimes. Check - it and press <emphasis> - <property>OK</property>.</emphasis></para> - - <figure> - <title>Selecting a Drools Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Now press <emphasis> - <property>Finish</property> - </emphasis> to complete the project creation.</para> - - <figure> - <title>Completing the Drools Project Creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project6.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>This will setup a basic structure, classpath and sample rules and test case to get you - started.</para> - </section> - - - <section id="structure_overview"> - <title>Drools Project Structure Overview</title> - - <para>Now let's look at the structure of the organized project. In the - <property>Package Explorer</property> you should see the following:</para> - - <figure> - <title>Drools Project in the Package Explorer</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The newly created project contains an example rule file <emphasis> - <property>Sample.drl</property> - </emphasis> in the <emphasis> - <property>src/main/rules</property> - </emphasis> directory and an example java file <emphasis> - <property>DroolsTest.java</property> - </emphasis> that can be used to execute the rules in a Drools engine in the folder <emphasis> - <property>src/main/java</property> - </emphasis>, in the <emphasis> - <property>com.sample</property> - </emphasis> package. All the others jar's that are necessary during execution - are also added to the classpath in a custom classpath container called <property>Drools - Library</property>.</para> - - <tip> - <title>Tip:</title> - <para>Rules do not have to be kept in Java projects at all, this is just a convenience - for people who are already using eclipse as their Java IDE.</para> - </tip> - - </section> - - <section id="creating_rule"> - <title>Creating a New Rule</title> - - <para>Now we are going to add a new Rule resource to the project.</para> - - <para>You can either create an empty text <emphasis> - <property>.drl</property> - </emphasis> file or make use of the special <property>New Rule Resource - wizard</property> to do it.</para> - - <para>To open the wizard follow to <emphasis> - <property>File > New > Rule Resource</property> - </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> - - <figure> - <title>Opening the New Rule Resource Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project8.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On the wizard page first select <emphasis> - <property>/rules</property> - </emphasis> as a top level directory to store your rules and type the rule name. Next - it's mandatory to specify the rule package name. It defines a namespace that - groups rules together.</para> - - <figure> - <title>New Rule Resource Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project9.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>As a result the wizard generates a rule skeleton to get you started.</para> - - <figure> - <title>New Rule</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_project/create_new_project10.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="create_new_project" xreflabel="create_new_project"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a New Drools Project</title> + + <para>In this chapter we are going to show you how to setup an executable sample Drools project + to start using rules immediately.</para> + + + + <section id="sample_drools_project"> + <title>Creating a Sample Drools Project</title> + + <para>First, we suggest that you use <property>Drools perspective</property> which is aimed + at work with Drools specific resources.</para> + + <para>To create a new Drools project follow to <emphasis> + <property>File > New > Drools Project</property>. </emphasis> This will open + <property>New Drools Project wizard</property> like on the figure below.</para> + + <para>On the first page type the project name and click + <emphasis><property>Next</property>.</emphasis></para> + + <figure> + <title>Creating a New Drools Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next you have a choice to add some default artifacts to it like sample rules, decision + tables or ruleflows and Java classes for them. Let's select first two check + boxes and press <emphasis> + <property>Next</property>. </emphasis></para> + + <figure> + <title>Selecting Drools Project Elements</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next page asks you to specify a Drools runtime. If you have not yet set it up, you + should do this now by clicking the <emphasis> + <property>Configure Workspace Settings</property> + </emphasis> link.</para> + + <figure> + <title>Configuring Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You should see the <property>Preferences window</property> where you can configure the + workspace settings for Drools runtimes. To create a new runtime, press the <emphasis> + <property>Add</property> + </emphasis> button. The appeared dialog prompts you to enter a + name for a new runtime and a path to the Drools runtime on your file system.</para> + + <note> + <title>Note:</title> + <para>A Drools runtime is a collection of jars on your file system that represent one + specific release of the Drools project jars. While creating a new runtime, you must + either point to the release of your choice, or you can simply create a new runtime + on your file system from the jars included in the Drools Eclipse plugin.</para> + </note> + + <figure> + <title>Adding a New Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Let's simply create a new Drools 5 runtime from the jars embedded in the + Drools Eclipse plugin. Thus, you should press <emphasis> + <property>Create a new Drools 5 runtime</property> + </emphasis> button and select the folder where you want this runtime to be created and + hit <emphasis> + <property>OK</property>.</emphasis></para> + + <para>You will see the newly created runtime show up in your list of Drools runtimes. Check + it and press <emphasis> + <property>OK</property>.</emphasis></para> + + <figure> + <title>Selecting a Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now press <emphasis> + <property>Finish</property> + </emphasis> to complete the project creation.</para> + + <figure> + <title>Completing the Drools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>This will setup a basic structure, classpath and sample rules and test case to get you + started.</para> + </section> + + + <section id="structure_overview"> + <title>Drools Project Structure Overview</title> + + <para>Now let's look at the structure of the organized project. In the + <property>Package Explorer</property> you should see the following:</para> + + <figure> + <title>Drools Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The newly created project contains an example rule file <emphasis> + <property>Sample.drl</property> + </emphasis> in the <emphasis> + <property>src/main/rules</property> + </emphasis> directory and an example java file <emphasis> + <property>DroolsTest.java</property> + </emphasis> that can be used to execute the rules in a Drools engine in the folder <emphasis> + <property>src/main/java</property> + </emphasis>, in the <emphasis> + <property>com.sample</property> + </emphasis> package. All the others jar's that are necessary during execution + are also added to the classpath in a custom classpath container called <property>Drools + Library</property>.</para> + + <tip> + <title>Tip:</title> + <para>Rules do not have to be kept in Java projects at all, this is just a convenience + for people who are already using eclipse as their Java IDE.</para> + </tip> + + </section> + + <section id="creating_rule"> + <title>Creating a New Rule</title> + + <para>Now we are going to add a new Rule package to the project.</para> + + <para>You can either create an empty text <emphasis> + <property>.drl</property> + </emphasis> file or make use of the special <property>New Rule Package...</property> + wizard to do it.</para> + + <para>To open the wizard follow to <emphasis> + <property>File > New > Rule Resource</property> + </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> + + <figure> + <title>Opening the New Rule Package Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the wizard page first select <emphasis> + <property>/rules</property> + </emphasis> as a top level directory to store your rules and type the rule name. Next + it's mandatory to specify the rule package name. It defines a namespace that + groups rules together.</para> + + <figure> + <title>New Rule Package Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As a result the wizard generates a rule skeleton to get you started.</para> + + <figure> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project10.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + +</chapter> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/debugging_rules.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/debugging_rules.xml 2010-06-08 23:27:46 UTC (rev 22646) +++ tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/debugging_rules.xml 2010-06-08 23:30:47 UTC (rev 22647) @@ -1,137 +1,141 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="debugging_rules" xreflabel="debugging_rules"> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Drools Tools</keyword> - </keywordset> - </chapterinfo> - - <title>Debugging rules</title> - - <para>This chapter describes how to debug rules during the execution of your Drools application.</para> - - <section id="creating_breakpoints"> - <title>Creating Breakpoints</title> - - <para>At first, we'll focus on how to add - breakpoints in the consequences of your rules.</para> - - <para>Whenever such a breakpoint is uncounted - during the execution of the rules, the execution is halted. It's possible then inspect the - variables known at that point and use any of the default debugging actions to decide what - should happen next (step over, continue, etc). To inspect - the content of the working memory and agenda the Debug views can be used.</para> - - <para>You can add/remove rule breakpoints in <emphasis> - <property>.drl</property> - </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> - - <itemizedlist> - <listitem> - <para>Double-click the ruler in the <property>Rule editor</property> at the line - where you want to add a breakpoint.</para> - <tip> - <title>Tip:</title> - <para>Note that rule breakpoints can only be created in the consequence of a - rule. Double-clicking on a line where no breakpoint is allowed will do - nothing.</para> - </tip> - <para>A breakpoint can be removed by double-clicking the ruler once more. </para> - </listitem> - - <listitem> - <para>Right-click the ruler. Select <emphasis> - <property>Toggle Breakpoint</property> - </emphasis> action in the appeared popup menu. Clicking the action will add a - breakpoint at the selected line or remove it if there is one already.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Adding Breakpoints</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/debugging_rules/debugging_rules1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The <property>Debug perspective</property> contains a <property>Breakpoints - view</property> which can be used to see all defined breakpoints, get their - properties, enable/disable or remove them, etc. You can switch to it by navigating to <emphasis> - <property>Window > Perspective > Others > Debug</property>.</emphasis></para> - </section> - - <section id="debugging"> - <title>Debugging</title> - - <para>Drools breakpoints are only enabled if you debug your application as a Drools - Application. To do this you should perform one of the actions:</para> - - <itemizedlist> - <listitem> - <para>Select the main class of your application. Right click it and select <emphasis> - <property>Debug As > Drools Application</property>.</emphasis></para> - </listitem> - </itemizedlist> - <figure> - <title>Debugging Drools Application</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/debugging_rules/debugging_rules2.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Alternatively, you can also go to <emphasis> - <property>Debug As > Debug Configuration</property> - </emphasis> to open a new dialog for creating, managing and running debug - configurations.</para> - - <para>Select the <emphasis> - <property>Drools Application</property> - </emphasis> item in the left tree and click the <emphasis> - <property>New launch configuration</property> - </emphasis> button (leftmost icon in the toolbar above the tree). This will - create a new configuration and already fill in some of the properties (like the - Project and Main class) based on main class you selected in the beginning. All - properties shown here are the same as any standard Java program.</para> - </listitem> - </itemizedlist> - - <figure> - <title>New Debug Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/debugging_rules/debugging_rules3.png"/> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - <para>Remember to change the name of your debug configuration to something meaningful.</para> - </tip> - - <para>Next - click the <emphasis> - <property>Debug</property> - </emphasis> button on the bottom to start debugging your application. </para> - - <para>After enabling the debugging, the application starts executing and will halt if - any breakpoint is encountered. This can be a Drools rule breakpoint, or any other - standard Java breakpoint. Whenever a Drools rule breakpoint is encountered, the - corresponding <emphasis> - <property>.drl</property></emphasis> file is opened and the active line is highlighted. The Variables view - also contains all rule parameters and their value. You can then use the default Java - debug actions to decide what to do next (resume, terminate, step over, etc.). The debug - views can also be used to determine the contents of the working memory and agenda at - that time as well (you don't have to select a working memory now, the current executing - working memory is automatically shown).</para> - - - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="debugging_rules" xreflabel="debugging_rules"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Debugging rules</title> + + <para>This chapter describes how to debug rules during the execution of your Drools application.</para> + + <section id="creating_breakpoints"> + <title>Creating Breakpoints</title> + + <para>At first, we'll focus on how to add + breakpoints in the consequences of your rules.</para> + + <para>Whenever such a breakpoint is uncounted + during the execution of the rules, the execution is halted. It's possible then inspect the + variables known at that point and use any of the default debugging actions to decide what + should happen next (step over, continue, etc). To inspect + the content of the working memory and agenda the Debug views can be used.</para> + + <para>To create breakpoints in the Package Explorer view or Navigator view of the Drools perspective, double-click the selected + <property>.drl</property> file to open it in the editor. In the example below we opened <property>Sample.drl</property> file. + </para> + + <para>You can add/remove rule breakpoints in the <emphasis> + <property>.drl</property> + </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> + + <itemizedlist> + <listitem> + <para>Double-click the ruler in the <property>Rule editor</property> at the line + where you want to add a breakpoint.</para> + <tip> + <title>Tip:</title> + <para>Note that rule breakpoints can only be created in the consequence of a + rule. Double-clicking on a line where no breakpoint is allowed will do + nothing.</para> + </tip> + <para>A breakpoint can be removed by double-clicking the ruler once more. </para> + </listitem> + + <listitem> + <para>Right-click the ruler. Select <emphasis> + <property>Toggle Breakpoint</property> + </emphasis> action in the appeared popup menu. Clicking the action will add a + breakpoint at the selected line or remove it if there is one already.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Adding Breakpoints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Debug perspective</property> contains a <property>Breakpoints + view</property> which can be used to see all defined breakpoints, get their + properties, enable/disable or remove them, etc. You can switch to it by navigating to <emphasis> + <property>Window > Perspective > Others > Debug</property>.</emphasis></para> + </section> + + <section id="debugging"> + <title>Debugging</title> + + <para>Drools breakpoints are only enabled if you debug your application as a Drools + Application. To do this you should perform one of the actions:</para> + + <itemizedlist> + <listitem> + <para>Select the main class of your application. Right click it and select <emphasis> + <property>Debug As > Drools Application</property>.</emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Debugging Drools Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules2.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Alternatively, you can also go to <emphasis> + <property>Debug As > Debug Configuration</property> + </emphasis> to open a new dialog for creating, managing and running debug + configurations.</para> + + <para>Select the <emphasis> + <property>Drools Application</property> + </emphasis> item in the left tree and click the <emphasis> + <property>New launch configuration</property> + </emphasis> button (leftmost icon in the toolbar above the tree). This will + create a new configuration and already fill in some of the properties (like the + Project and Main class) based on main class you selected in the beginning. All + properties shown here are the same as any standard Java program.</para> + </listitem> + </itemizedlist> + + <figure> + <title>New Debug Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules3.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Remember to change the name of your debug configuration to something meaningful.</para> + </tip> + + <para>Next + click the <emphasis> + <property>Debug</property> + </emphasis> button on the bottom to start debugging your application. </para> + + <para>After enabling the debugging, the application starts executing and will halt if + any breakpoint is encountered. This can be a Drools rule breakpoint, or any other + standard Java breakpoint. Whenever a Drools rule breakpoint is encountered, the + corresponding <emphasis> + <property>.drl</property></emphasis> file is opened and the active line is highlighted. The Variables view + also contains all rule parameters and their value. You can then use the default Java + debug actions to decide what to do next (resume, terminate, step over, etc.). The debug + views can also be used to determine the contents of the working memory and agenda at + that time as well (you don't have to select a working memory now, the current executing + working memory is automatically shown).</para> + + + </section> +</chapter> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/editors.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/editors.xml 2010-06-08 23:27:46 UTC (rev 22646) +++ tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/editors.xml 2010-06-08 23:30:47 UTC (rev 22647) @@ -1,537 +1,537 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="editors" xreflabel="editors"> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Drools Tools</keyword> - </keywordset> - </chapterinfo> - - <title>Editors</title> - <section id="dsl_editor"> - <title>DSL Editor</title> - <para>A domain-specific language is a set of custom rules, - that is created specifically to solve problems in a particular domain - and is not intended to be able to solve problems outside it. - A DSL's configuration is stored in plain text. - </para> - <para>In Drools this configuration is presented by <property>.dsl</property> - files that can be created by <emphasis>right click on the project->New->Other->Drools->Domain Specific Language</emphasis>.</para> - <para>DSL Editor is a default editor for <property>.dsl</property> files:</para> - <figure> - <title>DSL Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1a.png"/> - </imageobject> - </mediaobject> - </figure> - <para>In the table below all the components of the DSL Editor page are described:</para> - <table> - <title>DSL Editor Components.</title> - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="3*"/> - - <thead> - <row> - <entry>Components</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Description</entry> - <entry>User's comments on a certain language message mapping</entry> - </row> - <row> - <entry>Table of language message mappings</entry> - <entry>The table is divided into 4 rows: - <itemizedlist id="rows"> - <listitem><para><emphasis>Language Expression</emphasis> :expression you want to use as a rule</para></listitem> - <listitem><para><emphasis>Rule Language Mapping</emphasis> :the implementation of the rules.This means that to this language expression the rule will be compiled - by the rule engine compiler.</para></listitem> - <listitem><para><emphasis>Object</emphasis> :name of the object</para></listitem> - <listitem><para><emphasis>Scope</emphasis> :indicates where the expression is - targeted: is it for the "condition" part of the rule ,"consequence" part, etc.</para></listitem> - </itemizedlist> - By clicking on some row's header you can sort the lines in the table according to the clicked row. - By double clicking on the line <link linkend="edit_wizard">Edit language mapping Wizard</link> will be open. - </entry> - </row> - <row> - <entry>Expression</entry> - <entry>Shows the language expression of the selected table line(language message mapping).</entry> - </row> - - <row> - <entry>Mapping</entry> - <entry>Shows the rule of language mapping for the selected table line(language message mapping).</entry> - </row> - <row> - <entry>Object</entry> - <entry>Shows the object for the selected table line(language message mapping)</entry> - </row> - - <row> - <entry id="sort">Sort By</entry> - <entry>Using this option you can change the type of lines sorting - in the table of language message mappings.To do this select from the drop down lins the method - of sorting you want and click <emphasis>Sort</emphasis> button.</entry> - </row> - <row> - <entry>Buttons</entry> - <entry><itemizedlist> - <listitem><para><emphasis>Edit</emphasis> :by clicking the button users can edit - selected in the table of language message mappings lines.For more information look - <link linkend="edit_wizard">Edit language mapping Wizard</link>section.</para></listitem> - <listitem><para><emphasis>Remove</emphasis> :if you click the button the selected mapping line will be deleted. </para></listitem> - <listitem><para><emphasis>Add</emphasis> :with this button you can add new mapping lines to the table.For more information look - <link linkend="add_wizard">Add language mapping Wizard</link>section. </para></listitem> - <listitem><para><emphasis>Sort</emphasis> : please, for more information go <link linkend="sort">here</link></para></listitem> - <listitem><para><emphasis>Copy</emphasis> :with this button you can add new mapping lines to the table - in which all the information will be copied from the selected mapping line.</para></listitem> - </itemizedlist> - </entry> - </row> - </tbody> - </tgroup> - </table> - <section id="edit_wizard"> - <title>Edit language mapping Wizard</title> - <para>This wizard can be opened by double clicking some line - in the table of language message mappings or by clicking the <emphasis>Edit</emphasis>button.</para> - <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> - <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> - <figure> - <title>Edit language mapping Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1c.png"/> - </imageobject> - </mediaobject> - </figure> - <para>To change the mapping a user should edit the otions he want and finally click <emphasis>Ok</emphasis>.</para> - </section> - <section id="add_wizard"> - <title>Add language mapping Wizard</title> - <para>This wizard is equal to <link linkend="edit_wizard">Edit language mapping Wizard</link>. - It can be opened by clicking the <emphasis>Add</emphasis> button. - </para> - <para>The only difference is that instead of editing the information you should enter new one.</para> - <figure> - <title>Add language mapping Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1b.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - </section> - <section id="ruleflow_editor"> - <title>Flow Editor</title> - <para>Drools tools also provide some functionality to define the order in - which rules should be executed.Ruleflow file allows you to specify - the order in which rule sets should be evaluated using a flow chart. - So you can define which rule sets should be evaluated in sequence or in parallel as well as - specify conditions under which rule sets should be evaluated.</para> - <para>Ruleflows can be set only by using the graphical flow editor which is part of the Drools plugin for Eclipse. - Once you have set up a Drools project,you can start adding ruleflows. - Add a ruleflow file(.rf) by clicking on the project and selecting "<emphasis>New -> Other...->Flow File</emphasis>":</para> - <figure> - <title>RuleFlow file creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1f.png"/> - </imageobject> - </mediaobject> - </figure> - <para>By default these ruleflow files (.rf) are opened in the graphical Flow editor. - You can see it on the picture below.</para> - <figure> - <title>Flow Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1g.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The Flow editor consists of a <emphasis>palette</emphasis>, a <emphasis>canvas</emphasis> - and an <emphasis>outline</emphasis> view. To add new elements to the canvas, select the - element you would like to create in the palette and then add it to the canvas by clicking on the preferred location. - </para> - <figure> - <title>Adding an element to the canvas</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1e.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Clicking on the Select option in the palette and - then on the element in your ruleflow allows you to - view and set the properties of that element in the properies view.</para> - <figure> - <title>Properties view</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1d.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. - So using your Outline view you can easly navigate between parts of a schema. </para> - <figure> - <title>Outline view usage</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors9.png"/> - </imageobject> - </mediaobject> - </figure> - <section> - <title>Different types of control elements in Flow Palette</title> - <para>Flow editor supports three types of control elements. - They are:</para> - <table> <title>Flow Palette Components.Part 1</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="1*"/> - <colspec colnum="3" align="left" colwidth="3*"/> - - <thead> - <row> - <entry>Component Picture</entry> - <entry>Component Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon7.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Select</entry> - <entry>Select a node on the canvas</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon8.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Marquee</entry> - <entry>Is used for selecting a group of elements</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon9.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Sequence Flow</entry> - <entry>Use this element to join two elements on the canvas</entry> - </row> - </tbody> - - </tgroup> - </table> - </section> - - <section> - <title>Different types of nodes in Flow Palette</title> - - <para>Currently, ruleflow supports seven types of nodes. - In the table below you can find information about them:</para> - <table> <title>Flow Palette Components.Part 2.</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="1*"/> - <colspec colnum="3" align="left" colwidth="3*"/> - - <thead> - <row> - <entry>Component Picture</entry> - <entry>Component Name</entry> - <entry>Description</entry> - </row> - - </thead> - <tbody> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon1.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Start Event</entry> - <entry>The start of the ruleflow. A ruleflow should have exactly - one start node. The <property>Start Event</property> can not have incoming - connections and should have one outgoing connection. Whenever the ruleflow process is started, - the executing is started here and is automatically proceeded to the first node - linked to this <property>Start Event</property></entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon2.png"/> - </imageobject></inlinemediaobject></entry> - <entry>End Event</entry> - <entry>A ruleflow file can have one or more <property>End Events</property>. - The <property>End Event</property> node should have one incoming connection - and can not have outgoing connections. When an end node is reached in the ruleflow, - the ruleflow is terminated (including other remaining active nodes when parallelism - is used).</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon3.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Rule Task</entry> - <entry>represents a set of rules. A <emphasis>Rule Task</emphasis> node should have one - incoming connection and one outgoing connection. - The <property>RuleFlowGroup</property> property which is used to specify the name of the - ruleflow-group that represents the set of rules of this <emphasis>Rule Task</emphasis> node. - When a <emphasis>Rule Task</emphasis> node is reached in the ruleflow, the engine will start - executing rules that are a part of the corresponding ruleflow-group. - Execution automatically continues to the next node when there are no - more active rules in this ruleflow-group. - </entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon4.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Gateway[diverge]</entry> - <entry>allows you to create branches in your ruleflow. - A <property>Gateway[diverge]</property> node should have one incoming connection and two or more - outgoing connections.</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon4.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Gateway[converge]</entry> - <entry>allows you to synchronize multiple branches. - A <property>Gateway[diverge]</property>node should have two or more incoming connections and one - outgoing connection.</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon5.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Reusable Sup-Process</entry> - <entry>represents the invocation of another ruleflow from this ruleflow. - A subflow node should have one incoming connection and one outgoing connection. - It contains the property "processId" which specifies the id of the process that should be executed. - When a <property>Reusable Sup-Process</property> node is reached in the ruleflow, the engine will start the process with the given id. - The subflow node will only continue if that subflow process has terminated its execution. - Note that the subflow process is started as an independent process, - which means that the subflow process will not be terminated if this process reaches an end node.</entry> - </row> - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/editors/icon6.png"/> - </imageobject></inlinemediaobject></entry> - <entry>Script Task</entry> - <entry>represents an action that should be executed in this ruleflow. - An <property>Script Task</property> node should have one incoming connection and one outgoing - connection. It contains the property "action" which specifies the action that should be executed. - When a <property>Script Task</property> node is reached in the ruleflow, it will execute the action and - continue with the next node. An action should be specified as a piece of (valid) - MVEL code. </entry> - </row> - - </tbody> - </tgroup> - </table> - </section> - </section> - - <section id="textual_rule_editor"> - <title>The Rule Editor</title> - - <para>The <property>Rule editor</property> works on files that have a <emphasis> - <property>.drl</property> - </emphasis> (or <emphasis> - <property>.rule</property> - </emphasis> in the case of spreading rules across multiple rule files) extension.</para> - - <figure> - <title>New Rule</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The editor follows the pattern of a normal text editor in eclipse, with all the normal - features of a text editor:</para> - - <itemizedlist> - <listitem> - <para> - <link linkend="rules_editor_content_assist">Content Assist</link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="rules_editor_code_folding">Code Folding</link> - </para> - </listitem> - -  - - <listitem> - <para> - <link linkend="rules_editor_sync_with_outline">Synchronization with Outline - View</link> - </para> - </listitem> - </itemizedlist> - - <section id="rules_editor_content_assist"> - <title>Content Assist</title> - - <para>While working in the <property>Rule editor</property> you can get a content - assistance the usual way by pressing <emphasis> - <property>Ctrl + Space</property>.</emphasis></para> - - <para>Content Assist shows all possible keywords for the current cursor position.</para> - - <figure> - <title>Content Assist Demonstration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Content Assist inside of the <emphasis> - <property>Message</property> - </emphasis> suggests all available fields.</para> - - <figure> - <title>Content Assist Demonstration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors3.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section id="rules_editor_code_folding"> - <title>Code Folding</title> - - <para>Code folding is also available in the <property>Rule editor</property>. To - hide/show sections of the file use the icons with minus/plus on the left vertical - line of the editor.</para> - - <figure> - <title>Code Folding</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors4.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - -  - - <section id="rules_editor_sync_with_outline"> - <title>Synchronization with Outline View</title> - - <para>The <property>Rule editor</property> works in synchronization with the - <property>Outline view</property> which shows the structure of the rules, - imports in the file and also globals and functions if the file has them.</para> - - <figure> - <title>Synchronization with Outline View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The view is updated on save. It provides a quick way of navigating around rules by - names in a file which may have hundreds of rules. The items are sorted - alphabetically by default.</para> - </section> - - <section id="rete_view"> - <title>The Rete Tree View</title> - - <para>The <property>Rete Tree view</property> shows you the current Rete Network for - your <emphasis> - <property>.drl</property> - </emphasis> file. Just click on the <emphasis> - <property>Rete Tree tab</property> - </emphasis> at the bottom of the <property>Rule editor</property>.</para> - - <figure> - <title>Rete Tree</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors6.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Afterwards you can generate the current Rete Network visualization. You can push - and pull the nodes to arrange your optimal network overview.</para> - <para>If you got hundreds of nodes, select some of them with a frame. Then you can pull - groups of them.</para> - - <figure> - <title>Selecting the nodes in the Rete Tree with Frame</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You can zoom in and out the Rete tree in case not all nodes are shown in the - current view. For this use the combo box or "+" and "-" icons on the toolbar.</para> - - <figure> - <title>Rete Tree Zooming</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/editors/editors8.png"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - - <para>The <property>Rete Tree view</property> works only in Drools Rule Projects, - where the Drools Builder is set in the project properties.</para> - </note> - <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. 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> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="editors" xreflabel="editors"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Editors</title> + <section id="dsl_editor"> + <title>DSL Editor</title> + <para>A domain-specific language is a set of custom rules, + that is created specifically to solve problems in a particular domain + and is not intended to be able to solve problems outside it. + A DSL's configuration is stored in plain text. + </para> + <para>In Drools this configuration is presented by <property>.dsl</property> + files that can be created by <emphasis>right click on the project->New->Other->Drools->Domain Specific Language</emphasis>.</para> + <para>DSL Editor is a default editor for <property>.dsl</property> files:</para> + <figure> + <title>DSL Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the table below all the components of the DSL Editor page are described:</para> + <table> + <title>DSL Editor Components.</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Components</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Description</entry> + <entry>User's comments on a certain language message mapping</entry> + </row> + <row> + <entry>Table of language message mappings</entry> + <entry>The table is divided into 4 rows: + <itemizedlist id="rows"> + <listitem><para><emphasis>Language Expression</emphasis> :expression you want to use as a rule</para></listitem> + <listitem><para><emphasis>Rule Language Mapping</emphasis> :the implementation of the rules.This means that to this language expression the rule will be compiled + by the rule engine compiler.</para></listitem> + <listitem><para><emphasis>Object</emphasis> :name of the object</para></listitem> + <listitem><para><emphasis>Scope</emphasis> :indicates where the expression is + targeted: is it for the "condition" part of the rule ,"consequence" part, etc.</para></listitem> + </itemizedlist> + By clicking on some row's header you can sort the lines in the table according to the clicked row. + By double clicking on the line <link linkend="edit_wizard">Edit language mapping Wizard</link> will be open. + </entry> + </row> + <row> + <entry>Expression</entry> + <entry>Shows the language expression of the selected table line(language message mapping).</entry> + </row> + + <row> + <entry>Mapping</entry> + <entry>Shows the rule of language mapping for the selected table line(language message mapping).</entry> + </row> + <row> + <entry>Object</entry> + <entry>Shows the object for the selected table line(language message mapping)</entry> + </row> + + <row> + <entry id="sort">Sort By</entry> + <entry>Using this option you can change the type of lines sorting + in the table of language message mappings. To do this select from the drop down list the method + of sorting you want and click <emphasis>Sort</emphasis> button.</entry> + </row> + <row> + <entry>Buttons</entry> + <entry><itemizedlist> + <listitem><para><emphasis>Edit</emphasis> :by clicking the button users can edit + selected in the table of language message mappings lines.For more information look + <link linkend="edit_wizard">Edit language mapping Wizard</link>section.</para></listitem> + <listitem><para><emphasis>Remove</emphasis> :if you click the button the selected mapping line will be deleted. </para></listitem> + <listitem><para><emphasis>Add</emphasis> :with this button you can add new mapping lines to the table.For more information look + <link linkend="add_wizard">Add language mapping Wizard</link>section. </para></listitem> + <listitem><para><emphasis>Sort</emphasis> : please, for more information go <link linkend="sort">here</link></para></listitem> + <listitem><para><emphasis>Copy</emphasis> :with this button you can add new mapping lines to the table + in which all the information will be copied from the selected mapping line.</para></listitem> + </itemizedlist> + </entry> + </row> + </tbody> + </tgroup> + </table> + <section id="edit_wizard"> + <title>Edit language mapping Wizard</title> + <para>This wizard can be opened by double clicking some line + in the table of language message mappings or by clicking the <emphasis>Edit</emphasis> button.</para> + <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> + <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> + <figure> + <title>Edit language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1c.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To change the mapping a user should edit the otions he want and finally click <emphasis>Ok</emphasis>.</para> + </section> + <section id="add_wizard"> + <title>Add language mapping Wizard</title> + <para>This wizard is equal to <link linkend="edit_wizard">Edit language mapping Wizard</link>. + It can be opened by clicking the <emphasis>Add</emphasis> button. + </para> + <para>The only difference is that instead of editing the information you should enter new one.</para> + <figure> + <title>Add language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="ruleflow_editor"> + <title>Flow Editor</title> + <para>Drools tools also provide some functionality to define the order in + which rules should be executed.Ruleflow file allows you to specify + the order in which rule sets should be evaluated using a flow chart. + So you can define which rule sets should be evaluated in sequence or in parallel as well as + specify conditions under which rule sets should be evaluated.</para> + <para>Ruleflows can be set only by using the graphical flow editor which is part of the Drools plugin for Eclipse. + Once you have set up a Drools project,you can start adding ruleflows. + Add a ruleflow file(.rf) by clicking on the project and selecting "<emphasis>New -> Other...->Flow File</emphasis>":</para> + <figure> + <title>RuleFlow file creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1f.png"/> + </imageobject> + </mediaobject> + </figure> + <para>By default these ruleflow files (.rf) are opened in the graphical Flow editor. + You can see it on the picture below.</para> + <figure> + <title>Flow Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1g.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The Flow editor consists of a <emphasis>palette</emphasis>, a <emphasis>canvas</emphasis> + and an <emphasis>outline</emphasis> view. To add new elements to the canvas, select the + element you would like to create in the palette and then add it to the canvas by clicking on the preferred location. + </para> + <figure> + <title>Adding an element to the canvas</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1e.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on the Select option in the palette and + then on the element in your ruleflow allows you to + view and set the properties of that element in the properies view.</para> + <figure> + <title>Properties view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1d.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. + So using your Outline view you can easily navigate between parts of a schema. </para> + <figure> + <title>Outline view usage</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors9.png"/> + </imageobject> + </mediaobject> + </figure> + <section> + <title>Different types of control elements in Flow Palette</title> + <para>Flow editor supports three types of control elements. + They are:</para> + <table> <title>Flow Palette Components.Part 1</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon7.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Select</entry> + <entry>Select a node on the canvas</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon8.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Marquee</entry> + <entry>Is used for selecting a group of elements</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon9.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Sequence Flow</entry> + <entry>Use this element to join two elements on the canvas</entry> + </row> + </tbody> + + </tgroup> + </table> + </section> + + <section> + <title>Different types of nodes in Flow Palette</title> + + <para>Currently, ruleflow supports seven types of nodes. + In the table below you can find information about them:</para> + <table> <title>Flow Palette Components.Part 2.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon1.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Start Event</entry> + <entry>The start of the ruleflow. A ruleflow should have exactly + one start node. The <property>Start Event</property> can not have incoming + connections and should have one outgoing connection. Whenever the ruleflow process is started, + the executing is started here and is automatically proceeded to the first node + linked to this <property>Start Event</property></entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon2.png"/> + </imageobject></inlinemediaobject></entry> + <entry>End Event</entry> + <entry>A ruleflow file can have one or more <property>End Events</property>. + The <property>End Event</property> node should have one incoming connection + and can not have outgoing connections. When an end node is reached in the ruleflow, + the ruleflow is terminated (including other remaining active nodes when parallelism + is used).</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon3.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Rule Task</entry> + <entry>represents a set of rules. A <emphasis>Rule Task</emphasis> node should have one + incoming connection and one outgoing connection. + The <property>RuleFlowGroup</property> property which is used to specify the name of the + ruleflow-group that represents the set of rules of this <emphasis>Rule Task</emphasis> node. + When a <emphasis>Rule Task</emphasis> node is reached in the ruleflow, the engine will start + executing rules that are a part of the corresponding ruleflow-group. + Execution automatically continues to the next node when there are no + more active rules in this ruleflow-group. + </entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[diverge]</entry> + <entry>allows you to create branches in your ruleflow. + A <property>Gateway[diverge]</property> node should have one incoming connection and two or more + outgoing connections.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[converge]</entry> + <entry>allows you to synchronize multiple branches. + A <property>Gateway[diverge]</property> node should have two or more incoming connections and one + outgoing connection.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon5.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Reusable Sup-Process</entry> + <entry>represents the invocation of another ruleflow from this ruleflow. + A subflow node should have one incoming connection and one outgoing connection. + It contains the property "processId" which specifies the id of the process that should be executed. + When a <property>Reusable Sup-Process</property> node is reached in the ruleflow, the engine will start the process with the given id. + The subflow node will only continue if that subflow process has terminated its execution. + Note that the subflow process is started as an independent process, + which means that the subflow process will not be terminated if this process reaches an end node.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon6.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Script Task</entry> + <entry>represents an action that should be executed in this ruleflow. + An <property>Script Task</property> node should have one incoming connection and one outgoing + connection. It contains the property "action" which specifies the action that should be executed. + When a <property>Script Task</property> node is reached in the ruleflow, it will execute the action and + continue with the next node. An action should be specified as a piece of (valid) + MVEL code. </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + </section> + + <section id="textual_rule_editor"> + <title>The Rule Editor</title> + + <para>The <property>Rule editor</property> works on files that have a <emphasis> + <property>.drl</property> + </emphasis> (or <emphasis> + <property>.rule</property> + </emphasis> in the case of spreading rules across multiple rule files) extension.</para> + + <figure> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The editor follows the pattern of a normal text editor in eclipse, with all the normal + features of a text editor:</para> + + <itemizedlist> + <listitem> + <para> + <link linkend="rules_editor_content_assist">Content Assist</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="rules_editor_code_folding">Code Folding</link> + </para> + </listitem> + +  + + <listitem> + <para> + <link linkend="rules_editor_sync_with_outline">Synchronization with Outline + View</link> + </para> + </listitem> + </itemizedlist> + + <section id="rules_editor_content_assist"> + <title>Content Assist</title> + + <para>While working in the <property>Rule editor</property> you can get a content + assistance the usual way by pressing <emphasis> + <property>Ctrl + Space</property>.</emphasis></para> + + <para>Content Assist shows all possible keywords for the current cursor position.</para> + + <figure> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist inside of the <emphasis> + <property>Message</property> + </emphasis> suggests all available fields.</para> + + <figure> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors3.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="rules_editor_code_folding"> + <title>Code Folding</title> + + <para>Code folding is also available in the <property>Rule editor</property>. To + hide/show sections of the file use the icons with minus/plus on the left vertical + line of the editor.</para> + + <figure> + <title>Code Folding</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors4.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + +  + + <section id="rules_editor_sync_with_outline"> + <title>Synchronization with Outline View</title> + + <para>The <property>Rule editor</property> works in synchronization with the + <property>Outline view</property> which shows the structure of the rules, + imports in the file and also globals and functions if the file has them.</para> + + <figure> + <title>Synchronization with Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The view is updated on save. It provides a quick way of navigating around rules by + names in a file which may have hundreds of rules. The items are sorted + alphabetically by default.</para> + </section> + + <section id="rete_view"> + <title>The Rete Tree View</title> + + <para>The <property>Rete Tree view</property> shows you the current Rete Network for + your <emphasis> + <property>.drl</property> + </emphasis> file. Just click on the <emphasis> + <property>Rete Tree tab</property> + </emphasis> at the bottom of the <property>Rule editor</property>.</para> + + <figure> + <title>Rete Tree</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Afterwards you can generate the current Rete Network visualization. You can push + and pull the nodes to arrange your optimal network overview.</para> + <para>If you got hundreds of nodes, select some of them with a frame. Then you can pull + groups of them.</para> + + <figure> + <title>Selecting the nodes in the Rete Tree with Frame</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can zoom in and out the Rete tree in case not all nodes are shown in the + current view. For this use the combo box or "+" and "-" icons on the toolbar.</para> + + <figure> + <title>Rete Tree Zooming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors8.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>The <property>Rete Tree view</property> works only in Drools Rule Projects, + where the Drools Builder is set in the project properties.</para> + </note> + <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. 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> \ No newline at end of file Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png =================================================================== (Binary files differ) Modified: tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/master_output.xml 2010-06-08 23:27:46 UTC (rev 22646) +++ tags/jbosstools-3.1.1.GA/drools/docs/reference/en-US/master_output.xml 2010-06-08 23:30:47 UTC (rev 22647) @@ -2,12 +2,12 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY introduction SYSTEM "modules/introduction.xml"> -<!ENTITY create_new_project SYSTEM "modules/create_new_project.xml"> -<!ENTITY create_new SYSTEM "modules/create_new.xml"> -<!ENTITY debugging_rules SYSTEM "modules/debugging_rules.xml"> -<!ENTITY views SYSTEM "modules/views.xml"> -<!ENTITY editors SYSTEM "modules/editors.xml"> +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY create_new_project SYSTEM "create_new_project.xml"> +<!ENTITY create_new SYSTEM "create_new.xml"> +<!ENTITY debugging_rules SYSTEM "debugging_rules.xml"> +<!ENTITY views SYSTEM "views.xml"> +<!ENTITY editors SYSTEM "editors.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -59,7 +59,7 @@ <toc></toc> -<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/introduction.xml" xreflabel="introduction"> +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en-US/introduction.xml" xreflabel="introduction"> <title>Introduction</title> <section id="whatisDrools"> @@ -81,7 +81,7 @@ <para><property moreinfo="none">Drools Tools</property> come bundled with <property moreinfo="none">JBoss Tools</property> set of Eclipse plugins. How to install <property moreinfo="none">JBoss Tools</property> you can find in - the <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">Getting Started Guide</ulink>.</para> + the Getting Started Guide.</para> </section> <section id="drools_key_features"> @@ -229,7 +229,7 @@ </chapter> -<chapter id="create_new_project" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/create_new_project.xml" xreflabel="create_new_project"> +<chapter id="create_new_project" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en-US/create_new_project.xml" xreflabel="create_new_project"> <chapterinfo> <keywordset> <keyword>JBoss Tools</keyword> @@ -395,19 +395,19 @@ <section id="creating_rule"> <title>Creating a New Rule</title> - <para>Now we are going to add a new Rule resource to the project.</para> + <para><diffmk:wrapper diffmk:change="changed">Now we are going to add a new Rule package to the project.</diffmk:wrapper></para> <para>You can either create an empty text <emphasis> <property moreinfo="none">.drl</property> - </emphasis> file or make use of the special <property moreinfo="none">New Rule Resource - wizard</property> to do it.</para> + </emphasis> file or make use of the special <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New Rule Package...</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> + wizard to do it.</diffmk:wrapper></para> <para>To open the wizard follow to <emphasis> <property moreinfo="none">File > New > Rule Resource</property> </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> <figure float="0"> - <title>Opening the New Rule Resource Wizard</title> + <title><diffmk:wrapper diffmk:change="changed">Opening the New Rule Package Wizard</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/create_new_project/create_new_project8.png"></imagedata> @@ -422,7 +422,7 @@ groups rules together.</para> <figure float="0"> - <title>New Rule Resource Wizard</title> + <title><diffmk:wrapper diffmk:change="changed">New Rule Package Wizard</diffmk:wrapper></title> <mediaobject> <imageobject> <imagedata fileref="images/create_new_project/create_new_project9.png"></imagedata> @@ -444,9 +444,8 @@ </section> </chapter> - -<chapter id="debugging_rules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/debugging_rules.xml" xreflabel="debugging_rules"> +<chapter id="debugging_rules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en-US/debugging_rules.xml" xreflabel="debugging_rules"> <chapterinfo> <keywordset> <keyword>JBoss Tools</keyword> @@ -470,7 +469,11 @@ should happen next (step over, continue, etc). To inspect the content of the working memory and agenda the Debug views can be used.</para> - <para>You can add/remove rule breakpoints in <emphasis> + <para><diffmk:wrapper diffmk:change="added">To create breakpoints in the Package Explorer view or Navigator view of the Drools perspective, double-click the selected + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">.drl</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file to open it in the editor. In the example below we opened </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Sample.drl</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file. + </diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can add/remove rule breakpoints in the </diffmk:wrapper><emphasis> <property moreinfo="none">.drl</property> </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> @@ -582,9 +585,8 @@ </section> </chapter> - -<chapter id="editors" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/editors.xml" xreflabel="editors"> +<chapter id="editors" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en-US/editors.xml" xreflabel="editors"> <chapterinfo> <keywordset> <keyword>JBoss Tools</keyword> @@ -660,9 +662,9 @@ <row> <entry id="sort">Sort By</entry> - <entry>Using this option you can change the type of lines sorting - in the table of language message mappings.To do this select from the drop down lins the method - of sorting you want and click <emphasis>Sort</emphasis> button.</entry> + <entry><diffmk:wrapper diffmk:change="changed">Using this option you can change the type of lines sorting + in the table of language message mappings. To do this select from the drop down list the method + of sorting you want and click </diffmk:wrapper><emphasis>Sort</emphasis> button.</entry> </row> <row> <entry>Buttons</entry> @@ -684,8 +686,8 @@ </table> <section id="edit_wizard"> <title>Edit language mapping Wizard</title> - <para>This wizard can be opened by double clicking some line - in the table of language message mappings or by clicking the <emphasis>Edit</emphasis>button.</para> + <para><diffmk:wrapper diffmk:change="changed">This wizard can be opened by double clicking some line + in the table of language message mappings or by clicking the </diffmk:wrapper><emphasis>Edit</emphasis><diffmk:wrapper diffmk:change="changed"> button.</diffmk:wrapper></para> <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> <figure float="0"> @@ -765,8 +767,8 @@ </imageobject> </mediaobject> </figure> - <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. - So using your Outline view you can easly navigate between parts of a schema. </para> + <para><diffmk:wrapper diffmk:change="changed">Outline View is useful for big complex schemata where not all nodes are seen at one time. + So using your Outline view you can easily navigate between parts of a schema. </diffmk:wrapper></para> <figure float="0"> <title>Outline view usage</title> <mediaobject> @@ -900,8 +902,8 @@ </imageobject></inlinemediaobject></entry> <entry>Gateway[converge]</entry> <entry>allows you to synchronize multiple branches. - A <property moreinfo="none">Gateway[diverge]</property>node should have two or more incoming connections and one - outgoing connection.</entry> + A <property moreinfo="none">Gateway[diverge]</property><diffmk:wrapper diffmk:change="changed"> node should have two or more incoming connections and one + outgoing connection.</diffmk:wrapper></entry> </row> <row> <entry><inlinemediaobject> @@ -1113,15 +1115,10 @@ <para>The <property moreinfo="none">Rete Tree view</property> works only in Drools Rule Projects, where the Drools Builder is set in the project properties.</para> </note> - <para>We hope, this guide helped you to get started with the JBoss BPMN - Convert module. 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> + <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. 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> - - -</book> +</chapter></book>

14 years, 7 months

1
0
0 / 0

JBoss Tools SVN: r22646 - tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-06-08 19:27:46 -0400 (Tue, 08 Jun 2010) New Revision: 22646 Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/conclusion.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/functionality_overview.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/introduction.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master.xml tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master_output.xml Log: updated for 3.0.1 Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/conclusion.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/conclusion.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/conclusion.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -8,7 +8,7 @@ </keywordset> </chapterinfo> - <title>Conclusion</title> + <title>Summary</title> <para>As stated at the beginning of this document, the key goal of the <property>EGT</property> is to provide a way of interacting with Guvnor repository resources in a local Eclipse @@ -16,7 +16,39 @@ aspects of the current tooling that require revision going forward, we feel that the current state of the <property>EGT</property> is sufficient for the major use cases.</para> - <para>If you have some questions, comments or suggestions on the topic, please feel free to ask in the + <section> + <title>Other relevant resources on the topic</title> + <para>For more information visit the following resources:</para> + <itemizedlist> + <listitem> + <para>Guvnor <ulink url="http://www.jboss.org/community/wiki/Guvnor">wiki page</ulink></para> + </listitem> + + <listitem> + <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink></para> + </listitem> + + <listitem> + <para> + <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest + JBossTools/JBDS documentation builds</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://docs.jboss.org/tools/">JBossTools/JBDS + release documentation</ulink></para> + </listitem> + </itemizedlist> + <para>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>.</para> + </section> </chapter> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/functionality_overview.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/functionality_overview.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/functionality_overview.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -8,273 +8,30 @@ </keywordset> </chapterinfo> - <title>Functionality Overview</title> + <title>Tasks</title> - <para>This chapter will introduce you to the <property>Guvnor Repository Exploring - perspective</property> and give an overview on all functionality the <property>Guvnor Tools</property> provides.</para> - - <section id="guvnor_perspective"> - <title>Guvnor Perspective</title> - - <para>The <property>Guvnor Repository Exploring perspective</property> contains two views - supplied by <property>EGT</property> – <property>Repository Explorer</property> and - <property>Version History</property>, that will be the center of most interaction - with Guvnor, and Eclipse standard views such as <property>Properties</property> and - <property>Resource Navigator</property> that are also useful.</para> - - <para>While each of these views can be opened and positioned independently within an Eclipse - workbench, the <property>Guvnor perspective</property> provides a convenient method of - getting a suggested layout. In the Eclipse workbench menu, choose <emphasis> - <property>Window > Open Perspective > Other</property> - </emphasis> to get the perspective list:</para> - - <figure> - <title>Enabling the Guvnor Repository Perspective</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>And then choose <emphasis> - <property>Guvnor Repository Exploring</property>.</emphasis> This opens the - <property>Guvnor perspective</property>.</para> - </section> - - <section id="connection_wizard"> - <title>Guvnor Connection Wizard</title> - - <para>After opening the <property>Guvnor perspective</property>, the first task is to make a - connection to a Guvnor repository. This is handled by the <property>Guvnor Connection - wizard</property>. This wizard appears in a number of places within the - <property>EGT</property> (as detailed below), but in this section we will cover only - the two most basic entry points.</para> - - <para>The <property>Guvnor Connection wizard</property> can be started in the following - ways:</para> - - <itemizedlist> - <listitem> - <para>using the Eclipse menu <emphasis> - <property>File > New > Other > Guvnor > Guvnor - repository location</property> - </emphasis></para> - - <figure> - <title>New Guvnor Repository Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/start_guvnor_connection1.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>in the <property>Guvnor Repositories view</property> using the drop-down menu</para> - - <figure> - <title>Adding New Guvnor Connection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>using the menu button - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_connection_button.png"/> - </imageobject> - </inlinemediaobject> ) - </para> - </listitem> - </itemizedlist> - - <para>Choosing either of these will start the <property>Guvnor Connection - wizard</property>.</para> - - <figure id="guvnor_connection_wizard"> - <title>Guvnor Connection Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_connection_wizard.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Default values appear in the <emphasis> - <property>Location</property>,</emphasis> - <emphasis> - <property>Port</property>,</emphasis> and <emphasis> - <property>Repository</property> - </emphasis> fields (See the <link linkend="guvnor_preferences">“Guvnor Preferences”</link> section below for details about how to - change these default values.) Of course, any of these fields can be edited by typing in - the corresponding text box. Drag-and-drop or paste into the <emphasis> - <property>Location</property> - </emphasis> field of a typical Guvnor repository URL such as:</para> - - <para> - <emphasis> - <property>http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</property> - </emphasis> - </para> - - <para>Results in the URL being parsed into the respective fields as well. The authentication - information (user name and password) can optionally be stored in the Eclipse - workbench's key-ring file based on the selection of <emphasis> - <property>Save user name and password</property>.</emphasis></para> - - <note> - <title>Note:</title> - <para>If the authentication information is not stored in the key-ring, then the - <property>EGT</property> uses a session authentication, what means that the - credentials supplied are used only for the lifetime of the Eclipse workbench - instance.</para> - </note> - - <para>If authentication information is not stored in the key-ring or the authentication - information (key-ring or session) is not valid, the <property>EGT</property> will prompt - for authentication information when it has to access the Guvnor repository.</para> - - <para>If authentication fails, the <property>EGT</property> will retry once and then issue - an authentication failure error.</para> - - <tip> - <title>Tip:</title> - <para>If an authentication failure error occurs, you can retry the same operation and - supply different authentication information.</para> - </tip> - - <para>Note that the <property>EGT</property> calls the Guvnor repository at various times, - such as when determining if resource updates are available. Thus if you use session - authentication, the authentication dialog will appear at different times during the - Eclipse workbench session, depending on what actions you take. For ease of use, we - recommend saving the authentication information in the Eclipse key-ring.</para> - - <note> - <title>Note:</title> - <para>The Eclipse key-ring file is distinct from key-ring files found in some platforms - such as Mac OS X and many forms of Linux. Thus, sometimes if you access a Guvnor - repository outside the <property>EGT</property>, the key-ring files might become - unsynchronized and you will be unexpectedly prompted for authentication in Eclipse. - This is nuisance, but your usual credentials should apply in this case.</para> - </note> - </section> - - <section id="guvnor_repositories_view"> - <title>Guvnor Repositories View</title> - - <para>The <property>Guvnor Repositories view</property> contains tree structures for Guvnor - repository contents.</para> - - <figure> - <title>Guvnor Repositories View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_repository.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You can perform the following actions under the resources in the - <property>Guvnor Repositories view</property>:</para> - - <itemizedlist> - <listitem> - <para>create a new Guvnor repository connection. How to do this is describe above in the <link linkend="connection_wizard">"Guvnor Connection Wizard"</link> section.</para> - </listitem> - - <listitem> - <para>remove a Guvnor repository connection. Use the Delete button - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/delete_connection_button.png"/> - </imageobject> - </inlinemediaobject> ) in the tool-bar or the <emphasis> - <property>Delete</property></emphasis> option in the context menu to remove a repository connection.</para> - </listitem> - - <listitem> - <para>refresh Guvnor repository resorces. Use the <emphasis> - <property>Refresh</property></emphasis> context menu item to reload a tree content for the selected node.</para> - </listitem> - - <listitem> - <para>make use of "drill-into" functionality. It's represented by a number of tool-bar/context menu items such as <emphasis><property>Go Home</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_home_button.png"/> - </imageobject> - </inlinemediaobject> ), <emphasis><property>Go Back</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_back_button.png"/> - </imageobject> - </inlinemediaobject> ) and <emphasis> - <property>Go Into</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_into_button.png"/> - </imageobject> - </inlinemediaobject> ).</para> - </listitem> - </itemizedlist> - - <para>Drill-down is useful when working with deeply nested tree structures and when you wish to concentrate on only branch of the tree. For example, drilling into the <emphasis> - <property>"defaultPackage"</property></emphasis> node changes the tree view to:</para> - - <figure> - <title>Going Into the <emphasis>"defaultPackage"</emphasis></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_into_defaultPackage.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Clicking on the Go Home button ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_home_button.png"/> - </imageobject> - </inlinemediaobject> ) or selecting <emphasis> - <property>Go Home</property></emphasis> in the context menu returns the tree to the top-level structure shown in the previous picture above. - </para> - - <para>There are a number of operations that can be performed on Guvnor repository files. Selecting a file in -the Guvnor repository causes the Eclipse <property>Properties view</property> to update with details about that file: -</para> - - <figure> - <title>Guvnor Repository Files Properties</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/repository_files_properties.png"/> - </imageobject> - </mediaobject> - </figure> - - <para></para> - </section> - + <para>This chapter will give an overview on all functionality the <property>Guvnor Tools</property> provides.</para> + + <section > + <title>Creating a New Guvnor Connection</title> + <para>As mentioned in the <link linkend="introduction">"Introduction"</link>, the main purpose + of the <property>EGT</property> is to allow development using resources held in a Guvnor + repository. The first task is to make a connection to a Guvnor repository. + This is handled by the <link linkend="connection_wizard">Guvnor Connection + wizard</link>. </para> + </section> + <section id="local_copies"> - <title>Local Copies of Guvnor Files</title> - - <para>As mentioned in the <link linkend="introduction">"Introduction"</link>, the main purpose - of the <property>EGT</property> is to allow development using resources held in a Guvnor - repository. There are two method of getting local copies of Guvnor repository + <title>Getting Local Copies of Guvnor Files</title> + <para>There are two methods of getting local copies of Guvnor repository resources:</para> <orderedlist> <listitem> - <para>Drag-and-drop from the <property>Guvnor Repositories view</property></para> + <para>Drag-and-drop from the <link linkend="guvnor_repositories_view">Guvnor Repositories view</link></para> </listitem> <listitem> - <para>Using the <link linkend="resources_from_guvnor">Import from Guvnor + <para>Using the <link linkend="resources_from_guvnor">Resource from Guvnor wizard</link>, as described further in this document</para> </listitem> </orderedlist> @@ -305,10 +62,10 @@ above you can see the <emphasis> <property>Dummy rule.drl</property></emphasis> file with the decoration in the <property>Resource Navigator</property>. The Guvnor icon decorator is on the top right of the file image, and the Guvnor revision details are appended to the file name. (The presence/location of these can be - changed the <link linkend="resource_decoration_preferences">Guvnor + changed in the <link linkend="resource_decoration_preferences">Guvnor Preferences</link>.)</para> - <para>Here we see that, <emphasis><property>Dummy role.drl</property></emphasis> is associated with a Guvnor repository + <para>Here we see that, <emphasis><property>Dummy rule.drl</property></emphasis> is associated with a Guvnor repository resource and the local copy is based on revision 0, with a <code>02-10-2008, 4:21:53</code> date/time stamp. The file <emphasis><property>Sample.drl</property>,</emphasis> however, is not associated with a Guvnor repository file. Further details about the association can be found in the standard Eclipse @@ -328,9 +85,9 @@ repository, the location within the repository, the version (date/time stamp) and the revision number.</para> </section> - + <section id="actions"> - <title>Actions for Local Guvnor Resources</title> + <title>Managing Guvnor Resources</title> <para>The <property>EGT</property> provides a number of actions (available through the <emphasis><property>Guvnor</property></emphasis> context menu on files) for working with files, both those associated with @@ -477,14 +234,7 @@ <para>If a local change is based on an older revision of a file that is currently in the Guvnor repository (for example, someone else changed the same file), then the <emphasis> <property>Commit</property> - </emphasis> action will<figure> - <title>Add to Guvnor Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"/> - </imageobject> - </mediaobject> - </figure> ask whether you wish to overwrite the current version in the + </emphasis> action will ask whether you wish to overwrite the current version in the Guvnor repository with the local content. When such conflicts occur, however, you should use the Eclipse Guvnor version tools, along with Eclipse standard tools, to determine the differences and merge content based on the current version in the @@ -496,7 +246,7 @@ <para>The <emphasis> <property>Show History</property> - </emphasis> action is enable for one Guvnor repository associated file and causes + </emphasis> action is enabled for one Guvnor repository associated file and causes the <link linkend="guvnor_history_view">Guvnor Resource History view</link> to be populated with revision history for the selected file.</para> </section> @@ -598,130 +348,6 @@ and removes local metadata for the Guvnor repository association.</para> </section> </section> - - <section id="guvnor_history_view"> - <title>Guvnor Resource History View</title> - - <para>The <property>Guvnor Resource History view</property> should details about revision - history for selected files, both local and those in Guvnor repositories. The initial - state of this view is shown on the figure below.</para> - - <figure> - <title>Initial State of the Guvnor Resource History View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The <property>Guvnor Resource History view</property> is populated by <emphasis> - <property>Show History</property> - </emphasis> actions in either the local <emphasis> - <property>Guvnor</property></emphasis> context menu or in the context menu for - a Guvnor repository file in the <link linkend="guvnor_repositories_view">Guvnor - Repositories view</link>. Once this action is performed, the <property>Guvnor - Resource History view</property> updates to show the revision history:</para> - - <figure> - <title>IGuvnor Resource History View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Here we see that the file <emphasis> - <property>test.txt</property> - </emphasis> has three revisions. Double clicking on a revision row (or the context menu <emphasis> - <property>Open (Read only)</property>)</emphasis> opens an Eclipse read-only editor - with the revision contents.</para> - - <figure> - <title>Eclipse Read-only Editor with the Revision Contents</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view3.png"/> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - <para>You can also use the <emphasis> - <property>Save As...</property> - </emphasis> option when a file is open in a read-only editor to save a local - writable copy of the contents. Doing so, however, will not associate the file - created with its Guvnor source.</para> - </note> - - </section> - - <section id="resources_from_guvnor"> - <title>Importing Guvnor Repository Resources</title> - - <para>In addition to the single file drag-and-drop from the <property>Guvnor Repositories - view</property>, the <property>EGT</property> also includes a wizard for copying one - or more files from a Guvnor repository to the local workspace (and setting the - association with the Guvnor repository). This wizard is available from the <emphasis> - <property>File > Import > Guvnor > Resource from - Guvnor</property> - </emphasis> and the <emphasis> - <property>File > New > Other > Guvnor > Resource from - Guvnor</property> - </emphasis> menu items.</para> - <note> - <title>Note:</title> - - <para>Note that the wizard is identical but appears in both locations to accommodate - users who tend to view this functionality as being in either category.</para> - </note> - - <para>The first page of the wizard asks for the selection of the source Guvnor repository - and gives the choice to create a new Guvnor repository connection (in which case the - second page is the same as the <link linkend="guvnor_connection_wizard">Guvnor Connection wizard</link>).</para> - - <figure> - <title>Resource from Guvnor Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para> - - <figure> - <title>Resource Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Finally, the target location in the local workspace should be chosen:</para> - <figure> - <title>Choosing the Target Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On completion the wizard copies the selected files from the Guvnor repository to the local workspace. - If a file with the same name already exists in the destination, the wizard uses the Eclipse standard - "prompt for rename" dialog:</para> - - <figure> - <title>Prompt for Rename Dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"/> - </imageobject> - </mediaobject> - </figure> - </section> + + </chapter> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -8,83 +8,461 @@ </keywordset> </chapterinfo> - <title>Guvnor Preferences</title> - - <para>The <property>EGT</property> provides a preference page in the <emphasis> - <property>Guvnor</property> - </emphasis> category:</para> - - <figure> - <title>Resource Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The preferences cover two categories:</para> - <itemizedlist> - <listitem><para>Guvnor repository connections</para></listitem> - - <listitem><para>Local Guvnor - repository resource decorations.</para></listitem> - </itemizedlist> - - <section id="repo_connection_preferences"> - <title>Guvnor Repository Connection Preferences</title> - <para>There are two preferences that can be set for Guvnor repository connections, that are - used when creating new connections:</para> - + <title>Reference</title> + <para>This chapter includes detailed reference information about Views and Wizards used to manage Guvnor Tools.</para> + + <section id="guvnor_perspective"> + <title>Guvnor Repository Exploring Perspective</title> + + <para>The <property>Guvnor Repository Exploring perspective</property> contains two views + supplied by <property>EGT</property> – <link linkend="guvnor_repositories_view">Guvnor Repositories view</link> and + <link linkend="guvnor_history_view">Guvnor Resource History view</link>, that will be the center of most interactions + with Guvnor, and Eclipse standard views such as <property>Properties</property> and + <property>Resource Navigator</property> that are also useful.</para> + + <para>While each of these views can be opened and positioned independently within an Eclipse + workbench, the <property>Guvnor perspective</property> provides a convenient method of + getting a suggested layout. In the Eclipse workbench menu, choose <emphasis> + <property>Window > Open Perspective > Other</property> + </emphasis> to get the perspective list:</para> + + <figure> + <title>Enabling the Guvnor Repository Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>And then choose <emphasis> + <property>Guvnor Repository Exploring</property>.</emphasis> This opens the + <property>Guvnor perspective</property>.</para> + </section> + + <section id="connection_wizard"> + <title>Guvnor Connection Wizard</title> + + <para>This wizard appears in a number of places within the + <property>EGT</property> (as detailed below), but in this section we will cover only + the two most basic entry points.</para> + + <para>The <property>Guvnor Connection wizard</property> can be started in the following + ways:</para> + <itemizedlist> <listitem> - <para>The first is a default Guvnor repository URL template, which can make it - easier to create multiple similar connections by simply changing part of the - field, such as the host name.</para> + <para>using the Eclipse menu <emphasis> + <property>File > New > Other > Guvnor > Guvnor + repository location</property> + </emphasis></para> + + <figure> + <title>New Guvnor Repository Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection1.png"/> + </imageobject> + </mediaobject> + </figure> </listitem> + <listitem> - <para>The second is whether saving of authentication information in the Eclipse - platform key-ring should be enabled by default.</para> + <para>in the <property>Guvnor Repositories view</property> using the drop-down menu</para> + + <figure> + <title>Adding New Guvnor Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"/> + </imageobject> + </mediaobject> + </figure> </listitem> + + <listitem> + <para>using the menu button + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_connection_button.png"/> + </imageobject> + </inlinemediaobject> ) + </para> + </listitem> </itemizedlist> - - <para>As with the Guvnor repository URL template, actually whether to save a specific - instance of authentication information in the Eclipse platform key-ring can be - determined when actually creating the connection. That is, both of these preferences are - simply convenience values set to reasonable defaults.</para> + + <para>Choosing either of these will start the <property>Guvnor Connection + wizard</property>.</para> + + <figure id="guvnor_connection_wizard"> + <title>Guvnor Connection Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_connection_wizard.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Default values appear in the <emphasis> + <property>Location</property>,</emphasis> + <emphasis> + <property>Port</property>,</emphasis> and <emphasis> + <property>Repository</property> + </emphasis> fields (See the <link linkend="guvnor_preferences">“Guvnor Preferences”</link> section below for details about how to + change these default values.) Of course, any of these fields can be edited by typing in + the corresponding text box. Drag-and-drop or paste into the <emphasis> + <property>Location</property> + </emphasis> field of a typical Guvnor repository URL such as:</para> + + <para> + <emphasis> + <property>http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</property> + </emphasis> + </para> + + <para>Results in the URL being parsed into the respective fields as well. The authentication + information (user name and password) can optionally be stored in the Eclipse + workbench's key-ring file based on the selection of <emphasis> + <property>Save user name and password</property>.</emphasis></para> + + <note> + <title>Note:</title> + <para>If the authentication information is not stored in the key-ring, then the + <property>EGT</property> uses a session authentication, what means that the + credentials supplied are used only for the lifetime of the Eclipse workbench + instance.</para> + </note> + + <para>If authentication information is not stored in the key-ring or the authentication + information (key-ring or session) is not valid, the <property>EGT</property> will prompt + for authentication information when it has to access the Guvnor repository.</para> + + <para>If authentication fails, the <property>EGT</property> will retry once and then issue + an authentication failure error.</para> + + <tip> + <title>Tip:</title> + <para>If an authentication failure error occurs, you can retry the same operation and + supply different authentication information.</para> + </tip> + + <para>Note that the <property>EGT</property> calls the Guvnor repository at various times, + such as when determining if resource updates are available. Thus if you use session + authentication, the authentication dialog will appear at different times during the + Eclipse workbench session, depending on what actions you take. For ease of use, we + recommend saving the authentication information in the Eclipse key-ring.</para> + + <note> + <title>Note:</title> + <para>The Eclipse key-ring file is distinct from key-ring files found in some platforms + such as Mac OS X and many forms of Linux. Thus, sometimes if you access a Guvnor + repository outside the <property>EGT</property>, the key-ring files might become + unsynchronized and you will be unexpectedly prompted for authentication in Eclipse. + This is nuisance, but your usual credentials should apply in this case.</para> + </note> </section> - - <section id="resource_decoration_preferences"> - <title>Local Guvnor Repository Resource Decoration Preferences</title> - - <para>The second category of preferences provided by the <property>EGT</property> deals with how the decoration of - local resources associated with Guvnor repository resources is presented. Since the - Guvnor repository is not a substitute for a SCM, and since SCM tools in Eclipse tend to - decorate local resources, it is useful to be able to control just how the <property>EGT</property> decorate - its local resources to avoid messy conflicts with SCM packages.</para> + + <section id="resources_from_guvnor"> + <title>Resource from Guvnor Wizard</title> + + <para>In addition to the single file drag-and-drop from the <property>Guvnor Repositories + view</property>, the <property>EGT</property> also includes a wizard for copying one + or more files from a Guvnor repository to the local workspace (and setting the + association with the Guvnor repository). This wizard is available from the <emphasis> + <property>File > Import > Guvnor > Resource from + Guvnor</property> + </emphasis> and the <emphasis> + <property>File > New > Other > Guvnor > Resource from + Guvnor</property> + </emphasis> menu items.</para> + <note> + <title>Note:</title> - <para>In the <emphasis> - <property>File Decoration</property></emphasis> - section of the preference page, you can choose the location (Top right, Top left, Bottom right, - Bottom left) of the decoration icon, or you can choose not to display it. In - the <emphasis> - <property>Text</property></emphasis> section, you can format the Guvnor metadata that is appended to the file - names:</para> + <para>Note that the wizard is identical but appears in both locations to accommodate + users who tend to view this functionality as being in either category.</para> + </note> + + <para>The first page of the wizard asks for the selection of the source Guvnor repository + and gives the choice to create a new Guvnor repository connection (in which case the + second page is the same as the <link linkend="guvnor_connection_wizard">Guvnor Connection wizard</link>).</para> + + <figure> + <title>Resource from Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para> + + <figure> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Finally, the target location in the local workspace should be chosen:</para> + <figure> + <title>Choosing the Target Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On completion the wizard copies the selected files from the Guvnor repository to the local workspace. + If a file with the same name already exists in the destination, the wizard uses the Eclipse standard + "prompt for rename" dialog:</para> + + <figure> + <title>Prompt for Rename Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="guvnor_repositories_view"> + <title>Guvnor Repositories View</title> + + <para>The <property>Guvnor Repositories view</property> contains tree structures for Guvnor + repository contents.</para> + + <figure> + <title>Guvnor Repositories View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_repository.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can perform the following actions under the resources in the + <property>Guvnor Repositories view</property>:</para> + <itemizedlist> <listitem> - <para>Whether to show an indicator (>) when the local file has changes not committed back to the - Guvnor repository</para> + <para>create a new Guvnor repository connection. How to do this is describe above in the <link linkend="connection_wizard">"Guvnor Connection Wizard"</link> section.</para> </listitem> + <listitem> - <para>Whether to show the revision number</para> + <para>remove a Guvnor repository connection. Use the Delete button + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/delete_connection_button.png"/> + </imageobject> + </inlinemediaobject> ) in the tool-bar or the <emphasis> + <property>Delete</property></emphasis> option in the context menu to remove a repository connection.</para> </listitem> + <listitem> - <para>Whether to show the date/time stamp</para> - </listitem> - </itemizedlist> - - <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> - <property>Apply</property></emphasis> and then <emphasis> - <property>Ok</property></emphasis> buttons.</para> + <para>refresh Guvnor repository resorces. Use the <emphasis> + <property>Refresh</property></emphasis> context menu item to reload a tree content for the selected node.</para> + </listitem> + + <listitem> + <para>make use of "drill-into" functionality. It's represented by a number of tool-bar/context menu items such as <emphasis><property>Go Home</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_home_button.png"/> + </imageobject> + </inlinemediaobject> ), <emphasis><property>Go Back</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_back_button.png"/> + </imageobject> + </inlinemediaobject> ) and <emphasis> + <property>Go Into</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_into_button.png"/> + </imageobject> + </inlinemediaobject> ).</para> + </listitem> + </itemizedlist> + + <para>Drill-down is useful when working with deeply nested tree structures and when you wish to concentrate on only branch of the tree. For example, drilling into the <emphasis> + <property>"defaultPackage"</property></emphasis> node changes the tree view to:</para> + + <figure> + <title>Going Into the <emphasis>"defaultPackage"</emphasis></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_into_defaultPackage.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Clicking on the Go Home button ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_home_button.png"/> + </imageobject> + </inlinemediaobject> ) or selecting <emphasis> + <property>Go Home</property></emphasis> in the context menu returns the tree to the top-level structure shown in the previous picture above. + </para> + + <para>There are a number of operations that can be performed on Guvnor repository files. Selecting a file in + the Guvnor repository causes the Eclipse <property>Properties view</property> to update with details about that file: + </para> + + <figure> + <title>Guvnor Repository Files Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/repository_files_properties.png"/> + </imageobject> + </mediaobject> + </figure> + + <para></para> </section> + + <section id="guvnor_history_view"> + <title>Guvnor Resource History View</title> + + <para>The <property>Guvnor Resource History view</property> should details about revision + history for selected files, both local and those in Guvnor repositories. The initial + state of this view is shown on the figure below.</para> + + <figure> + <title>Initial State of the Guvnor Resource History View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Guvnor Resource History view</property> is populated by <emphasis> + <property>Show History</property> + </emphasis> actions in either the local <emphasis> + <property>Guvnor</property></emphasis> context menu or in the context menu for + a Guvnor repository file in the <link linkend="guvnor_repositories_view">Guvnor + Repositories view</link>. Once this action is performed, the <property>Guvnor + Resource History view</property> updates to show the revision history:</para> + + <figure> + <title>Guvnor Resource History View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Here we see that the file <emphasis> + <property>test.txt</property> + </emphasis> has seven revisions. Double clicking on a revision row (or the context menu <emphasis> + <property>Open (Read only)</property>)</emphasis> opens an Eclipse read-only editor + with the revision contents.</para> + + <figure> + <title>Eclipse Read-only Editor with the Revision Contents</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view3.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>You can also use the <emphasis> + <property>Save As...</property> + </emphasis> option when a file is open in a read-only editor to save a local + writable copy of the contents. Doing so, however, will not associate the file + created with its Guvnor source.</para> + </note> + + </section> + + <section id="preferences"> + <title>Guvnor Preferences</title> + + + <para>The <property>EGT</property> provides a preference page in the <emphasis> + <property>Guvnor</property> + </emphasis> category:</para> + + <figure> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The preferences cover two categories:</para> + <itemizedlist> + <listitem><para>Guvnor repository connections</para></listitem> + + <listitem><para>Local Guvnor + repository resource decorations.</para></listitem> + </itemizedlist> + + <section id="repo_connection_preferences"> + <title>Guvnor Repository Connection Preferences</title> + <para>There are two preferences that can be set for Guvnor repository connections, that are + used when creating new connections:</para> + + <itemizedlist> + <listitem> + <para>The first is a default Guvnor repository URL template, which can make it + easier to create multiple similar connections by simply changing part of the + field, such as the host name.</para> + </listitem> + <listitem> + <para>The second is whether saving of authentication information in the Eclipse + platform key-ring should be enabled by default.</para> + </listitem> + </itemizedlist> + + <para>As with the Guvnor repository URL template, actually whether to save a specific + instance of authentication information in the Eclipse platform key-ring can be + determined when actually creating the connection. That is, both of these preferences are + simply convenience values set to reasonable defaults.</para> + </section> + + <section id="resource_decoration_preferences"> + <title>Local Guvnor Repository Resource Decoration Preferences</title> + + <para>The second category of preferences provided by the <property>EGT</property> deals with how the decoration of + local resources associated with Guvnor repository resources is presented. Since the + Guvnor repository is not a substitute for a SCM, and since SCM tools in Eclipse tend to + decorate local resources, it is useful to be able to control just how the <property>EGT</property> decorate + its local resources to avoid messy conflicts with SCM packages.</para> + + <para>In the <emphasis> + <property>File Decoration</property></emphasis> + section of the preference page, you can choose the location (Top right, Top left, Bottom right, + Bottom left) of the decoration icon, or you can choose not to display it. In + the <emphasis> + <property>Text</property></emphasis> section, you can format the Guvnor metadata that is appended to the file + names:</para> + <itemizedlist> + <listitem> + <para>Whether to show an indicator (>) when the local file has changes not committed back to the + Guvnor repository</para> + </listitem> + <listitem> + <para>Whether to show the revision number</para> + </listitem> + <listitem> + <para>Whether to show the date/time stamp</para> + </listitem> + </itemizedlist> + + <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> + <property>Apply</property></emphasis> and then <emphasis> + <property>Ok</property></emphasis> buttons.</para> + </section> + </section> </chapter> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/introduction.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/introduction.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/introduction.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -8,15 +8,7 @@ comprehensive reference, there should be enough detail included for early adopters using these tools.</para> - <para>The <property>Guvnor repository</property> is not intended as a Source Code Management - (SCM) solution, and the <property>EGT</property> are not intended to be Eclipse “team - provider” extensions or replacements. Rather, the Guvnor repository is a location where - certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by - policies defined by the deployment environment. The purpose of the <property>EGT</property> - is then to enable access to resources held by the Guvnor repository, so - they can be used in development. Thus, limited capabilities for reading, writing, adding, - and removing Guvnor repository resources are provided in the - <property>EGT</property>.</para> + <para>First, have a look at the key features of <property>Guvnor Tools:</property></para> <section id="drools_key_features"> <title>Guvnor Tools Key Features</title> @@ -82,15 +74,14 @@ <row> <entry> - <para>Resources from Guvnor Wizard</para> + <para>Resource from Guvnor wizard</para> </entry> <entry> <para>The wizard helps to get local copies of Guvnor repository resources.</para> </entry> <entry> - <link linkend="resources_from_guvnor">Importing Guvnor Repository - Resources</link> + <link linkend="resources_from_guvnor">Resource from Guvnor wizard</link> </entry> </row> @@ -106,7 +97,7 @@ and those not associated.</para> </entry> <entry> - <link linkend="actions">Actions for Local Guvnor Resources</link> + <link linkend="actions">Managing Guvnor Resources</link> </entry> </row> @@ -114,12 +105,23 @@ </tgroup> </table> </section> - + <section id="what_is_guvnor_tools"> + <title>What is Guvnor Tools?</title> + <para>The <property>Guvnor repository</property> is not intended as a Source Code Management + (SCM) solution, and the <property>EGT</property> is not intended to be Eclipse “team + provider” extension or replacement. Rather, the Guvnor repository is a location where + certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by + policies defined by the deployment environment. The purpose of the <property>EGT</property> + is then to enable access to resources held by the Guvnor repository, so + they can be used in development. Thus, limited capabilities for reading, writing, adding, + and removing Guvnor repository resources are provided in the + <property>EGT</property>.</para> + </section> <section id="how_to_start"> - <title>How to start with Guvnor Tools</title> + <title>Requirements and Installation</title> <para><property>Guvnor Tools</property> is a part of the <property>JBoss Tools</property> - project. Thus to get started with <property>Guvnor Tools</property>, you should have the following:</para> + project. Thus to get started with Guvnor Tools, you should have the following:</para> <itemizedlist> <listitem> @@ -128,50 +130,38 @@ </listitem> <listitem> - <para>JBoss Server 4.2 or higher with Guvnor repository deployed. Thus, you should - download <ulink - url="http://download.jboss.org/drools/release/5.0.0.25561.CR1/drools-5.0.0.CR1..." - >Guvnor CR1</ulink> and extract it to the deploy directory of the - server.</para> + <para>JBoss Server 4.2 or higher with Guvnor repository deployed.</para> </listitem> </itemizedlist> - - <para>Now refer to the <link linkend="functionality_overview">"Functionality - Overview"</link> section to find out what you can do with Guvnor and - Eclipse synchronisation tool.</para> - </section> - - <section> - <title>Other relevant resources on the topic</title> - - <itemizedlist> + <para>To have JBoss Server with Guvnor repository deployed, you should + download <ulink url="http://www.jboss.org/drools/downloads.html">Drools Guvnor</ulink>. + When downloading you may choose either web based Guvnor to deploy to your + JBoss Server or Standalone Guvnor with JBoss AS.</para> + <para>If you use a JBoss AS 5 and a <property>Guvnor Tools</property> doesn't work when deployed to the server, + you should do the following to get Guvnor Tools running:</para> + <orderedlist> <listitem> - <para>Guvnor <ulink url="http://www.jboss.org/community/wiki/Guvnor">wiki page</ulink></para> + <para>Remove the JBoss Security libraries (authorization-spi-2.0.2.CR6.jar, + identity-*, acl-spi-2.0.2.CR6.jar) from drools WAR file (not the app server itself). + The JBoss Security libraries are provided in AS 5.</para> </listitem> - <listitem> - <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink></para> + <para>Remove the JAXP libraries (xercesImpl-2.8.0.jar, xml-apis-2.*)</para> </listitem> - <listitem> - <para> - <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> - </para> + <para>Remove the EL libraries (el-*)</para> </listitem> - - <listitem> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest - JBossTools/JBDS documentation builds</ulink> - </para> - </listitem> - - <listitem> - <para> - <ulink url="http://docs.jboss.org/tools/">JBossTools/JBDS - release documentation</ulink></para> - </listitem> - </itemizedlist> - + </orderedlist> + <para>After this, Guvnor should operate as normal. + During deployment, you would see the following exception in the log which indicates that the experiemental + JBoss Security based ACL integration has defined some EJB3/JPA stuff in guvnor that has not been configured.</para> + <programlisting>ERROR [AbstractKernelController] Error installing to Start: name=persistence.unit:unitName=#ACL state=Create +java.lang.RuntimeException: Specification violation [EJB3 JPA 6.2.1.2] - You have not defined a non-jta-data-source +for a RESOURCE_LOCAL enabled persistence context named: ACL + </programlisting> + <para>Now refer to the <link linkend="functionality_overview">"Tasks"</link> + section to find out what you can do with Guvnor and + Eclipse synchronisation tool.</para> </section> + </chapter> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -2,7 +2,7 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY introduction SYSTEM "introduction.xml"> +[ <!ENTITY introduction SYSTEM "introduction.xml"> <!ENTITY functionality_overview SYSTEM "functionality_overview.xml"> <!ENTITY guvnor_preferences SYSTEM "guvnor_preferences.xml"> <!ENTITY conclusion SYSTEM "conclusion.xml"> @@ -40,7 +40,7 @@ <author><firstname>Olga</firstname><surname>Chikvina</surname></author> <copyright> - <year>2009</year> + <year>2009</year> <year>2010</year> <holder>JBoss by Red Hat</holder> </copyright> @@ -61,6 +61,5 @@ &introduction; &functionality_overview; &guvnor_preferences; - &conclusion; - + &conclusion; </book> Modified: tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master_output.xml 2010-06-08 23:23:11 UTC (rev 22645) +++ tags/jbosstools-3.1.1.GA/drools/docs/guvnor_ref/en-US/master_output.xml 2010-06-08 23:27:46 UTC (rev 22646) @@ -2,10 +2,10 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.docbook.org/xml/4.3/docbookx.dtd" -[<!ENTITY introduction SYSTEM "modules/introduction.xml"> -<!ENTITY functionality_overview SYSTEM "modules/functionality_overview.xml"> -<!ENTITY guvnor_preferences SYSTEM "modules/guvnor_preferences.xml"> -<!ENTITY conclusion SYSTEM "modules/conclusion.xml"> +[ <!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY functionality_overview SYSTEM "functionality_overview.xml"> +<!ENTITY guvnor_preferences SYSTEM "guvnor_preferences.xml"> +<!ENTITY conclusion SYSTEM "conclusion.xml"> <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> @@ -58,7 +58,7 @@ <toc></toc> -<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/introduction.xml" xreflabel="introduction"> +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en-US/introduction.xml" xreflabel="introduction"> <title>Introduction</title> <para>The purpose of this document is to describe briefly the functionality present in the @@ -66,15 +66,7 @@ comprehensive reference, there should be enough detail included for early adopters using these tools.</para> - <para>The <property moreinfo="none">Guvnor repository</property> is not intended as a Source Code Management - (SCM) solution, and the <property moreinfo="none">EGT</property> are not intended to be Eclipse “team - provider” extensions or replacements. Rather, the Guvnor repository is a location where - certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by - policies defined by the deployment environment. The purpose of the <property moreinfo="none">EGT</property> - is then to enable access to resources held by the Guvnor repository, so - they can be used in development. Thus, limited capabilities for reading, writing, adding, - and removing Guvnor repository resources are provided in the - <property moreinfo="none">EGT</property>.</para> + <para><diffmk:wrapper diffmk:change="added">First, have a look at the key features of </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Guvnor Tools:</diffmk:wrapper></property></para> <section id="drools_key_features"> <title>Guvnor Tools Key Features</title> @@ -140,15 +132,14 @@ <row> <entry> - <para>Resources from Guvnor Wizard</para> + <para><diffmk:wrapper diffmk:change="changed">Resource from Guvnor wizard</diffmk:wrapper></para> </entry> <entry> <para>The wizard helps to get local copies of Guvnor repository resources.</para> </entry> <entry> - <link linkend="resources_from_guvnor">Importing Guvnor Repository - Resources</link> + <link linkend="resources_from_guvnor"><diffmk:wrapper diffmk:change="changed">Resource from Guvnor wizard</diffmk:wrapper></link> </entry> </row> @@ -164,7 +155,7 @@ and those not associated.</para> </entry> <entry> - <link linkend="actions">Actions for Local Guvnor Resources</link> + <link linkend="actions"><diffmk:wrapper diffmk:change="changed">Managing Guvnor Resources</diffmk:wrapper></link> </entry> </row> @@ -172,69 +163,69 @@ </tgroup> </table> </section> - + <section diffmk:change="added" id="what_is_guvnor_tools"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">What is Guvnor Tools?</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor repository</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is not intended as a Source Code Management + (SCM) solution, and the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is not intended to be Eclipse “team + provider” extension or replacement. Rather, the Guvnor repository is a location where + certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by + policies defined by the deployment environment. The purpose of the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> + is then to enable access to resources held by the Guvnor repository, so + they can be used in development. Thus, limited capabilities for reading, writing, adding, + and removing Guvnor repository resources are provided in the + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </section> <section id="how_to_start"> - <title>How to start with Guvnor Tools</title> + <title><diffmk:wrapper diffmk:change="changed">Requirements and Installation</diffmk:wrapper></title> - <para><property moreinfo="none">Guvnor Tools</property> is a part of the <property moreinfo="none">JBoss Tools</property> - project. Thus to get started with <property moreinfo="none">Guvnor Tools</property>, you should have the following:</para> + <para><property moreinfo="none">Guvnor Tools</property> is a part of the <property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="added"> + project. Thus to get started with Guvnor Tools, you should have the following:</diffmk:wrapper></para> <itemizedlist> <listitem> <para>Eclipse 3.4.x with Jboss Tools bundle of Eclipse plugins installed. How to - install JBoss Tools onto Eclipse you can find in the <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">"JBoss Tools - Installation"</ulink> section.</para> + install JBoss Tools onto Eclipse you can find in the JBoss Tools Installation section.</para> </listitem> <listitem> - <para>JBoss Server 4.2 or higher with Guvnor repository deployed. Thus, you should - download <ulink url="http://download.jboss.org/drools/release/5.0.0.25561.CR1/drools-5.0.0.CR1...">Guvnor CR1</ulink> and extract it to the deploy directory of the - server.</para> + <para><diffmk:wrapper diffmk:change="added">JBoss Server 4.2 or higher with Guvnor repository deployed.</diffmk:wrapper></para> </listitem> </itemizedlist> - - <para>Now refer to the <link linkend="functionality_overview">"Functionality - Overview"</link> section to find out what you can do with Guvnor and - Eclipse synchronisation tool.</para> - </section> - - <section> - <title>Other relevant resources on the topic</title> - - <itemizedlist> + <para><diffmk:wrapper diffmk:change="added">To have JBoss Server with Guvnor repository deployed, you should + download </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/drools/downloads.html"><diffmk:wrapper diffmk:change="added">Drools Guvnor</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. + When downloading you may choose either web based Guvnor to deploy to your + JBoss Server or Standalone Guvnor with JBoss AS.</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="added">If you use a JBoss AS 5 and a </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> doesn't work when deployed to the server, + you should do the following to get Guvnor Tools running:</diffmk:wrapper></para> + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> <listitem> - <para>Guvnor <ulink url="http://www.jboss.org/community/wiki/Guvnor">wiki page</ulink></para> + <para><diffmk:wrapper diffmk:change="added">Remove the JBoss Security libraries (authorization-spi-2.0.2.CR6.jar, + identity-*, acl-spi-2.0.2.CR6.jar) from drools WAR file (not the app server itself). + The JBoss Security libraries are provided in AS 5.</diffmk:wrapper></para> </listitem> - <listitem> - <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink></para> + <para><diffmk:wrapper diffmk:change="added">Remove the JAXP libraries (xercesImpl-2.8.0.jar, xml-apis-2.*)</diffmk:wrapper></para> </listitem> - <listitem> - <para> - <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> - </para> + <para><diffmk:wrapper diffmk:change="added">Remove the EL libraries (el-*)</diffmk:wrapper></para> </listitem> + </orderedlist> + <para><diffmk:wrapper diffmk:change="added">After this, Guvnor should operate as normal. + During deployment, you would see the following exception in the log which indicates that the experiemental + JBoss Security based ACL integration has defined some EJB3/JPA stuff in guvnor that has not been configured.</diffmk:wrapper></para> + <programlisting diffmk:change="added" format="linespecific"><diffmk:wrapper diffmk:change="added">ERROR [AbstractKernelController] Error installing to Start: name=persistence.unit:unitName=#ACL state=Create +java.lang.RuntimeException: Specification violation [EJB3 JPA 6.2.1.2] - You have not defined a non-jta-data-source +for a RESOURCE_LOCAL enabled persistence context named: ACL + </diffmk:wrapper></programlisting> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now refer to the </diffmk:wrapper><link diffmk:change="added" linkend="functionality_overview"><diffmk:wrapper diffmk:change="added">"Tasks"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> + section to find out what you can do with Guvnor and + Eclipse synchronisation tool.</diffmk:wrapper></para> + </section> - <listitem> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest - JBossTools/JBDS documentation builds</ulink> - </para> - </listitem> - - <listitem> - <para> - <ulink url="http://docs.jboss.org/tools/">JBossTools/JBDS - release documentation</ulink></para> - </listitem> - </itemizedlist> - - </section> </chapter> -<chapter id="functionality_overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/functionality_overview.xml" xreflabel="functionality_overview"> +<chapter id="functionality_overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en-US/functionality_overview.xml" xreflabel="functionality_overview"> <?dbhtml filename="functionality_overview.html"?> <chapterinfo> <keywordset> @@ -243,274 +234,31 @@ </keywordset> </chapterinfo> - <title>Functionality Overview</title> + <title><diffmk:wrapper diffmk:change="changed">Tasks</diffmk:wrapper></title> - <para>This chapter will introduce you to the <property moreinfo="none">Guvnor Repository Exploring - perspective</property> and give an overview on all functionality the <property moreinfo="none">Guvnor Tools</property> provides.</para> - - <section id="guvnor_perspective"> - <title>Guvnor Perspective</title> - - <para>The <property moreinfo="none">Guvnor Repository Exploring perspective</property> contains two views - supplied by <property moreinfo="none">EGT</property> – <property moreinfo="none">Repository Explorer</property> and - <property moreinfo="none">Version History</property>, that will be the center of most interaction - with Guvnor, and Eclipse standard views such as <property moreinfo="none">Properties</property> and - <property moreinfo="none">Resource Navigator</property> that are also useful.</para> - - <para>While each of these views can be opened and positioned independently within an Eclipse - workbench, the <property moreinfo="none">Guvnor perspective</property> provides a convenient method of - getting a suggested layout. In the Eclipse workbench menu, choose <emphasis> - <property moreinfo="none">Window > Open Perspective > Other</property> - </emphasis> to get the perspective list:</para> - - <figure float="0"> - <title>Enabling the Guvnor Repository Perspective</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>And then choose <emphasis> - <property moreinfo="none">Guvnor Repository Exploring</property>.</emphasis> This opens the - <property moreinfo="none">Guvnor perspective</property>.</para> - </section> - - <section id="connection_wizard"> - <title>Guvnor Connection Wizard</title> - - <para>After opening the <property moreinfo="none">Guvnor perspective</property>, the first task is to make a - connection to a Guvnor repository. This is handled by the <property moreinfo="none">Guvnor Connection - wizard</property>. This wizard appears in a number of places within the - <property moreinfo="none">EGT</property> (as detailed below), but in this section we will cover only - the two most basic entry points.</para> - - <para>The <property moreinfo="none">Guvnor Connection wizard</property> can be started in the following - ways:</para> - - <itemizedlist> - <listitem> - <para>using the Eclipse menu <emphasis> - <property moreinfo="none">File > New > Other > Guvnor > Guvnor - repository location</property> - </emphasis></para> - - <figure float="0"> - <title>New Guvnor Repository Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/start_guvnor_connection1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>in the <property moreinfo="none">Guvnor Repositories view</property> using the drop-down menu</para> - - <figure float="0"> - <title>Adding New Guvnor Connection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para>using the menu button - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_connection_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ) - </para> - </listitem> - </itemizedlist> - - <para>Choosing either of these will start the <property moreinfo="none">Guvnor Connection - wizard</property>.</para> - - <figure float="0" id="guvnor_connection_wizard"> - <title>Guvnor Connection Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_connection_wizard.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Default values appear in the <emphasis> - <property moreinfo="none">Location</property>,</emphasis> - <emphasis> - <property moreinfo="none">Port</property>,</emphasis> and <emphasis> - <property moreinfo="none">Repository</property> - </emphasis> fields (See the <link linkend="guvnor_preferences">“Guvnor Preferences”</link> section below for details about how to - change these default values.) Of course, any of these fields can be edited by typing in - the corresponding text box. Drag-and-drop or paste into the <emphasis> - <property moreinfo="none">Location</property> - </emphasis> field of a typical Guvnor repository URL such as:</para> - - <para> - <emphasis> - <property moreinfo="none">http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</property> - </emphasis> - </para> - - <para>Results in the URL being parsed into the respective fields as well. The authentication - information (user name and password) can optionally be stored in the Eclipse - workbench's key-ring file based on the selection of <emphasis> - <property moreinfo="none">Save user name and password</property>.</emphasis></para> - - <note> - <title>Note:</title> - <para>If the authentication information is not stored in the key-ring, then the - <property moreinfo="none">EGT</property> uses a session authentication, what means that the - credentials supplied are used only for the lifetime of the Eclipse workbench - instance.</para> - </note> - - <para>If authentication information is not stored in the key-ring or the authentication - information (key-ring or session) is not valid, the <property moreinfo="none">EGT</property> will prompt - for authentication information when it has to access the Guvnor repository.</para> - - <para>If authentication fails, the <property moreinfo="none">EGT</property> will retry once and then issue - an authentication failure error.</para> - - <tip> - <title>Tip:</title> - <para>If an authentication failure error occurs, you can retry the same operation and - supply different authentication information.</para> - </tip> - - <para>Note that the <property moreinfo="none">EGT</property> calls the Guvnor repository at various times, - such as when determining if resource updates are available. Thus if you use session - authentication, the authentication dialog will appear at different times during the - Eclipse workbench session, depending on what actions you take. For ease of use, we - recommend saving the authentication information in the Eclipse key-ring.</para> - - <note> - <title>Note:</title> - <para>The Eclipse key-ring file is distinct from key-ring files found in some platforms - such as Mac OS X and many forms of Linux. Thus, sometimes if you access a Guvnor - repository outside the <property moreinfo="none">EGT</property>, the key-ring files might become - unsynchronized and you will be unexpectedly prompted for authentication in Eclipse. - This is nuisance, but your usual credentials should apply in this case.</para> - </note> - </section> - - <section id="guvnor_repositories_view"> - <title>Guvnor Repositories View</title> - - <para>The <property moreinfo="none">Guvnor Repositories view</property> contains tree structures for Guvnor - repository contents.</para> - - <figure float="0"> - <title>Guvnor Repositories View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/guvnor_repository.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>You can perform the following actions under the resources in the - <property moreinfo="none">Guvnor Repositories view</property>:</para> - - <itemizedlist> - <listitem> - <para>create a new Guvnor repository connection. How to do this is describe above in the <link linkend="connection_wizard">"Guvnor Connection Wizard"</link> section.</para> - </listitem> - - <listitem> - <para>remove a Guvnor repository connection. Use the Delete button - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/delete_connection_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ) in the tool-bar or the <emphasis> - <property moreinfo="none">Delete</property></emphasis> option in the context menu to remove a repository connection.</para> - </listitem> - - <listitem> - <para>refresh Guvnor repository resorces. Use the <emphasis> - <property moreinfo="none">Refresh</property></emphasis> context menu item to reload a tree content for the selected node.</para> - </listitem> - - <listitem> - <para>make use of "drill-into" functionality. It's represented by a number of tool-bar/context menu items such as <emphasis><property moreinfo="none">Go Home</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_home_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ), <emphasis><property moreinfo="none">Go Back</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_back_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ) and <emphasis> - <property moreinfo="none">Go Into</property></emphasis> - ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_into_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ).</para> - </listitem> - </itemizedlist> - - <para>Drill-down is useful when working with deeply nested tree structures and when you wish to concentrate on only branch of the tree. For example, drilling into the <emphasis> - <property moreinfo="none">"defaultPackage"</property></emphasis> node changes the tree view to:</para> - - <figure float="0"> - <title>Going Into the <emphasis>"defaultPackage"</emphasis></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_into_defaultPackage.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Clicking on the Go Home button ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/go_home_button.png"></imagedata> - </imageobject> - </inlinemediaobject> ) or selecting <emphasis> - <property moreinfo="none">Go Home</property></emphasis> in the context menu returns the tree to the top-level structure shown in the previous picture above. - </para> - - <para>There are a number of operations that can be performed on Guvnor repository files. Selecting a file in -the Guvnor repository causes the Eclipse <property moreinfo="none">Properties view</property> to update with details about that file: -</para> - - <figure float="0"> - <title>Guvnor Repository Files Properties</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/repository_files_properties.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para></para> - </section> - + <para><diffmk:wrapper diffmk:change="changed">This chapter will give an overview on all functionality the </diffmk:wrapper><property moreinfo="none">Guvnor Tools</property> provides.</para> + + <section diffmk:change="added"> + <title><diffmk:wrapper diffmk:change="changed">Creating a New Guvnor Connection</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="added">As mentioned in the </diffmk:wrapper><link diffmk:change="added" linkend="introduction"><diffmk:wrapper diffmk:change="added">"Introduction"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">, the main purpose + of the </diffmk:wrapper><property moreinfo="none">EGT</property><diffmk:wrapper diffmk:change="added"> is to allow development using resources held in a Guvnor + repository. The first task is to make a connection to a Guvnor repository. + This is handled by the </diffmk:wrapper><link linkend="connection_wizard"><diffmk:wrapper diffmk:change="changed">Guvnor Connection + wizard</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para> + </section> + <section id="local_copies"> - <title>Local Copies of Guvnor Files</title> + <title><diffmk:wrapper diffmk:change="changed">Getting Local Copies of Guvnor Files</diffmk:wrapper></title> + <para><diffmk:wrapper diffmk:change="added">There are two methods of getting local copies of Guvnor repository + resources:</diffmk:wrapper></para> - <para>As mentioned in the <link linkend="introduction">"Introduction"</link>, the main purpose - of the <property moreinfo="none">EGT</property> is to allow development using resources held in a Guvnor - repository. There are two method of getting local copies of Guvnor repository - resources:</para> - <orderedlist continuation="restarts" inheritnum="ignore"> <listitem> - <para>Drag-and-drop from the <property moreinfo="none">Guvnor Repositories view</property></para> + <para>Drag-and-drop from the <link diffmk:change="added" linkend="guvnor_repositories_view">Guvnor Repositories view</link></para> </listitem> <listitem> - <para>Using the <link linkend="resources_from_guvnor">Import from Guvnor - wizard</link>, as described further in this document</para> + <para>Using the <link linkend="resources_from_guvnor"><diffmk:wrapper diffmk:change="changed">Resource from Guvnor + wizard</diffmk:wrapper></link>, as described further in this document</para> </listitem> </orderedlist> @@ -538,12 +286,12 @@ Eclipse Common Navigator framework, such as the Eclipse <property moreinfo="none">Resource Navigator</property> and the Java <property moreinfo="none">Package Explorer</property>. On the image above you can see the <emphasis> - <property moreinfo="none">Dummy rule.drl</property></emphasis> file with the decoration in the <property moreinfo="none">Resource Navigator</property>. The Guvnor icon decorator is on the top right of the file image, and the Guvnor + <property moreinfo="none">Dummy rule.drl</property></emphasis> file with the decoration in the <property moreinfo="none">Resource Navigator</property><diffmk:wrapper diffmk:change="changed">. The Guvnor icon decorator is on the top right of the file image, and the Guvnor revision details are appended to the file name. (The presence/location of these can be - changed the <link linkend="resource_decoration_preferences">Guvnor + changed in the </diffmk:wrapper><link linkend="resource_decoration_preferences">Guvnor Preferences</link>.)</para> - <para>Here we see that, <emphasis><property moreinfo="none">Dummy role.drl</property></emphasis> is associated with a Guvnor repository + <para>Here we see that, <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Dummy rule.drl</diffmk:wrapper></property></emphasis> is associated with a Guvnor repository resource and the local copy is based on revision 0, with a <code>02-10-2008, 4:21:53</code> date/time stamp. The file <emphasis><property moreinfo="none">Sample.drl</property>,</emphasis> however, is not associated with a Guvnor repository file. Further details about the association can be found in the standard Eclipse @@ -563,9 +311,9 @@ repository, the location within the repository, the version (date/time stamp) and the revision number.</para> </section> - + <section id="actions"> - <title>Actions for Local Guvnor Resources</title> + <title><diffmk:wrapper diffmk:change="changed">Managing Guvnor Resources</diffmk:wrapper></title> <para>The <property moreinfo="none">EGT</property> provides a number of actions (available through the <emphasis><property moreinfo="none">Guvnor</property></emphasis> context menu on files) for working with files, both those associated with @@ -711,18 +459,11 @@ <para>If a local change is based on an older revision of a file that is currently in the Guvnor repository (for example, someone else changed the same file), then the <emphasis> <property moreinfo="none">Commit</property> - </emphasis> action will<figure float="0"> - <title>Add to Guvnor Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"></imagedata> - </imageobject> - </mediaobject> - </figure> ask whether you wish to overwrite the current version in the + </emphasis><diffmk:wrapper diffmk:change="added"> action will ask whether you wish to overwrite the current version in the Guvnor repository with the local content. When such conflicts occur, however, you should use the Eclipse Guvnor version tools, along with Eclipse standard tools, to determine the differences and merge content based on the current version in the - Guvnor repository.</para> + Guvnor repository.</diffmk:wrapper></para> </section> <section id="show_history_action"> @@ -730,8 +471,8 @@ <para>The <emphasis> <property moreinfo="none">Show History</property> - </emphasis> action is enable for one Guvnor repository associated file and causes - the <link linkend="guvnor_history_view">Guvnor Resource History view</link> to be + </emphasis><diffmk:wrapper diffmk:change="changed"> action is enabled for one Guvnor repository associated file and causes + the </diffmk:wrapper><link linkend="guvnor_history_view">Guvnor Resource History view</link> to be populated with revision history for the selected file.</para> </section> @@ -832,70 +573,179 @@ and removes local metadata for the Guvnor repository association.</para> </section> </section> + - <section id="guvnor_history_view"> - <title>Guvnor Resource History View</title> - <para>The <property moreinfo="none">Guvnor Resource History view</property> should details about revision - history for selected files, both local and those in Guvnor repositories. The initial - state of this view is shown on the figure below.</para> + </chapter> +<chapter diffmk:change="added" id="guvnor_preferences" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml" xreflabel="guvnor_preferences"> + <?dbhtml filename="guvnor_preferences.html"?> + <chapterinfo diffmk:change="added"> + <keywordset diffmk:change="added"> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></keyword> + <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse Guvnor Tools</diffmk:wrapper></keyword> + </keywordset> + </chapterinfo> - <figure float="0"> - <title>Initial State of the Guvnor Resource History View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The <property moreinfo="none">Guvnor Resource History view</property> is populated by <emphasis> - <property moreinfo="none">Show History</property> - </emphasis> actions in either the local <emphasis> - <property moreinfo="none">Guvnor</property></emphasis> context menu or in the context menu for - a Guvnor repository file in the <link linkend="guvnor_repositories_view">Guvnor - Repositories view</link>. Once this action is performed, the <property moreinfo="none">Guvnor - Resource History view</property> updates to show the revision history:</para> - - <figure float="0"> - <title>IGuvnor Resource History View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Here we see that the file <emphasis> - <property moreinfo="none">test.txt</property> - </emphasis> has three revisions. Double clicking on a revision row (or the context menu <emphasis> - <property moreinfo="none">Open (Read only)</property>)</emphasis> opens an Eclipse read-only editor - with the revision contents.</para> - - <figure float="0"> - <title>Eclipse Read-only Editor with the Revision Contents</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_history_view3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Reference</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This chapter includes detailed reference information about Views and Wizards used to manage Guvnor Tools.</diffmk:wrapper></para> + + <section diffmk:change="added" id="guvnor_perspective"> + <title><diffmk:wrapper diffmk:change="changed">Guvnor Repository Exploring Perspective</diffmk:wrapper></title> + + <para>The <property moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Repository Exploring perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> contains two views + supplied by </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> – </diffmk:wrapper><link diffmk:change="added" linkend="guvnor_repositories_view"><diffmk:wrapper diffmk:change="added">Guvnor Repositories view</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> and + </diffmk:wrapper><link diffmk:change="added" linkend="guvnor_history_view">Guvnor Resource History view</link><diffmk:wrapper diffmk:change="added">, that will be the center of most interactions + with Guvnor, and Eclipse standard views such as </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Resource Navigator</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> that are also useful.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">While each of these views can be opened and positioned independently within an Eclipse + workbench, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> provides a convenient method of + getting a suggested layout. In the Eclipse workbench menu, choose </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window > Open Perspective > Other</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> to get the perspective list:</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Enabling the Guvnor Repository Perspective</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"/> + </imageobject> + </mediaobject> + </figure> + + <para><diffmk:wrapper diffmk:change="added">And then choose </diffmk:wrapper><emphasis diffmk:change="added"> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Guvnor Repository Exploring</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> This opens the + </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </section> + + <section diffmk:change="added" id="connection_wizard"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Connection Wizard</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This wizard appears in a number of places within the + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (as detailed below), but in this section we will cover only + the two most basic entry points.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Connection wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> can be started in the following + ways:</diffmk:wrapper></para> + + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">using the Eclipse menu </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">File > New > Other > Guvnor > Guvnor + repository location</diffmk:wrapper></property> + </emphasis></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">New Guvnor Repository Location</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/start_guvnor_connection1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">in the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Guvnor Repositories view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> using the drop-down menu</diffmk:wrapper></para> + + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Adding New Guvnor Connection</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"/> + + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="added">using the menu button + ( </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/guvnor_connection_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) + </diffmk:wrapper></para> + </listitem> + </itemizedlist> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Choosing either of these will start the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Connection + wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0" id="guvnor_connection_wizard"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Connection Wizard</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/guvnor_connection_wizard.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Default values appear in the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Location</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">,</diffmk:wrapper></emphasis> + <emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="added">Port</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">,</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Repository</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> fields (See the </diffmk:wrapper><link diffmk:change="added" linkend="guvnor_preferences"><diffmk:wrapper diffmk:change="added">“Guvnor Preferences”</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> section below for details about how to + change these default values.) Of course, any of these fields can be edited by typing in + the corresponding text box. Drag-and-drop or paste into the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Location</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> field of a typical Guvnor repository URL such as:</diffmk:wrapper></para> + + <para diffmk:change="added"> + <emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</diffmk:wrapper></property> + </emphasis> + </para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Results in the URL being parsed into the respective fields as well. The authentication + information (user name and password) can optionally be stored in the Eclipse + workbench's key-ring file based on the selection of </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Save user name and password</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para> + + <note diffmk:change="added"> + <title><diffmk:wrapper diffmk:change="changed">Note:</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If the authentication information is not stored in the key-ring, then the + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> uses a session authentication, what means that the + credentials supplied are used only for the lifetime of the Eclipse workbench + instance.</diffmk:wrapper></para> + </note> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If authentication information is not stored in the key-ring or the authentication + information (key-ring or session) is not valid, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> will prompt + for authentication information when it has to access the Guvnor repository.</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If authentication fails, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> will retry once and then issue + an authentication failure error.</diffmk:wrapper></para> + + <tip diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If an authentication failure error occurs, you can retry the same operation and + supply different authentication information.</diffmk:wrapper></para> + </tip> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note that the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> calls the Guvnor repository at various times, + such as when determining if resource updates are available. Thus if you use session + authentication, the authentication dialog will appear at different times during the + Eclipse workbench session, depending on what actions you take. For ease of use, we + recommend saving the authentication information in the Eclipse key-ring.</diffmk:wrapper></para> + <note> <title>Note:</title> - <para>You can also use the <emphasis> - <property moreinfo="none">Save As...</property> - </emphasis> option when a file is open in a read-only editor to save a local - writable copy of the contents. Doing so, however, will not associate the file - created with its Guvnor source.</para> + <para><diffmk:wrapper diffmk:change="added">The Eclipse key-ring file is distinct from key-ring files found in some platforms + such as Mac OS X and many forms of Linux. Thus, sometimes if you access a Guvnor + repository outside the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">EGT</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, the key-ring files might become + unsynchronized and you will be unexpectedly prompted for authentication in Eclipse. + This is nuisance, but your usual credentials should apply in this case.</diffmk:wrapper></para> </note> - </section> - + <section id="resources_from_guvnor"> - <title>Importing Guvnor Repository Resources</title> - - <para>In addition to the single file drag-and-drop from the <property moreinfo="none">Guvnor Repositories - view</property>, the <property moreinfo="none">EGT</property> also includes a wizard for copying one + <title><diffmk:wrapper diffmk:change="changed">Resource from Guvnor Wizard</diffmk:wrapper></title> + + <para>In addition to the single file drag-and-drop from the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Guvnor Repositories + view</diffmk:wrapper></property>, the <property moreinfo="none">EGT</property> also includes a wizard for copying one or more files from a Guvnor repository to the local workspace (and setting the association with the Guvnor repository). This wizard is available from the <emphasis> <property moreinfo="none">File > Import > Guvnor > Resource from @@ -906,153 +756,298 @@ </emphasis> menu items.</para> <note> <title>Note:</title> - + <para>Note that the wizard is identical but appears in both locations to accommodate users who tend to view this functionality as being in either category.</para> </note> - + <para>The first page of the wizard asks for the selection of the source Guvnor repository and gives the choice to create a new Guvnor repository connection (in which case the second page is the same as the <link linkend="guvnor_connection_wizard">Guvnor Connection wizard</link>).</para> - - <figure float="0"> - <title>Resource from Guvnor Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <figure float="0"> + <title>Resource from Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para> - - <figure float="0"> - <title>Resource Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <figure float="0"> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Finally, the target location in the local workspace should be chosen:</para> - <figure float="0"> - <title>Choosing the Target Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + <figure float="0"> + <title>Choosing the Target Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> <para>On completion the wizard copies the selected files from the Guvnor repository to the local workspace. If a file with the same name already exists in the destination, the wizard uses the Eclipse standard "prompt for rename" dialog:</para> - - <figure float="0"> - <title>Prompt for Rename Dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> + + <figure float="0"> + <title>Prompt for Rename Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> </section> -</chapter> - -<chapter id="guvnor_preferences" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/guvnor_preferences.xml" xreflabel="guvnor_preferences"> - <?dbhtml filename="guvnor_preferences.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Eclipse Guvnor Tools</keyword> - </keywordset> - </chapterinfo> - - <title>Guvnor Preferences</title> - - <para>The <property moreinfo="none">EGT</property> provides a preference page in the <emphasis> - <property moreinfo="none">Guvnor</property> - </emphasis> category:</para> - - <figure float="0"> - <title>Resource Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>The preferences cover two categories:</para> - <itemizedlist> - <listitem><para>Guvnor repository connections</para></listitem> + <section diffmk:change="added" id="guvnor_repositories_view"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Repositories View</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Repositories view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> contains tree structures for Guvnor + repository contents.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Repositories View</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/guvnor_repository.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can perform the following actions under the resources in the + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Repositories view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">:</diffmk:wrapper></para> + + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">create a new Guvnor repository connection. How to do this is describe above in the </diffmk:wrapper><link diffmk:change="added" linkend="connection_wizard"><diffmk:wrapper diffmk:change="added">"Guvnor Connection Wizard"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> section.</diffmk:wrapper></para> + </listitem> - <listitem><para>Local Guvnor - repository resource decorations.</para></listitem> - </itemizedlist> - - <section id="repo_connection_preferences"> - <title>Guvnor Repository Connection Preferences</title> - <para>There are two preferences that can be set for Guvnor repository connections, that are - used when creating new connections:</para> - - <itemizedlist> - <listitem> - <para>The first is a default Guvnor repository URL template, which can make it - easier to create multiple similar connections by simply changing part of the - field, such as the host name.</para> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">remove a Guvnor repository connection. Use the Delete button + ( </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/delete_connection_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) in the tool-bar or the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Delete</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> option in the context menu to remove a repository connection.</diffmk:wrapper></para> </listitem> - <listitem> - <para>The second is whether saving of authentication information in the Eclipse - platform key-ring should be enabled by default.</para> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">refresh Guvnor repository resorces. Use the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Refresh</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> context menu item to reload a tree content for the selected node.</diffmk:wrapper></para> </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">make use of "drill-into" functionality. It's represented by a number of tool-bar/context menu items such as </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Go Home</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/functionality_overview/go_home_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ), </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Go Back</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/functionality_overview/go_back_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) and </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Go Into</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/functionality_overview/go_into_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ).</diffmk:wrapper></para> + </listitem> </itemizedlist> - - <para>As with the Guvnor repository URL template, actually whether to save a specific - instance of authentication information in the Eclipse platform key-ring can be - determined when actually creating the connection. That is, both of these preferences are - simply convenience values set to reasonable defaults.</para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Drill-down is useful when working with deeply nested tree structures and when you wish to concentrate on only branch of the tree. For example, drilling into the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">"defaultPackage"</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> node changes the tree view to:</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Going Into the </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">"defaultPackage"</diffmk:wrapper></emphasis></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/go_into_defaultPackage.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Clicking on the Go Home button ( </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/go_home_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) or selecting </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Go Home</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> in the context menu returns the tree to the top-level structure shown in the previous picture above. + </diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">There are a number of operations that can be performed on Guvnor repository files. Selecting a file in + the Guvnor repository causes the Eclipse </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to update with details about that file: + </diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Repository Files Properties</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/repository_files_properties.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"></para> </section> + + <section diffmk:change="added" id="guvnor_history_view"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Resource History View</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Resource History view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> should details about revision + history for selected files, both local and those in Guvnor repositories. The initial + state of this view is shown on the figure below.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Initial State of the Guvnor Resource History View</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/resource_history_view.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor Resource History view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is populated by </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Show History</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> actions in either the local </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> context menu or in the context menu for + a Guvnor repository file in the </diffmk:wrapper><link diffmk:change="added" linkend="guvnor_repositories_view"><diffmk:wrapper diffmk:change="added">Guvnor + Repositories view</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">. Once this action is performed, the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Guvnor + Resource History view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> updates to show the revision history:</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor Resource History View</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/resource_history_view2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Here we see that the file </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">test.txt</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> has seven revisions. Double clicking on a revision row (or the context menu </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Open (Read only)</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">)</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> opens an Eclipse read-only editor + with the revision contents.</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse Read-only Editor with the Revision Contents</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/functionality_overview/resource_history_view3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <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">You can also use the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Save As...</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> option when a file is open in a read-only editor to save a local + writable copy of the contents. Doing so, however, will not associate the file + created with its Guvnor source.</diffmk:wrapper></para> + </note> + + </section> + + <section diffmk:change="added" id="preferences"> + <title>Guvnor Preferences</title> + + + <para>The <property moreinfo="none">EGT</property> provides a preference page in the <emphasis> + <property moreinfo="none">Guvnor</property> + </emphasis> category:</para> + + <figure float="0"> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The preferences cover two categories:</para> + <itemizedlist diffmk:change="added"> + <listitem><para>Guvnor repository connections</para></listitem> + + <listitem><para><diffmk:wrapper diffmk:change="changed">Local Guvnor + repository resource decorations.</diffmk:wrapper></para></listitem> + </itemizedlist> + + <section id="repo_connection_preferences"> + <title>Guvnor Repository Connection Preferences</title> + <para><diffmk:wrapper diffmk:change="changed">There are two preferences that can be set for Guvnor repository connections, that are + used when creating new connections:</diffmk:wrapper></para> + + <itemizedlist> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="changed">The first is a default Guvnor repository URL template, which can make it + easier to create multiple similar connections by simply changing part of the + field, such as the host name.</diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="changed">The second is whether saving of authentication information in the Eclipse + platform key-ring should be enabled by default.</diffmk:wrapper></para> + </listitem> + </itemizedlist> + + <para><diffmk:wrapper diffmk:change="changed">As with the Guvnor repository URL template, actually whether to save a specific + instance of authentication information in the Eclipse platform key-ring can be + determined when actually creating the connection. That is, both of these preferences are + simply convenience values set to reasonable defaults.</diffmk:wrapper></para> + </section> + + <section id="resource_decoration_preferences"> + <title>Local Guvnor Repository Resource Decoration Preferences</title> + + <para>The second category of preferences provided by the <property moreinfo="none">EGT</property><diffmk:wrapper diffmk:change="changed"> deals with how the decoration of + local resources associated with Guvnor repository resources is presented. Since the + Guvnor repository is not a substitute for a SCM, and since SCM tools in Eclipse tend to + decorate local resources, it is useful to be able to control just how the </diffmk:wrapper><property moreinfo="none">EGT</property><diffmk:wrapper diffmk:change="changed"> decorate + its local resources to avoid messy conflicts with SCM packages.</diffmk:wrapper></para> + + <para>In the <emphasis> + <property moreinfo="none">File Decoration</property></emphasis><diffmk:wrapper diffmk:change="changed"> + section of the preference page, you can choose the location (Top right, Top left, Bottom right, + Bottom left) of the decoration icon, or you can choose not to display it. In + the </diffmk:wrapper><emphasis> + <property moreinfo="none">Text</property></emphasis><diffmk:wrapper diffmk:change="changed"> section, you can format the Guvnor metadata that is appended to the file + names:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para><diffmk:wrapper diffmk:change="changed">Whether to show an indicator (>) when the local file has changes not committed back to the + Guvnor repository</diffmk:wrapper></para> + </listitem> + <listitem diffmk:change="added"> + <para>Whether to show the revision number</para> + </listitem> + <listitem diffmk:change="added"> + <para>Whether to show the date/time stamp</para> + </listitem> + </itemizedlist> + + <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> + <property moreinfo="none">Apply</property></emphasis> and then <emphasis> + <property moreinfo="none">Ok</property></emphasis> buttons.</para> + </section> + </section> - <section id="resource_decoration_preferences"> - <title>Local Guvnor Repository Resource Decoration Preferences</title> - <para>The second category of preferences provided by the <property moreinfo="none">EGT</property> deals with how the decoration of - local resources associated with Guvnor repository resources is presented. Since the - Guvnor repository is not a substitute for a SCM, and since SCM tools in Eclipse tend to - decorate local resources, it is useful to be able to control just how the <property moreinfo="none">EGT</property> decorate - its local resources to avoid messy conflicts with SCM packages.</para> - - <para>In the <emphasis> - <property moreinfo="none">File Decoration</property></emphasis> - section of the preference page, you can choose the location (Top right, Top left, Bottom right, - Bottom left) of the decoration icon, or you can choose not to display it. In - the <emphasis> - <property moreinfo="none">Text</property></emphasis> section, you can format the Guvnor metadata that is appended to the file - names:</para> - <itemizedlist> - <listitem> - <para>Whether to show an indicator (>) when the local file has changes not committed back to the - Guvnor repository</para> - </listitem> - <listitem> - <para>Whether to show the revision number</para> - </listitem> - <listitem> - <para>Whether to show the date/time stamp</para> - </listitem> - </itemizedlist> - - <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> - <property moreinfo="none">Apply</property></emphasis> and then <emphasis> - <property moreinfo="none">Ok</property></emphasis> buttons.</para> - </section> -</chapter> - - -<chapter id="conclusion" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/conclusion.xml" xreflabel="conclusion"> + </chapter> +<chapter id="conclusion" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en-US/conclusion.xml" xreflabel="conclusion"> <?dbhtml filename="conclusion.html"?> <chapterinfo> <keywordset> @@ -1061,7 +1056,7 @@ </keywordset> </chapterinfo> - <title>Conclusion</title> + <title><diffmk:wrapper diffmk:change="changed">Summary</diffmk:wrapper></title> <para>As stated at the beginning of this document, the key goal of the <property moreinfo="none">EGT</property> is to provide a way of interacting with Guvnor repository resources in a local Eclipse @@ -1069,9 +1064,40 @@ aspects of the current tooling that require revision going forward, we feel that the current state of the <property moreinfo="none">EGT</property> is sufficient for the major use cases.</para> - <para>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>.</para> + <section diffmk:change="added"> + <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">For more information visit the following resources:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Guvnor </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/community/wiki/Guvnor"><diffmk:wrapper diffmk:change="added">wiki page</diffmk:wrapper></ulink></para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Drools on </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/drools/"><diffmk:wrapper diffmk:change="added">JBoss.org</diffmk:wrapper></ulink></para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"> + <ulink diffmk:change="added" url="http://www.jboss.org/tools/"><diffmk:wrapper diffmk:change="added">JBoss Tools Home Page</diffmk:wrapper></ulink> + </para> + </listitem> + + <listitem diffmk:change="added"> + <para> + <ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs/"><diffmk:wrapper diffmk:change="added">The latest + JBossTools/JBDS documentation builds</diffmk:wrapper></ulink> + </para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"> + <ulink diffmk:change="added" url="http://docs.jboss.org/tools/"><diffmk:wrapper diffmk:change="added">JBossTools/JBDS + release documentation</diffmk:wrapper></ulink></para> + </listitem> + </itemizedlist> + <para>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>.</para> </section> </chapter> - - + </book>

14 years, 7 months

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 June 2010