[jbosstools-commits] JBoss Tools SVN: r11330 - in branches/jbosstools-3.0.0.Beta1: jbpm/docs/reference and 2 other directories.

Author: smukhina Date: 2008-10-30 07:35:01 -0400 (Thu, 30 Oct 2008) New Revision: 11330 Added: branches/jbosstools-3.0.0.Beta1/jbpm/docs/reference/master_output.xml branches/jbosstools-3.0.0.Beta1/ws/docs/reference/en/master_output.xml Modified: branches/jbosstools-3.0.0.Beta1/documentation/jboss-tools-docs/pom.xml branches/jbosstools-3.0.0.Beta1/jbpm/docs/reference/pom.xml branches/jbosstools-3.0.0.Beta1/ws/docs/reference/pom.xml Log: https://jira.jboss.org/jira/browse/JBDS-463 markers for new and updated are added Modified: branches/jbosstools-3.0.0.Beta1/documentation/jboss-tools-docs/pom.xml =================================================================== --- branches/jbosstools-3.0.0.Beta1/documentation/jboss-tools-docs/pom.xml 2008-10-30 11:12:00 UTC (rev 11329) +++ branches/jbosstools-3.0.0.Beta1/documentation/jboss-tools-docs/pom.xml 2008-10-30 11:35:01 UTC (rev 11330) @@ -12,18 +12,18 @@ <modules> <module>../guides/Exadel-migration</module> - <!--module>../guides/GettingStartedGuide</module--> + <module>../guides/GettingStartedGuide</module> <module>../../as/docs/reference</module> <module>../../hibernatetools/docs/reference</module> - <!--module>../../jbpm/docs/reference</module> - <module>../../jsf/docs/userguide</module--> + <module>../../jbpm/docs/reference</module> + <module>../../jsf/docs/userguide</module> <module>../../jsf/docs/jsf_tools_ref_guide</module> <module>../../jsf/docs/jsf_tools_tutorial</module> <module>../../seam/docs/reference</module> <module>../../struts/docs/struts_tools_ref_guide</module> <module>../../struts/docs/struts_tools_tutorial</module> <module>../../esb/docs/esb_ref_guide</module> - <!--module>../../ws/docs/reference</module--> + <module>../../ws/docs/reference</module> <module>../../portlet/docs/reference</module> <module>../../birt/docs</module> Added: branches/jbosstools-3.0.0.Beta1/jbpm/docs/reference/master_output.xml =================================================================== --- branches/jbosstools-3.0.0.Beta1/jbpm/docs/reference/master_output.xml (rev 0) +++ branches/jbosstools-3.0.0.Beta1/jbpm/docs/reference/master_output.xml 2008-10-30 11:35:01 UTC (rev 11330) @@ -0,0 +1,1302 @@ +<?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 "modules/Introduction.xml"> +<!ENTITY jboss_jbpm_runtime_installation SYSTEM "modules/jboss_jbpm_runtime_installation.xml"> +<!ENTITY guided_tour_jboss_jbpmgpd SYSTEM "modules/guided_tour_jboss_jbpmgpd.xml"> +<!ENTITY the_views SYSTEM "modules/the_views.xml"> +<!ENTITY Test_Drive_Proc SYSTEM "modules/Test_Drive_Proc.xml"> +<!ENTITY The_JBoss_jBPM_Int_Mech SYSTEM "modules/The_JBoss_jBPM_Int_Mech.xml"> +<!ENTITY Quick_Howto_Guide SYSTEM "modules/Quick_Howto_Guide.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> + + <author> + <firstname>Anatoly</firstname> + <surname>Fedosik</surname> + </author> + <author> + <firstname>Koen</firstname> + <surname>Aers</surname> + <email&gt;koen.aers(a)jboss.com&lt;/email&gt; + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email&gt;smukhina(a)exadel.com&lt;/email&gt; + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email&gt;tom.baeyens(a)jboss.com&lt;/email&gt; + </author> + + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2008</year> + <holder>JBoss, a division of Red Hat Inc.</holder> + </copyright> + <releaseinfo> Version: <diffmk:wrapper diffmk:change="added">3.0.0.beta1</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">3.0.0.alpha </diffmk:wrapper></releaseinfo> + +<abstract diffmk:change="added"> + <title diffmk:change="added"></title> + <para diffmk:change="added"> + <ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs/en/jbpm/pdf/J... diffmk:change="added">PDF version</diffmk:wrapper></ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + +<chapter id="Introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/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">jBDL support</link> + </entry> + <entry>Enables managing workflow processes as well as human tasks and interactions between + them. jBDL combines the best both Java and declarative process techniques.</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="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>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 documentation you can find <ulink url="http://docs.jboss.org/tools/2.1.0.GA/">here</ulink&g... + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + </section> + +</chapter> + + +<chapter id="jboss_jbpm_runtime_installation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml" xreflabel="jboss_jbpm_runtime_installation"> + <?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> + </keywordset> + </chapterinfo> + <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">JBoss + jBPM</property> (business process management).</para> + <para>The jBPM plugin (jBPM Designer) is already included in the <property moreinfo="none">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&... 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 moreinfo="none">Window &gt; Preferences &gt; JBoss jBPM &gt; Runtime Locations</property>. + </emphasis> Here you can add, edit and remove JBoss jBPM installation locations. Click <emphasis> + <property moreinfo="none">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 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>Now, when you have a runtime installed, we are going to demonstrate some powerful features of + the jBPM.</para> +</chapter> + + +<chapter id="GuidedTourJBossjBPMGPD" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml" xreflabel="GuidedTourJBossjBPMGPD"> + <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>JBoss</keyword> + <keyword>Process</keyword> + <keyword>Definition</keyword> + </keywordset> + </chapterinfo> + <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 moreinfo="none">File &gt;New Project...</property> + </emphasis> and then <emphasis> + <property moreinfo="none">JBoss jBPM &gt; 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> 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 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>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 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>On the next screen you'll be prompted to select the core jBPM location that + we have defined in the previous chapter.</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> results in the project being generated. The wizard creates four source + folders: one for the processes (<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>) and one for the resources such as the jbpm.properties and the + hibernate.properties files (<emphasis> + <property moreinfo="none">src/main/config</property> + </emphasis>). In addition a classpath container with all the core jBPM libraries is + added to the project</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>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 moreinfo="none">New</property> + </emphasis> wizard by clicking the <emphasis> + <property moreinfo="none">File &gt; New &gt; 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 Definion 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>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 moreinfo="none">gpd.xml</property> + </emphasis> and <emphasis> + <property moreinfo="none">processdefinition.xml</property>. </emphasis></para> + <para>The <emphasis> + <property moreinfo="none">gpd.xml</property> + </emphasis> contains the graphical information used by the process definition editor. + The <emphasis> + <property moreinfo="none">processdefinition.xml</property> + </emphasis> file contains the actual process definition info without the graphical + rendering info. At present, the GPD assumes that these two 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 + jPDL 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 moreinfo="none">Start</property>, + </emphasis> + <emphasis> + <property moreinfo="none">State</property> + </emphasis> and <emphasis> + <property moreinfo="none">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 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"> + <?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 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> node and click again to see the transition being drawn. Perform the + same steps to create a transition from the <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>Now, when you've got background knowledge of simple project creation, + let's move to more advanced tools.</para> + </section> + </section> + </section> + +</chapter> + + +<chapter id="the_views" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/the_views.xml" xreflabel="the_views"> + <?dbhtml filename="the_views.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + </keywordset> + </chapterinfo> + + <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 + currant-active file are immediately displayed in them. Let’s get acquainted more closely + with those that the <property moreinfo="none">jPDL perspective</property> provides. </para> + + <figure float="0"> + <title>The jPDL Perspective Views and Editors</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_0.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see in the picture above, the <property moreinfo="none">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 moreinfo="none">Outline view</property> + </emphasis> that is presented as the classical tree. If it is not visible select <emphasis> + <property moreinfo="none">Window &gt; Show view &gt; Outline</property>. </emphasis></para> + + <figure float="0"> + <title>The Overview View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_1.png"></imagedata> + </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 + currant-developing process. Besides, the <emphasis> + <property moreinfo="none">Overview</property> + </emphasis> comes as a scrollable thumbnail which enables a better navigation of the + process structure if it's too large.</para> + + <figure float="0"> + <title>The Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_2.png"></imagedata> + </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 moreinfo="none">Properties view</property>.</para> + <para>Notice if it's not visible you can access it by navigating <emphasis> + <property moreinfo="none">Window &gt; Show view &gt; 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 float="0"> + <title>The Properties View of selected Transition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_3.png"></imagedata> + </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 moreinfo="none">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 moreinfo="none">to_end</property>. </emphasis></para> + <para>If no one item is selected, the view represents the properties of the whole process + definition. </para> + + <figure float="0"> + <title>The Properties View of Process Definition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In this case, it contains six tabs. The first one is the <emphasis> + <property moreinfo="none">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 moreinfo="none">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 moreinfo="none">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 float="0"> + <title>The Diagram mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Besides, some properties can be directly edited in the <property moreinfo="none">Diagram + mode</property> of the graphical editor. One example of this is the <emphasis> + <property moreinfo="none">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 moreinfo="none">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 float="0"> + <title>The Source Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The <property moreinfo="none">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> + </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 moreinfo="none">Design mode</property>. You can + see it in the next picture:</para> + <figure float="0"> + <title>The Design Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_7.png"></imagedata> + </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 moreinfo="none">Add Before &gt; Comment</property>. </emphasis></para> + + <figure float="0"> + <title>Adding a Comment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_8.png"></imagedata> + </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 float="0"> + <title>Comment is added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_9.png"></imagedata> + </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 moreinfo="none">Deployment mode</property>. On the picture below + the <property moreinfo="none">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 float="0"> + <title>The Deployment Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The button <emphasis> + <property moreinfo="none">Test Connections</property> + </emphasis> is necessary to make sure whether all your settings are valid before + deploying the process.</para> + + + + + + <para>Now that we've seen how to work with <property moreinfo="none">jPDL + perspective</property>, let's pass on to the project testing.</para> + </section> + </section> +</chapter> + +<chapter id="Test_Drive_Proc_Development" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml" xreflabel="Test_Drive_Proc_Development"> + <?dbhtml filename="Test_Drive_Proc_Development.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>Test Driven Process Development</title> + + <para> 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. </para> + <para>In this chapter we will show how developers, making use of the JBoss jBPM GPD, can use a + technique we have baptized <property moreinfo="none">Test Driven Process Development</property> to create + process definitions and test their correctness. </para> + + <para> When creating the <emphasis> + <property moreinfo="none">HellojBPM</property> + </emphasis> 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 <emphasis> + <property moreinfo="none">.jar</property> + </emphasis> file containing the core jBPM classes. While working on the project you could + find them all in the <property moreinfo="none">Package Explorer</property>.</para> + + <figure float="0"> + <title>The jBPM Libraries</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>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 <link linkend="change_core_jbpm_inst">see + later</link> in this book.</para> + + <para> With that extra knowledge on the project settings, you can create your first test. To do + this, we create the <emphasis> + <property moreinfo="none">com.jbay</property> + </emphasis> package in the <emphasis> + <property moreinfo="none">test/java</property> + </emphasis> source folder. Then we bring up the context menu on this package and select <emphasis> + <property moreinfo="none">New &gt; Other...</property> + </emphasis></para> + + <figure float="0"> + <title>Call the JUnit Test Case Creation wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> And then <emphasis> + <property moreinfo="none">Java &gt; JUnit &gt; JUnit Test Case</property> + </emphasis> to call the specialized JUnite Test case creation wizard.</para> + <figure float="0"> + <title>Call the JUnit Test Case Creation wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The wizard looks as follows:</para> + + <figure float="0"> + <title>Create Test Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>By default JUnite 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 <emphasis> + <property moreinfo="none">Class under test</property> + </emphasis> section you can specify the class to test.</para> + + <figure float="0"> + <title>A First Test Scenario</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Then, we call the test class <emphasis> + <property moreinfo="none">HelloTest</property> + </emphasis> and press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to complete.</para> + + <para> Next, we should write a simple test scenario as shown on the next figure. Let's + study the code of this test case. </para> + + <figure float="0" id="hello_test"> + <title>A First Test Scenario</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_6.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>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 <emphasis> + <property moreinfo="none">hello</property> + </emphasis> file we created earlier and which lives in the <emphasis> + <property moreinfo="none">src/main/jpdl</property> + </emphasis> 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 <emphasis> + <property moreinfo="none">auction</property> + </emphasis> state. Finally another signal will end the process. </para> + + + <para> After writing this test we can check whether it works as expected by running it .</para> + + <figure float="0"> + <title>Running the Process Test</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_7.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>All went well as we have a green light:</para> + + <figure float="0"> + <title>Successful Test Run</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_8.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> 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 <ulink url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink> 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 <link linkend="jboss_jbpm_runtime_installation">the second + chapter</link>. 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.</para> + +</chapter> + + +<chapter id="The_JBoss_jBPM_Int_Mech" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml" xreflabel="The_JBoss_jBPM_Int_Mech"> + <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>Actions : The JBoss jBPM Integration Mechanism</title> + + <para> In this chapter we will show how to do software integration with <property moreinfo="none">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 moreinfo="none">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 moreinfo="none">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 moreinfo="none">HelloActionHandler</property>. + </emphasis> For that firstly we'll create a new package <emphasis> + <property moreinfo="none">com.jbay.action</property> + </emphasis> in the <emphasis> + <property moreinfo="none">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 moreinfo="none">New &gt; Class</property>. + </emphasis> </para> + + <figure float="0"> + <title>Creating HelloActionHendler Class</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Notice that two first gaps have been filled automatically. Here, instead of <emphasis> + <property moreinfo="none">Package</property> + </emphasis> option <emphasis> + <property moreinfo="none">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 moreinfo="none">HelloActionHandler</property> + </emphasis> as a name of new class and add <emphasis> + <property moreinfo="none">org.jbpm.graph.ActionHendler</property> + </emphasis> interface as it's shown in the picture above.</para> + + <para>Thus, our <emphasis> + <property moreinfo="none">HelloActionHandler</property> + </emphasis> implements the <emphasis> + <property moreinfo="none">ActionHandler</property> + </emphasis> interface including the <emphasis> + <property moreinfo="none">execute</property> + </emphasis> method as shown in the next figure. Here, we add a variable named <emphasis> + <property moreinfo="none">greeting</property> + </emphasis> to the collection of process variables and put a message in it : + <emphasis>"Hello from ActionHandler"</emphasis>. </para> + + <figure float="0"> + <title>A Simple Hello Action</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, as we have <emphasis> + <property moreinfo="none">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 moreinfo="none">ActionHandler</property> + </emphasis> to the process. So we implement another test.</para> + + <para>At first, let's return to the + code we already saw <link linkend="hello_test">in the previous chapter</link> and add new test method <emphasis> + <property moreinfo="none">testActionHendler</property></emphasis> to it. </para> + + <figure float="0"> + <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"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>We assert + that no variable called <emphasis> + <property moreinfo="none">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 moreinfo="none">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 float="0"> + <title>Test Results Before Integration</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png" scale="75"></imagedata> + </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 float="0"> + <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"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After adding the action a tabbed view with three pages will appear.</para> + + <figure float="0"> + <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"></imagedata> + </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 float="0"> + <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"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>Clicking on the <emphasis> + <property moreinfo="none">Search...</property> + </emphasis> button brings us to a Choose Class dialog.</para> + + + <figure float="0"> + <title>The Choose Action Handler Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para> We choose our previously created 'HelloActionHandler' class and + push the <property moreinfo="none">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 float="0"> + <title>Test Results</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Tere 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> + +</chapter> + + +<chapter id="Quick_Howto_Guide" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml" xreflabel="Quick_Howto_Guide"> + <?dbhtml filename="Quick_Howto_Guide.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>Quick Howto Guide</title> + + <para>This chapter contains additional information related to the <property moreinfo="none">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 moreinfo="none">jBPM</property> installation by means of the + Eclipse preference mechanism. Open the Preferences dialog by selecting <emphasis> + <property moreinfo="none">Window &gt; Preferences</property> + </emphasis> and select the <emphasis> + <property moreinfo="none">JBoss jBPM &gt; Runtime Location</property> + </emphasis> category. Using this page you can add multiple <property moreinfo="none">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 moreinfo="none">jBPM</property> + installation that's being referenced by a project however will cause the + classpath to contain errors. </para> + + + <figure float="0"> + <title>The jBPM Preferences Page</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"></imagedata> + </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 moreinfo="none">Properties view</property> for selected Task node includes several tabs. </para> + + <figure float="0"> + <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"></imagedata> + </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 float="0"> + <title>Adding a Task to the Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Every added Task has its own configuration possibilities. You can access them through + the <property moreinfo="none">Properties view</property> as well.</para> + + <figure float="0"> + <title>The Task properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">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 moreinfo="none">approve oder</property> + </emphasis> with appropriate description that you can see in the figure below.</para> + + <figure float="0"> + <title>The Task General Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, look at <property moreinfo="none">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 moreinfo="none">Blocking</property> + </emphasis> attribute indicates that the process will not be able to continue if this + task is still unaccomplished. The <emphasis> + <property moreinfo="none">Generate Form...</property> + </emphasis> button is for creating a simple task form that can be rendered by the jBPM + console.</para> + + <figure float="0"> + <title>The Task Details Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png" scale="80"></imagedata> + </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 moreinfo="none">Signalling</property> + </emphasis> and <emphasis> + <property moreinfo="none">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 moreinfo="none">Assignment page</property>.</para> + + <figure float="0"> + <title>The Task Assignment Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the <property moreinfo="none">Reminder page</property> you can specify whether the assignee will be reminded of the task + that awaits him.</para> + + <figure float="0"> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png" scale="80"></imagedata> + </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 float="0"> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata 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&amp;op=viewforum&... forum</ulink>.</para> + </section> +</chapter> + + + <!-- TODO: drools used in this section is not available for eclipse .3.3 &AddBusinessProcess; --> +</book> Modified: branches/jbosstools-3.0.0.Beta1/jbpm/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.0.0.Beta1/jbpm/docs/reference/pom.xml 2008-10-30 11:12:00 UTC (rev 11329) +++ branches/jbosstools-3.0.0.Beta1/jbpm/docs/reference/pom.xml 2008-10-30 11:35:01 UTC (rev 11330) @@ -31,7 +31,7 @@ </dependency> </dependencies> <configuration> - <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDocumentName>master_output.xml</sourceDocumentName> <sourceDirectory>${pom.basedir}/en</sourceDirectory> <imageResource> <directory>${pom.basedir}/en</directory> Added: branches/jbosstools-3.0.0.Beta1/ws/docs/reference/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.0.Beta1/ws/docs/reference/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.0.Beta1/ws/docs/reference/en/master_output.xml 2008-10-30 11:35:01 UTC (rev 11330) @@ -0,0 +1,556 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY overview SYSTEM "modules/overview.xml"> +<!ENTITY topdown SYSTEM "modules/topdown.xml"> +<!ENTITY preference SYSTEM "modules/preference.xml"> +<!ENTITY webproject SYSTEM "modules/webproject.xml"> +<!ENTITY client SYSTEM "modules/client.xml"> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JBoss WS User Guide</title> + <author&gt;&lt;firstname&gt;Denny&lt;/firstname&gt;&lt;surname&gt;Xu&lt;/surname&gt;&lt;email&gt;dxu(a)redhat.com&lt;/email&gt;&lt;/author&gt; + <author&gt;&lt;firstname&gt;Grid&lt;/firstname&gt;&lt;surname&gt;Qian&lt;/surname&gt;&lt;email&gt;fqian(a)redhat.com&lt;/email&gt;&lt;/author&gt; + <pubdate>July 2008</pubdate> + <copyright> + <year>2008</year> + <holder>JBoss, a division of Red Hat Inc.</holder> + </copyright> + <releaseinfo> + Version: <diffmk:wrapper diffmk:change="changed">3.0.0.beta1 + </diffmk:wrapper></releaseinfo> +<abstract diffmk:change="added"> + <title diffmk:change="added"></title> + <para diffmk:change="added"> + <ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs/en/ws_ref_gui... diffmk:change="added">PDF version</diffmk:wrapper></ulink> + </para> +</abstract> + + + + </bookinfo> + + <toc></toc> + +<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/overview.xml"> + <title>JBossWS Runtime Overview</title> + + <para>JBossWS is a web service framework developed as <diffmk:wrapper diffmk:change="added">a </diffmk:wrapper>part of the JBoss Application Server. It implements the JAX-WS specification that defines a programming model and run-time architecture for implementing web services in Java, targeted at the Java Platform, Enterprise Edition 5 (Java EE <diffmk:wrapper diffmk:change="changed">5).</diffmk:wrapper></para> + +</chapter> + +<chapter id="create_ws_topdown" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/topdown.xml"> + <?dbhtml filename="topdown.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Web Service</keyword> + <keyword>JBossWS Web Service runtime</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a Web Service using JBossWS runtime</title> + <para>In this chapter we provide you with the necessary steps to create a Web Service using + JBossWS runtime.</para> + + <section id="createproject"> + <title>Creating a Dynamic Web project</title> + + <para>Before <diffmk:wrapper diffmk:change="changed">creating </diffmk:wrapper>a web service, you <diffmk:wrapper diffmk:change="changed">should </diffmk:wrapper>have a Dynamic Web Project <diffmk:wrapper diffmk:change="added">created:</diffmk:wrapper></para> + <figure float="0"> + <title>Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_webproject_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Create <diffmk:wrapper diffmk:change="added">a</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">the service </diffmk:wrapper>Web project by selecting <emphasis> + <property moreinfo="none">New &gt; Project... &gt; Dynamic Web project</property> + </emphasis>. Enter the following information: </para> + <itemizedlist> + <listitem> + <para>Project Name: enter a project name</para> + </listitem> + <listitem> + <para>Target runtime: any server depending on <diffmk:wrapper diffmk:change="changed">your installation. </diffmk:wrapper>If it is not listed, <diffmk:wrapper diffmk:change="deleted">click + </diffmk:wrapper><diffmk:wrapper diffmk:change="added">click </diffmk:wrapper>New and browse to the location where it is <diffmk:wrapper diffmk:change="changed">installed </diffmk:wrapper><diffmk:wrapper diffmk:change="added">to. </diffmk:wrapper>You may set <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> to <emphasis> + <property moreinfo="none">None</property> + </emphasis>, in this case, you <diffmk:wrapper diffmk:change="changed">should </diffmk:wrapper>add <link diffmk:change="added" linkend="addfacet">JBoss Web Service + facet to the project</link> .</para> + <figure float="0"> + <title>Dynamic Web Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_webproject_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para><diffmk:wrapper diffmk:change="changed">Configure </diffmk:wrapper>Web Module <diffmk:wrapper diffmk:change="changed">values:</diffmk:wrapper></para> + <figure float="0"> + <title><diffmk:wrapper diffmk:change="deleted">Configures </diffmk:wrapper>Web Module Settings <diffmk:wrapper diffmk:change="added">Configuration</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_webproject_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>Click <diffmk:wrapper diffmk:change="added">on the </diffmk:wrapper><property moreinfo="none">Finish</property> button.</para> + </section> + + <section id="addfacet"> + <title>Configure JBoss Web Service facet settings</title> + <para>If you have already <diffmk:wrapper diffmk:change="changed">created </diffmk:wrapper>a <diffmk:wrapper diffmk:change="changed">new </diffmk:wrapper><diffmk:wrapper diffmk:change="added">Dynamic Web</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">web </diffmk:wrapper>project, the next step is to add JBoss Web + Service facet to the <diffmk:wrapper diffmk:change="added">project:</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">project </diffmk:wrapper></para> + <figure float="0" id="figure_addfacet"> + <title>Configure JBoss Web Service Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_facet.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Server Supplied JBossWS Runtime: If you have already set a JBoss runtime to the + project's target runtime, you may choose <emphasis> + <property moreinfo="none">Server Supplied JBossWS Runtime</property> + </emphasis> and then click <emphasis> + <property moreinfo="none">Ok</property> + </emphasis> to finish the configuration of JBoss Web Service facet. + </para> + <para>If the project has no <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> settings, you <diffmk:wrapper diffmk:change="changed">should </diffmk:wrapper>check the second radio button and specify a JBossWS <diffmk:wrapper diffmk:change="deleted">runtime + </diffmk:wrapper><diffmk:wrapper diffmk:change="added">runtime </diffmk:wrapper>from the list. You also can create a new JBossWS runtime, click <diffmk:wrapper diffmk:change="added">on the </diffmk:wrapper><emphasis> + <property moreinfo="none">New...</property> + </emphasis> button will bring you to another dialog <diffmk:wrapper diffmk:change="changed">to configure </diffmk:wrapper>new JBossWS runtime.</para> + <figure float="0" id="figure_addfacet1"> + <title>Configure JBossWS Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_newruntime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>See how to configure a new JBossWS runtime <link diffmk:change="added" linkend="preference"><diffmk:wrapper diffmk:change="added">here</diffmk:wrapper></link><diffmk:wrapper diffmk:change="changed">:</diffmk:wrapper></para> + + </section> + + + <section id="topdownwebservice"> + <title>Creating a Web Service from a WSDL document using JBossWS runtime</title> + <para>In this chapter we provide you with the necessary steps to create a Web Service from a + WSDL document using JBossWS runtime.</para> + <para>At first, please make sure that you have already <diffmk:wrapper diffmk:change="changed">created </diffmk:wrapper>a dynamic Web project with <diffmk:wrapper diffmk:change="deleted">JBoss + </diffmk:wrapper><diffmk:wrapper diffmk:change="added">JBoss </diffmk:wrapper>Web Service facet <diffmk:wrapper diffmk:change="deleted">get </diffmk:wrapper>installed. </para> + <para><diffmk:wrapper diffmk:change="added">See how to</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">To </diffmk:wrapper>make it <diffmk:wrapper diffmk:change="deleted">see </diffmk:wrapper><link linkend="createproject"><diffmk:wrapper diffmk:change="added">here</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">create dynamic Web project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">&gt; </diffmk:wrapper>and <link linkend="addfacet"><diffmk:wrapper diffmk:change="added">here</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">add JBoss Web Service facet</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + + <para>To create <diffmk:wrapper diffmk:change="added">a </diffmk:wrapper>Web Service using JBossWS runtime select<emphasis> + <property moreinfo="none">File &gt; New &gt; Other &gt; Web Services &gt; Web Service</property> + </emphasis> to run Web Service creation wizard. + </para> + <para>Let's get through the wizard <diffmk:wrapper diffmk:change="changed">step-by-step:</diffmk:wrapper></para> + <figure float="0" id="figure_create_ws_topdown"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_ws_creation1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>First, please select <property moreinfo="none">Top down Java bean Web Service</property> from <diffmk:wrapper diffmk:change="added">the </diffmk:wrapper>Web + Service type list, and select a WSDL document from workspace, click <diffmk:wrapper diffmk:change="changed">on the + </diffmk:wrapper>Server <diffmk:wrapper diffmk:change="added">name + lilnk </diffmk:wrapper>on the page will bring you to another dialog. Here you can specify the server to a + JBoss Server and Web Service runtime to JBossWS <diffmk:wrapper diffmk:change="changed">runtime:</diffmk:wrapper></para> + <figure float="0" id="figure_create_ws_topdown_setserver"> + <title>Select Server and Web Service runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_ws_creation1_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on <diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis> + <property moreinfo="none">Finish</property> + </emphasis> <diffmk:wrapper diffmk:change="added">button</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">Button you </diffmk:wrapper><diffmk:wrapper diffmk:change="changed">to see </diffmk:wrapper>the <diffmk:wrapper diffmk:change="changed">next </diffmk:wrapper>wizard <diffmk:wrapper diffmk:change="added">view opened:</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">view.</diffmk:wrapper></para> + + <figure float="0" id="figure_create_ws_topdown1"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_ws_creation1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on <diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis> + <property moreinfo="none">Next</property> + </emphasis> button to <diffmk:wrapper diffmk:change="added">proceed:</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">next step</diffmk:wrapper></para> + <figure float="0" id="figure_create_ws_topdown_codegen"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_ws_creation2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this page, the default package name comes from the namespace of the WSDL document, + you also can change it to any valid package name you want. JAX-WS specification should be + set to 2.0 if your JBossWS runtime in JBoss Server is JBossWS native runtime. You can + specify a catalog file and binding files if you <diffmk:wrapper diffmk:change="added">have them.</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">have. </diffmk:wrapper>If you want the wizard <diffmk:wrapper diffmk:change="added">to + </diffmk:wrapper>generate empty implementation classes for the Web Service, check the <emphasis> + <property moreinfo="none">Generate default Web Service implementation classes</property> + </emphasis> check <diffmk:wrapper diffmk:change="added">box.</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">box . </diffmk:wrapper>If you want <diffmk:wrapper diffmk:change="added">to </diffmk:wrapper>update the default Web.xml file with the Web Service + servlets <diffmk:wrapper diffmk:change="deleted">get </diffmk:wrapper>configured, check <diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis> + <property moreinfo="none">Update the default Web.xml</property> + </emphasis> check box. Click on <diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis> + <property moreinfo="none">Next</property> + </emphasis> or <diffmk:wrapper diffmk:change="added">on the </diffmk:wrapper><emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to generate <diffmk:wrapper diffmk:change="added">code.</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">code </diffmk:wrapper></para> + + <para>Once the Web Service code is generated, you can view the implementation class and add + business logic to each method.</para> + <figure float="0" id="figure_impl_code"> + <title>The generated implementation Java code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_ws_Impl_code_view.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>View <diffmk:wrapper diffmk:change="added">the </diffmk:wrapper>Web.xml <diffmk:wrapper diffmk:change="added">file:</diffmk:wrapper></para> + <figure float="0" id="figure_webxml"> + <title>Web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_ws_webxml.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="bottomupws"> + <title>Creating a Web service from a Java bean using JBossWS runtime</title> + <para>The Web Service wizard assists you in creating a new Web service, configuring it for + deployment, and <diffmk:wrapper diffmk:change="added">then</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">deploying the </diffmk:wrapper><diffmk:wrapper diffmk:change="changed">deploying it </diffmk:wrapper>to <diffmk:wrapper diffmk:change="changed">the </diffmk:wrapper>server.</para> + <para>To create a Web service from a bean using JBoss WS:</para> + <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> + <para><diffmk:wrapper diffmk:change="added">Create</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">Creating </diffmk:wrapper><link diffmk:change="added" linkend="createproject">a Dynamic Web project</link>.</para> + <para>Add <link diffmk:change="added" linkend="addfacet">JBossWS Facet</link> to Web <diffmk:wrapper diffmk:change="added">project.</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">project.</diffmk:wrapper></para> + <para>Create a Web Service from a java bean: </para> + <itemizedlist> + <listitem> + <para>Switch to the Java EE perspective <emphasis> + <property moreinfo="none">Window &gt; Open Perspective &gt; Java EE</property> + </emphasis>.</para> + </listitem> + <listitem> + <para>In the Project Explorer view, select the bean that you created or imported into + the source folder of your Web project.</para> + <figure float="0"> + <title>Create a new Bean Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_bottomup.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">File &gt; New &gt; Other</property> + </emphasis><diffmk:wrapper diffmk:change="added">. Select</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">.Select </diffmk:wrapper>Web Services in order to display <diffmk:wrapper diffmk:change="deleted">the </diffmk:wrapper>various Web service wizards. + Select the Web Service wizard. Click <diffmk:wrapper diffmk:change="added">on the </diffmk:wrapper><property moreinfo="none">Next</property> button.</para> + <figure float="0"> + <title>New Web Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_bottomup_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para><diffmk:wrapper diffmk:change="changed">On </diffmk:wrapper>the first Web Service wizard page: select <property moreinfo="none">Bottom up Java bean Web + service</property> as your Web service type, and select the Java bean from which + the service will be <diffmk:wrapper diffmk:change="changed">created:</diffmk:wrapper></para> + <figure float="0"> + <title>Set Web Service Common values</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_bottomup_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select the stages of Web service development that you want to complete using + the slider: </para> + <itemizedlist> + <listitem> + <para>Develop: this will develop the WSDL definition and implementation of + the Web service. This includes such tasks as creating <diffmk:wrapper diffmk:change="deleted">the </diffmk:wrapper>modules <diffmk:wrapper diffmk:change="added">that</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">which + will </diffmk:wrapper><diffmk:wrapper diffmk:change="added">will + </diffmk:wrapper>contain <diffmk:wrapper diffmk:change="deleted">the </diffmk:wrapper>generated code, WSDL files, deployment descriptors, and + <diffmk:wrapper diffmk:change="deleted">Java </diffmk:wrapper><diffmk:wrapper diffmk:change="added">Java + </diffmk:wrapper>files when appropriate.</para> + </listitem> + <listitem> + <para>Assemble: this ensures the project that will host the Web service or + client gets associated to an EAR when required by the target application + server.</para> + </listitem> + <listitem> + <para>Deploy: this will create the deployment code for the service.</para> + </listitem> + <listitem> + <para>Install: this will install and configure the Web module and EARs on + the target server.</para> + </listitem> + <listitem> + <para>Start: this will start the server once the service has been installed + on it. The server-config.wsdd file will be generated.</para> + </listitem> + <listitem> + <para>Test: this will provide various options for testing the service, such + as using the Web Service Explorer or sample <diffmk:wrapper diffmk:change="changed">JSPs.</diffmk:wrapper></para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>Select your server: the default server is displayed. If you want to deploy + your service to a different server click the link to specify a different server. + </para> + </listitem> + <listitem> + <para>Select your runtime: ensure the JBoss WS runtime is selected.</para> + </listitem> + <listitem> + <para>Select the service project: the project selected in your workspace is + displayed. To select a different project click on the project link. If you are + deploying to JBoss Application Server you will also be asked to select the EAR + associated with the project. Ensure that the project selected as the Client Web + Project is different from the Service Web Project, or the service will be + overwritten by the client's generated artifacts.</para> + </listitem> + <listitem> + <para>If you want to create a client, select the type of proxy to be generated + and repeat the above steps for the client. The better way is to create a web + service client project <diffmk:wrapper diffmk:change="changed">separately.</diffmk:wrapper></para> + </listitem> + </itemizedlist> + <para>Click <diffmk:wrapper diffmk:change="added">on the </diffmk:wrapper><property moreinfo="none">Next</property> button.</para> + </listitem> + <listitem> + <para><diffmk:wrapper diffmk:change="changed">On </diffmk:wrapper>the JBoss Web Service Code Generation Configuration page, <diffmk:wrapper diffmk:change="deleted">you </diffmk:wrapper>set <diffmk:wrapper diffmk:change="added">the following + </diffmk:wrapper>values:</para> + <figure float="0"> + <title>Set Web Service values <diffmk:wrapper diffmk:change="changed">for </diffmk:wrapper>Code Generation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_bottomup_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Generate WSDL file: select it, you will get a generated WSDL file in your + project. But this wsdl's services' address location values are not <diffmk:wrapper diffmk:change="added">a </diffmk:wrapper>real + address. </para> + </listitem> + <listitem> + <para>After the Web service has been created, the following <diffmk:wrapper diffmk:change="changed">option can become + </diffmk:wrapper><diffmk:wrapper diffmk:change="added">available depending </diffmk:wrapper>on the options you selected: Update the default <diffmk:wrapper diffmk:change="added">web.xm + file.</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">web.xml. </diffmk:wrapper><diffmk:wrapper diffmk:change="changed">If selected, </diffmk:wrapper>you may test the web service by Explorer.</para> + </listitem> + </itemizedlist> + <para>Click <diffmk:wrapper diffmk:change="added">on the </diffmk:wrapper><property moreinfo="none">Next</property> button.</para> + </listitem> + <listitem> + <para><diffmk:wrapper diffmk:change="changed">On </diffmk:wrapper>this page, the project is deployed to the server. <diffmk:wrapper diffmk:change="changed">You </diffmk:wrapper>can start <diffmk:wrapper diffmk:change="added">the </diffmk:wrapper>server and <diffmk:wrapper diffmk:change="deleted">test + </diffmk:wrapper><diffmk:wrapper diffmk:change="added">test </diffmk:wrapper>the web service. If you want to publish the web service to a UDDI registry, you <diffmk:wrapper diffmk:change="deleted">may + </diffmk:wrapper><diffmk:wrapper diffmk:change="added">may </diffmk:wrapper>click <diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><property moreinfo="none">Next</property> button to publish it. If not, you may click + <diffmk:wrapper diffmk:change="added">the + </diffmk:wrapper><property moreinfo="none">Finish</property> button.</para> + <figure float="0"> + <title>Start a Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_bottomup_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>After the Web Service has been created, the following <diffmk:wrapper diffmk:change="added">options </diffmk:wrapper>may <diffmk:wrapper diffmk:change="changed">become </diffmk:wrapper><diffmk:wrapper diffmk:change="added">available + </diffmk:wrapper>depending on the options + <diffmk:wrapper diffmk:change="deleted">you </diffmk:wrapper>selected:</para> + <itemizedlist> + <listitem> + <para> the generated web services <diffmk:wrapper diffmk:change="changed">code</diffmk:wrapper></para> + </listitem> + <listitem> + <para>If <diffmk:wrapper diffmk:change="changed">you </diffmk:wrapper>selected to generate <diffmk:wrapper diffmk:change="added">a </diffmk:wrapper>WSDL file, you will get the file in your project's + WebContent &gt; wsdl folder.</para> + <figure float="0"> + <title>The generated WSDL file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_bottomup_6.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>If <diffmk:wrapper diffmk:change="changed">you </diffmk:wrapper>selected to update the default web.xml, you will test the web service in + <diffmk:wrapper diffmk:change="added">the browser.</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">browser.Open </diffmk:wrapper><diffmk:wrapper diffmk:change="added">Open </diffmk:wrapper>the Explorer, input the url for the web service according to <diffmk:wrapper diffmk:change="deleted">web.xml + </diffmk:wrapper><diffmk:wrapper diffmk:change="added">web.xml </diffmk:wrapper>plus <property moreinfo="none">?wsdl.</property>, you will get the WSDL file from Explorer. </para> + <figure float="0"> + <title>The Updated web.xml <diffmk:wrapper diffmk:change="added">file</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_bottomup_5.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + </section> + +</chapter> + + +<chapter id="client" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/client.xml"> + <title>Creating a Web Service Client from a WSDL Document using JBoss WS</title> + <para>To create a Web Service Client from a WSDL Document using JBoss WS:</para> + <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> + <para><link linkend="createproject">Creating a Dynamic Web project</link>.</para> + <para><link linkend="addfacet">Add JBossWS Facet to Web project</link>.</para> + <para>Create a Web Service Client from a WSDL document: </para> + <itemizedlist> + <listitem> + <para>Switch to the Java EE perspective <emphasis><property moreinfo="none">Window &gt; Open Perspective &gt; Java EE</property></emphasis>.</para> + </listitem> + <listitem> + <para>In the Project Explorer view, select the bean that you created or imported into the source folder of your Web project.</para> + </listitem> + <listitem> + <para>Click <emphasis><property moreinfo="none">File &gt; New &gt; Other</property></emphasis>.Select Web Services in order to display the various Web service wizards. Select the Web Service Client wizard. Click <property moreinfo="none">Next</property> button.</para> + <figure float="0"> + <title>New Web Service Client</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_client.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>The first and second Web Service Client wizard page are same to <link linkend="topdownwebservice">Web Service from a WSDL document</link>.</para> + <figure float="0"> + <title>Set Web Service Common values</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_client_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>Set Web Service values about WSDL file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_client_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The differences are:</para> + <itemizedlist> + <listitem> + <para><property moreinfo="none">Client Type:</property> Now only support Java Proxy.</para> + </listitem> + </itemizedlist> + <para>Click <property moreinfo="none">Finish</property> button.</para> + </listitem> + </itemizedlist> + <para>After the Web Service Client has been created, the following may occur depending on the options you selected:</para> + <itemizedlist> + <listitem> + <para> the generated web service and client codes</para> + </listitem> + <listitem> + <para>a client sample class.</para> + <figure float="0"> + <title>Client Sample Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_client_3.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>JBoss WS use a Java class to test Web Service. A client sample class will be generated, you may run this client as a java application to call a web service.</para> +</chapter> + + +<chapter id="preference" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/preference.xml"> +<title>JBoss WS and development environment</title> + <section id="jbosswspreference"> + <title>JBossWS Preferences</title> + +<para>In this section you <diffmk:wrapper diffmk:change="added">will</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">get to </diffmk:wrapper>know how JBossWS preferences can be modified during the development process.</para> + + <para>JBossWS preferences can be set <diffmk:wrapper diffmk:change="changed">on </diffmk:wrapper>the JBossWS preference page. Click on <emphasis><property moreinfo="none">Window &gt; Preferences &gt; JBoss Tools &gt; Web &gt; JBossWS <diffmk:wrapper diffmk:change="changed">Preferences</diffmk:wrapper></property>.</emphasis></para> + + <para>On this page you can manage the JBossWS Runtime. Use the appropriate buttons to <property moreinfo="none">Add</property> more runtimes or to <property moreinfo="none">Remove</property> those that are not needed.</para> + + <figure float="0"> + <title>JBossWS Preferences Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Jbossws_preference.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Clicking on <emphasis><property moreinfo="none">Add</property></emphasis> or <emphasis><property moreinfo="none">Edit</property></emphasis> button <diffmk:wrapper diffmk:change="deleted">you </diffmk:wrapper>will <diffmk:wrapper diffmk:change="changed">open </diffmk:wrapper>the form where you can configure a new JbossWS runtime and change the path <diffmk:wrapper diffmk:change="changed">to </diffmk:wrapper>JBossWS runtime home folder, + modify <diffmk:wrapper diffmk:change="added">the </diffmk:wrapper>name and version of <diffmk:wrapper diffmk:change="changed">the </diffmk:wrapper>existing JBossWS runtime settings. Press <property moreinfo="none">Finish</property> to apply the changes.</para> + + <figure float="0"> + <title>Edit JBossWS Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Jbossws_preference_new.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="serverruntime"> + <title>Default Server and Runtime</title> + <para>Open + <emphasis><property moreinfo="none">Window &gt; Preferences &gt; Web Services &gt; Server and Runtime</property></emphasis>. <diffmk:wrapper diffmk:change="changed">On </diffmk:wrapper>this page, you can <diffmk:wrapper diffmk:change="added">specify a</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">set </diffmk:wrapper>default server and runtime.</para> + <para>For ease of use, the better way is to set runtime <diffmk:wrapper diffmk:change="changed">to </diffmk:wrapper>JBoss WS.</para> + <para>After <diffmk:wrapper diffmk:change="deleted">set </diffmk:wrapper>server and <diffmk:wrapper diffmk:change="added">runtime are</diffmk:wrapper><diffmk:wrapper diffmk:change="deleted">runtime, </diffmk:wrapper><diffmk:wrapper diffmk:change="added">specified, </diffmk:wrapper>click <diffmk:wrapper diffmk:change="added">on the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Aply</diffmk:wrapper></property> button to save the <diffmk:wrapper diffmk:change="changed">values.</diffmk:wrapper></para> + <figure float="0"> + <title></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbossws_server_runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> + +</book> Modified: branches/jbosstools-3.0.0.Beta1/ws/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.0.0.Beta1/ws/docs/reference/pom.xml 2008-10-30 11:12:00 UTC (rev 11329) +++ branches/jbosstools-3.0.0.Beta1/ws/docs/reference/pom.xml 2008-10-30 11:35:01 UTC (rev 11330) @@ -34,7 +34,7 @@ </dependencies> <configuration> - <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDocumentName>master_output.xml</sourceDocumentName> <sourceDirectory>${pom.basedir}/en</sourceDirectory> <imageResource> <directory>${pom.basedir}/en</directory>