Author: sabrashevich Date: 2007-11-13 11:44:53 -0500 (Tue, 13 Nov 2007) New Revision: 4880 Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/ trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/default.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour1.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour10.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour11.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour12.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour13.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour14.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour15.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour2.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour3.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour4.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour5.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour6.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour7.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour8.png trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour9.png trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml trunk/jbpm/docs/reference/en/modules/jbpm_designer_install.xml Removed: trunk/jbpm/docs/reference/en/images/jBPMDesignerInstall/ trunk/jbpm/docs/reference/en/modules/jBPMDesignerInstall.xml Modified: trunk/jbpm/docs/reference/en/master.xml trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml Log: http://jira.jboss.com/jira/browse/RHDS-288 updated second chapter, new screenshots Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/default.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/default.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour1.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour10.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour11.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour12.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour13.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour14.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour15.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour15.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour2.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour3.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour4.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour5.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour6.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour7.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour8.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour9.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/jbpm/docs/reference/en/master.xml =================================================================== --- trunk/jbpm/docs/reference/en/master.xml 2007-11-13 16:38:04 UTC (rev 4879) +++ trunk/jbpm/docs/reference/en/master.xml 2007-11-13 16:44:53 UTC (rev 4880) @@ -3,8 +3,9 @@ "../../resources/support/docbook-dtd/docbookx.dtd" -[<!ENTITY Introduction SYSTEM "modules/Introduction.xml"> -<!ENTITY jBPMDesignerInstall SYSTEM "modules/jBPMDesignerInstall.xml"> +[<!ENTITY Introduction SYSTEM "modules/introduction.xml"> +<!ENTITY jBPMDesignerInstall SYSTEM "modules/jbpm_designer_install.xml"> +<!ENTITY GuidedTourJBossjBPMGPD SYSTEM "modules/guided_tour_jboss_jbpmgpd.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"> @@ -28,6 +29,7 @@ &Introduction; &jBPMDesignerInstall; +&GuidedTourJBossjBPMGPD; &Test_Drive_Proc; &The_JBoss_jBPM_Int_Mech; &Quick_Howto_Guide; Modified: trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml 2007-11-13 16:38:04 UTC (rev 4879) +++ trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml 2007-11-13 16:44:53 UTC (rev 4880) @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="Quick_Howto_Guide" xreflabel="Quick_Howto_Guide"> - <?dbhtml filename="Tutorial.html"?> + <?dbhtml filename="Quick_Howto_Guide.html"?> <chapterinfo> <keywordset> <keyword>jBPM</keyword> - <keyword/> - <keyword/> - <keyword/> - <keyword/> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> </keywordset> </chapterinfo> <title>Quick Howto Guide</title> Modified: trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml 2007-11-13 16:38:04 UTC (rev 4879) +++ trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml 2007-11-13 16:44:53 UTC (rev 4880) @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="Test_Drive_Proc_Development" xreflabel="Test_Drive_Proc_Development"> - <?dbhtml filename="Tutorial.html"?> + <?dbhtml filename="Test_Drive_Proc_Development.html"?> <chapterinfo> <keywordset> <keyword>jBPM</keyword> - <keyword/> - <keyword/> - <keyword/> - <keyword/> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> </keywordset> </chapterinfo> <title>Test Driven Process Development</title> Modified: trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml 2007-11-13 16:38:04 UTC (rev 4879) +++ trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml 2007-11-13 16:44:53 UTC (rev 4880) @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="The_JBoss_jBPM_Int_Mech" xreflabel="The_JBoss_jBPM_Int_Mech"> - <?dbhtml filename="Tutorial.html"?> + <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?> <chapterinfo> <keywordset> <keyword>jBPM</keyword> - <keyword/> - <keyword/> - <keyword/> - <keyword/> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> </keywordset> </chapterinfo> <title>Actions : The JBoss jBPM Integration Mechanism</title> Added: trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml (rev 0) +++ trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml 2007-11-13 16:44:53 UTC (rev 4880) @@ -0,0 +1,201 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="GuidedTourJBossjBPMGPD" 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>We have included a wizard in the GPD plugin to create a jBPM project. We have opted to create a project containing 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>To create a new jBPM project using the project creation wizard, we select <emphasis><property>File &gt;New Project...</property></emphasis> and in the New Project dialog, we select <emphasis><property>JBoss jBPM &gt; Process Project</property></emphasis>:</para> + <figure> + <title>New Project Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour1.png"/> + </imageobject> + </mediaobject> + </figure> + <para> Clicking <emphasis><property>Next</property></emphasis> brings us to the wizard page where we have to specify the name and location for the project. We choose for example <emphasis><property>Hello jBPM</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_tour2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on <emphasis><property>Finish</property></emphasis> results in the project being created. 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_tour3.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>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 &gt; New &gt; 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_tour4.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 Definion Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour5.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_tour6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>As you can see in the package explorer, 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> and <emphasis><property>processdefinition.xml</property></emphasis>.</para> + <para>The first of these two contains the graphical information used by the process definition editor. The processdefinition.xml 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>We will create a very simple process definition, consisting of a begin state, an intermediate state and an end state.</para> + <section id="adding_the_nodes"> + <?dbhtml filename="adding_the_nodes.html"?> + <title>Adding the Nodes</title> + <para>Select respectively 'Start', 'State' and 'End' 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_tour7.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="adding_transitions"> + <?dbhtml filename="adding_transitions.html"?> + <title>Adding Transitions</title> + <para>We will connect the nodes with transitions. 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 looks like:</para> + <figure> + <title>A Simple Process With Transitions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour8.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + </section> + <section id="the_outline_view"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Outline View</title> + <para>You can see an outline of the process being drawn in the RHDS outline view if it is visible (if not select <emphasis><property>Window &gt; Show view &gt; Outline</property></emphasis>). It is presented as the classical tree view. Also you use <emphasis><property>Overview</property></emphasis> that comes as as a scrollable thumbnail.</para> + <figure> + <title>The Outline and Overview Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour9.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="the_properties_view"> + <?dbhtml filename="the_properties_view.html"?> + <title>The Properties View</title> + <para>If the RHDS Properties view is visible (if not select <emphasis><property>Window &gt; Show view &gt; Properties</property></emphasis>), the relevant properties of the selected item are shown. Some of these properties may be directly editable in the properties view. An example of a directly editable property is the name property of the process definition. As you can see in the next figure, the name property of the process definition can be changed to <emphasis><property>jbay</property></emphasis>. You can also write a description for this property.</para> + <figure> + <title>The Properties of a Process Definition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour10.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Let&apos;s change the name of the first transition to <emphasis><property>to_auction</property></emphasis>. We repeat this name change for the second transition and name it <emphasis><property>to_end</property></emphasis>.</para> + <figure> + <title>Transitions Names</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour11.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + + <section id="direct_editing"> + <?dbhtml filename="direct_editing.html"?> + <title>Direct Editing</title> + <para>Some properties can be directly edited in 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 wich 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> + <figure> + <title>Directly Editing the Node Name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour12.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="the_source_view"> + <?dbhtml filename="the_source_view.html"?> + <title>The Source View</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 process definition editor.</para> + <figure> + <title>The Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour13.png"/> + </imageobject> + </mediaobject> + </figure> + <para>This source tab is editable, so if you know your way around in jpdl, you can create or tweak your process definitions directly in the xml source.</para> + </section> + <section id="the_design_view"> + <?dbhtml filename="the_design_view.html"?> + <title>The Design View</title> + <para>The file is also editable in <emphasis><property>Design</property></emphasis> view as you can see in the next picture:</para> + <figure> + <title>The Design View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour14.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="the_deployment_view"> + <?dbhtml filename="the_deployment_view.html"?> + <title>The Deployment View</title> + <para>The deployment settings of the project you can configure in <emphasis><property>Deployment</property></emphasis> view.</para> + <figure> + <title>The Deployment View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour15.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </chapter> + \ No newline at end of file Deleted: trunk/jbpm/docs/reference/en/modules/jBPMDesignerInstall.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/jBPMDesignerInstall.xml 2007-11-13 16:38:04 UTC (rev 4879) +++ trunk/jbpm/docs/reference/en/modules/jBPMDesignerInstall.xml 2007-11-13 16:44:53 UTC (rev 4880) @@ -1,131 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="jBPMDesignerInstall" xreflabel="jBPMDesignerInstall"> - <?dbhtml filename="jBPMDesignerInstall.html"?> - <chapterinfo> - <keywordset> - <keyword>jBPM</keyword> - <keyword></keyword> - <keyword></keyword> - <keyword></keyword> - <keyword></keyword> - </keywordset> - </chapterinfo> - <title>JBoss jBPM Graphical Process Designer Installation</title> - <para>The JBoss jBPM comes as a plugin for Red Hat Developer Studio. So a prerequisite to install the Designer is of course that you have a version of RHDS up and running.</para> -<para>Before installation you should download <property>jBPM</property> installation pack from this page: <ulink url="http://labs.jboss.com/auth/jbossjbpm/">jBPM Downloads</ulink>. The 3.1 release of the designer comes bundled with the corresponding 3.2 releases of the core jBPM project and the jBPM database project. After downloading save the archive on your computer.</para> -<section id="InstallationProcess"> -<?dbhtml filename="InstallationProcess.html"?> -<title>jBPM Installation Process</title> -<para>Having RHDS up and running and the JBoss jBPM package downloaded somewhere on your harddrive, let&apos;s describe the process of installing the plugin.</para> -<figure> -<title>Find And Install</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/jBPMinstallation.png"/> - </imageobject> -</mediaobject> -</figure> -<para>Experienced Eclipse users will feel very comfortable with this description as it is the normal plugin installation mechanism for local archive update sites. As is illustrated on the figure above &quot;Find And Install&quot; you have to navigate to the <emphasis><property>Find and Install...</property></emphasis> submenu of the Help menu.</para> -<para>Clicking the <emphasis><property>Find and Install...</property></emphasis> submenu shown above results in the opening of a wizard, as shown in the next screen. This wizard enables you to choose between searching for updates of currently installed plugins and searching for new features. This is the option we need, so we select it and push the <emphasis><property>Next</property></emphasis> button.:</para> -<figure> -<title>Search New Features</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/jBPMinstallation2.png"/> - </imageobject> -</mediaobject> -</figure> -<para>On the next page of the wizard we click the <emphasis><property>New Archived Site...</property></emphasis> button.</para> -<figure> -<title>Update Sites to Visit</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/jBPMinstallation3.png"/> - </imageobject> -</mediaobject> -</figure> -<para>The <emphasis><property>Select Local Site Archive</property></emphasis> dialog opens, we navigate to the freshly downloaded zipped update site and select it.</para> -<figure> -<title>Select Local Site Archive</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/jBPMinstallation4.png"/> - </imageobject> -</mediaobject> -</figure> -<para>Selecting the archive file and clicking the <emphasis><property>OK</property></emphasis> button brings us to another dialog that enables us to edit the name of the update site.</para> -<figure> -<title>Edit Local Site Name</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/default.png"/> - </imageobject> -</mediaobject> -</figure> -<para>We accept the defaults and this brings us back to the installation wizard. The selected archive containing the jBPM Designer plugin site should appear. Make sure the checkbox next to it is selected before clicking the <emphasis><property>Finish</property></emphasis> button:</para> -<figure> -<title>Select Update Site to Visit</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/default.png"/> - </imageobject> -</mediaobject> -</figure> -<para>The <emphasis><property>Select Update Site</property></emphasis> wizard closes but we aren&apos;t done yet as the <emphasis><property>Updates</property></emphasis> wizard opens immediately. In this wizard expand the tree of your newly added update site, select the checkbox next to the <emphasis><property>org.jbpm.ide.feature feature 3.1.0</property></emphasis> feature and click the <emphasis><property>Next</property></emphasis> button:</para> -<figure> -<title>Select the Feature to Install</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/default.png"/> - </imageobject> -</mediaobject> -</figure> -<para>We arrive on the <emphasis><property>Accept Feature License</property></emphasis> page of the wizard. Select <emphasis><property>I accept the terms in the license agreement</property></emphasis> if you do and click the <emphasis><property>Next</property></emphasis> button again.</para> -<figure> -<title>Accept Feature License</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/default.png"/> - </imageobject> -</mediaobject> -</figure> -<para>Clicking on the <emphasis><property>Next</property></emphasis> button in the <emphasis><property>Accept Feature License</property></emphasis> page has brought us on the final page of this installation wizard: the <emphasis><property>Installation</property></emphasis> page. Click <emphasis><property>Finish</property></emphasis> to end this wizard.</para> -<figure> -<title>Install the Selected Feature</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/default.png"/> - </imageobject> -</mediaobject> -</figure> -<para>For a moment, a progress monitor appears, indicating that Red Hat Developer Studio is busy extracting the necessary information out of the archive file to be able to install the contained plugins.</para> -<figure> -<title>Progress of the Download</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/default.png"/> - </imageobject> -</mediaobject> -</figure> -<para>After a while a new wizard appears:</para> -<figure> -<title>Feature Verification</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/default.png"/> - </imageobject> -</mediaobject> -</figure> -<para>Clicking on the <emphasis><property>Install All</property></emphasis> button results in a progress dialog showing up. After the installation is finished another dialog asks us whether or not to restart the workbench immediately. We want to be able to use the newly installed plugins immediately so we click <emphasis><property>Yes</property></emphasis>:</para> -<figure> -<title>Restart the Workbench</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/jBPMDesignerInstall/default.png"/> - </imageobject> -</mediaobject> -</figure> -<para>Congratulations. The JBoss jBPM GPD plugin is installed and ready to use. Let&apos;s see how we can set up a project and create a process definition in the following chapter.</para> -</section> -</chapter> - Added: trunk/jbpm/docs/reference/en/modules/jbpm_designer_install.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/jbpm_designer_install.xml (rev 0) +++ trunk/jbpm/docs/reference/en/modules/jbpm_designer_install.xml 2007-11-13 16:44:53 UTC (rev 4880) @@ -0,0 +1,131 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="jBPMDesignerInstall" xreflabel="jBPMDesignerInstall"> + <?dbhtml filename="jBPMDesignerInstall.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>JBoss jBPM Graphical Process Designer Installation</title> + <para>The JBoss jBPM comes as a plugin for Red Hat Developer Studio. So a prerequisite to install the Designer is of course that you have a version of RHDS up and running.</para> +<para>Before installation you should download <property>jBPM</property> installation pack from this page: <ulink url="http://labs.jboss.com/auth/jbossjbpm/">jBPM Downloads</ulink>. The 3.1 release of the designer comes bundled with the corresponding 3.2 releases of the core jBPM project and the jBPM database project. After downloading save the archive on your computer.</para> +<section id="InstallationProcess"> +<?dbhtml filename="InstallationProcess.html"?> +<title>jBPM Installation Process</title> +<para>Having RHDS up and running and the JBoss jBPM package downloaded somewhere on your harddrive, let&apos;s describe the process of installing the plugin.</para> +<figure> +<title>Find And Install</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/jbpm_installation.png"/> + </imageobject> +</mediaobject> +</figure> +<para>Experienced Eclipse users will feel very comfortable with this description as it is the normal plugin installation mechanism for local archive update sites. As is illustrated on the figure above &quot;Find And Install&quot; you have to navigate to the <emphasis><property>Find and Install...</property></emphasis> submenu of the Help menu.</para> +<para>Clicking the <emphasis><property>Find and Install...</property></emphasis> submenu shown above results in the opening of a wizard, as shown in the next screen. This wizard enables you to choose between searching for updates of currently installed plugins and searching for new features. This is the option we need, so we select it and push the <emphasis><property>Next</property></emphasis> button.:</para> +<figure> +<title>Search New Features</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/jbpm_installation2.png"/> + </imageobject> +</mediaobject> +</figure> +<para>On the next page of the wizard we click the <emphasis><property>New Archived Site...</property></emphasis> button.</para> +<figure> +<title>Update Sites to Visit</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/jbpm_installation3.png"/> + </imageobject> +</mediaobject> +</figure> +<para>The <emphasis><property>Select Local Site Archive</property></emphasis> dialog opens, we navigate to the freshly downloaded zipped update site and select it.</para> +<figure> +<title>Select Local Site Archive</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/jbpm_installation4.png"/> + </imageobject> +</mediaobject> +</figure> +<para>Selecting the archive file and clicking the <emphasis><property>OK</property></emphasis> button brings us to another dialog that enables us to edit the name of the update site.</para> +<figure> +<title>Edit Local Site Name</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/default.png"/> + </imageobject> +</mediaobject> +</figure> +<para>We accept the defaults and this brings us back to the installation wizard. The selected archive containing the jBPM Designer plugin site should appear. Make sure the checkbox next to it is selected before clicking the <emphasis><property>Finish</property></emphasis> button:</para> +<figure> +<title>Select Update Site to Visit</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/default.png"/> + </imageobject> +</mediaobject> +</figure> +<para>The <emphasis><property>Select Update Site</property></emphasis> wizard closes but we aren&apos;t done yet as the <emphasis><property>Updates</property></emphasis> wizard opens immediately. In this wizard expand the tree of your newly added update site, select the checkbox next to the <emphasis><property>org.jbpm.ide.feature feature 3.1.0</property></emphasis> feature and click the <emphasis><property>Next</property></emphasis> button:</para> +<figure> +<title>Select the Feature to Install</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/default.png"/> + </imageobject> +</mediaobject> +</figure> +<para>We arrive on the <emphasis><property>Accept Feature License</property></emphasis> page of the wizard. Select <emphasis><property>I accept the terms in the license agreement</property></emphasis> if you do and click the <emphasis><property>Next</property></emphasis> button again.</para> +<figure> +<title>Accept Feature License</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/default.png"/> + </imageobject> +</mediaobject> +</figure> +<para>Clicking on the <emphasis><property>Next</property></emphasis> button in the <emphasis><property>Accept Feature License</property></emphasis> page has brought us on the final page of this installation wizard: the <emphasis><property>Installation</property></emphasis> page. Click <emphasis><property>Finish</property></emphasis> to end this wizard.</para> +<figure> +<title>Install the Selected Feature</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/default.png"/> + </imageobject> +</mediaobject> +</figure> +<para>For a moment, a progress monitor appears, indicating that Red Hat Developer Studio is busy extracting the necessary information out of the archive file to be able to install the contained plugins.</para> +<figure> +<title>Progress of the Download</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/default.png"/> + </imageobject> +</mediaobject> +</figure> +<para>After a while a new wizard appears:</para> +<figure> +<title>Feature Verification</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/default.png"/> + </imageobject> +</mediaobject> +</figure> +<para>Clicking on the <emphasis><property>Install All</property></emphasis> button results in a progress dialog showing up. After the installation is finished another dialog asks us whether or not to restart the workbench immediately. We want to be able to use the newly installed plugins immediately so we click <emphasis><property>Yes</property></emphasis>:</para> +<figure> +<title>Restart the Workbench</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jbpm_designer_install/default.png"/> + </imageobject> +</mediaobject> +</figure> +<para>Congratulations. The JBoss jBPM GPD plugin is installed and ready to use. Let&apos;s see how we can set up a project and create a process definition in the following chapter.</para> +</section> +</chapter> +