Author: irooskov(a)redhat.com
Date: 2011-08-18 21:23:24 -0400 (Thu, 18 Aug 2011)
New Revision: 34082
Added:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/runtime_removal/
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/runtime_removal/runtime_removal_01.png
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Book_Info.xml
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Feedback.xml
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Introduction.xml
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Preface.xml
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Revision_History.xml
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_2.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_3.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_4.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_5.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_6.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_7.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_8.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_9.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_1.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_2.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_4.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_5.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_9.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/the_views/jbpm_1.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/the_views/jbpm_2.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/the_views/jbpm_3.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/the_views/the_views_10.png
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/master.xml
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/tasks.xml
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/the_views.xml
Log:
updated for JBDS 4.1 release (branch of trunk that somehow wasn't done before)
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Book_Info.xml
===================================================================
--- branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Book_Info.xml 2011-08-19 01:15:02
UTC (rev 34081)
+++ branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Book_Info.xml 2011-08-19 01:23:24
UTC (rev 34082)
@@ -5,9 +5,9 @@
<title>jBPM Tools Reference Guide</title>
<subtitle>Provides information relating to the jBPM Tools set.</subtitle>
<productname>JBoss Developer Studio</productname>
- <productnumber>4.0</productnumber>
- <edition>4.0.0</edition>
- <pubsnumber>4</pubsnumber>
+ <productnumber>4.1</productnumber>
+ <edition>4.1.0</edition>
+ <pubsnumber>1</pubsnumber>
<abstract>
<para>The jBPM Tools Reference Guide explains how to use the jBPM Tools to create
process definitions and workflow processes.</para>
</abstract>
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Feedback.xml
===================================================================
--- branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Feedback.xml 2011-08-19 01:15:02
UTC (rev 34081)
+++ branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Feedback.xml 2011-08-19 01:23:24
UTC (rev 34082)
@@ -1,20 +1,92 @@
<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback"
lang="en-US">
+ <title>Getting Help and Giving Feedback</title>
+ <section id="sect_JBoss-Do_You_Need_Help">
+ <title>Do You Need Help?</title>
+ <indexterm>
+ <primary>help</primary>
+ <secondary>getting help</secondary>
-<section id="sect-Beginners_Guide-We_Need_Feedback"
lang="en-US">
- <title>We Need Feedback!</title>
- <indexterm>
- <primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
- </indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to
make this manual better, we would love to hear from you! Please submit a report in JIRA
against JBoss Developer Studio: <ulink
url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=1231050...
- </para>
- <para>
- When submitting a bug report, be sure to mention the manual's name and to select
the "documentation" component.
- </para>
- <para>
- If you have a suggestion for improving the documentation, try to be as specific as
possible when describing it. If you have found an error, please include the section number
and some of the surrounding text so we can find it easily.
- </para>
-</section>
+ </indexterm>
+ <para>
+ If you experience difficulty with a procedure described in this documentation, visit
the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />.
Through the customer portal, you can:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ search or browse through a knowledgebase of technical support articles about Red Hat
products.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ submit a support case to Red Hat Global Support Services (GSS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ access other product documentation.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ Red Hat also hosts a large number of electronic mailing lists for discussion of Red
Hat software and technology. You can find a list of publicly available mailing lists at
<ulink
url="https://www.redhat.com/mailman/listinfo" />. Click on the name
of any mailing list to subscribe to that list or to access the list archives.
+ </para>
+
+ </section>
+
+ <section id="jboss-feedback">
+ <title>Give us Feedback</title>
+ <!-- NOTE: You will need the following entities defined in your .ent file.
+ You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_
+ and _YOUR_SUMMARY_ - entities are not replaced in URLs.
+ <!ENTITY PRODUCT "JBoss Product Name">
+ <!ENTITY BZCOMPONENT "doc-triage">
+ <!ENTITY BZURL "<ulink
url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT...
+
+ These entities should not affect translated documents, since Bugzilla is not
localised.
+ --> <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+
+ </indexterm>
+ <para>
+ If you find a typographical error, or know how this guide can be improved, we would
love to hear from you. Submit a report in Bugzilla against the product
<literal>&BZPRODUCT;</literal> and the component
<literal>&BZCOMPONENT;</literal>. The following link will take you to a
pre-filled bug report for this product: &BZURL;.
+ </para>
+ <para>
+ Fill out the following template in Bugzilla's
<literal>Description</literal> field. Be as specific as possible when
describing the issue; this will help ensure that we can fix it quickly.
+ </para>
+
+<screen>Document URL:
+
+
+Section Number and Name:
+
+
+Describe the issue:
+
+
+Suggestions for improvement:
+
+
+Additional information:
+
+
+</screen>
+ <para>
+ Be sure to give us your name so that you can receive full credit for reporting the
issue.
+ </para>
+
+ </section>
+
+
+</appendix>
+
+
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Introduction.xml
===================================================================
--- branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Introduction.xml 2011-08-19
01:15:02 UTC (rev 34081)
+++ branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Introduction.xml 2011-08-19
01:23:24 UTC (rev 34082)
@@ -1,154 +1,154 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="Introduction">
- <?dbhtml filename="TargetAudience.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- <keyword>Target</keyword>
- <keyword>developers</keyword>
- <keyword>Audience</keyword>
- </keywordset>
- </chapterinfo>
- <title>Introduction</title>
- <para>All developers and process analysts who are beginning to use JBoss jBPM
should read this
- Getting Started guide. It will give them a jumpstart showing how to create a process
definition.</para>
- <section id="Preface">
- <?dbhtml filename="Preface.html"?>
- <title>Preface</title>
- <para>This document introduces the use of the JBoss jBPM Graphical Process
Designer (GPD) to
- create workflow processes. It will help first time users with the following tasks
:</para>
- <itemizedlist>
- <listitem>
- <para>Install the JBoss jBPM GPD Eclipse plugin available from the JBoss jBPM
download
- area</para>
- </listitem>
- <listitem>
- <para>Set up a Java project in Eclipse and prepare it to do test driven
process
- development</para>
- </listitem>
- <listitem>
- <para>Using the creation wizard to create an empty process
definition</para>
- </listitem>
- <listitem>
- <para>Use the designer palette to draw the first
processdefinition</para>
- </listitem>
- <listitem>
- <para>Show how the xml processdefinition can be inspected as an xml
file</para>
- </listitem>
- <listitem>
- <para>Set up a Java project in Eclipse and prepare it to do test driven
process
- development</para>
- </listitem>
- <listitem>
- <para>Write an example process test case</para>
- </listitem>
- </itemizedlist>
- <para>If you have any questions, please feel free to contact <ulink
url="mailto:koen.aers@jboss.com"
- >Koen Aers</ulink> or <ulink
url="mailto:tom.baeyens@jboss.com">Tom Baeyens</ulink> for more
- information.</para>
- </section>
+ <?dbhtml filename="TargetAudience.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ <keyword>Target</keyword>
+ <keyword>developers</keyword>
+ <keyword>Audience</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Introduction</title>
+ <para>
+ This guide demonstrates the use of JBoss jBPM in the creation of a process definition.
+ </para>
+ <section id="Preface">
+ <?dbhtml filename="Preface.html"?>
+ <title>Preface</title>
+ <para>
+ This document introduces the JBoss jBPM Graphical Process Designer (GPD), which is
used to create workflow processes. It will help first time users with the following
tasks:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>Installing the JBoss jBPM GPD Eclipse plugin, which is available from the
JBoss jBPM download area</para>
+ </listitem>
+ <listitem>
+ <para>Setting up a Java project in Eclipse and preparing it for test driven
process development</para>
+ </listitem>
+ <listitem>
+ <para>Using the creation wizard to create an empty process
definition</para>
+ </listitem>
+ <listitem>
+ <para>Using the designer palette to draw the first process
definition</para>
+ </listitem>
+ <listitem>
+ <para>Demonstrating how the XML process definition can be inspected as an XML
file</para>
+ </listitem>
+ <listitem>
+ <para>Writing an example process test case</para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ If you have any questions, please feel free to contact <ulink
url="mailto:koen.aers@jboss.com">Koen Aers</ulink> or <ulink
url="mailto:tom.baeyens@jboss.com">Tom Baeyens</ulink> for more
information.
+ </para>
+ </section>
- <section id="feature_list">
+ <section id="feature_list">
- <title>Feature list</title>
+ <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>
+ <para>
+ JBoss jBPM is a workflow that enables the creation and automation business processes.
The table below lists the main features of JBoss jBPM.
+ </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>
- <xref linkend="minimal_process_definition"/>
- </entry>
- <entry>Enables managing workflow processes as well as human tasks and
interactions between
- them. jPDL combines the best techniques both in Java and in declarative
process.</entry>
- </row>
+ <row>
+ <entry>
+ <xref linkend="minimal_process_definition"/>
+ </entry>
+ <entry>
+ Enables the management of workflow processes as well as human tasks and the
interactions between them. jPDL combines the best techniques both in Java and in
declarative processes.
+ </entry>
+ </row>
- <row>
- <entry>
- <xref linkend="GuidedTourJBossjBPMGPD"/>
- </entry>
- <entry>Is used for simplifying declarative process development and
visualizations of all
- actions.</entry>
- </row>
+ <row>
+ <entry>
+ <xref linkend="GuidedTourJBossjBPMGPD"/>
+ </entry>
+ <entry>Is used to simplify declarative process development and the
visualization of all actions.</entry>
+ </row>
- <row>
- <entry>
- <xref linkend="CreatingjBPMProject"/>
- </entry>
- <entry>Allows to create a new jBPM template project that already includes all
advanced
- artifacts and core jBPM libraries.</entry>
- </row>
+ <row>
+ <entry>
+ <xref linkend="CreatingjBPMProject"/>
+ </entry>
+ <entry>Allows the creation of a new jBPM template project that already
includes all the advanced artifacts and core jBPM libraries.</entry>
+ </row>
- <row>
- <entry>
- <xref linkend="minimal_process_definition"/>
- </entry>
- <entry>Provides process-building functionality and gives opportunity even
non-programmers to
- develop processes.</entry>
- </row>
+ <row>
+ <entry>
+ <xref linkend="minimal_process_definition"/>
+ </entry>
+ <entry>Provides process-building functionality and allows non-programmers to
develop processes.</entry>
+ </row>
- <row>
- <entry>
- <xref linkend="the_views"/>
- </entry>
- <entry></entry>
- </row>
+ <row>
+ <entry>
+ <xref linkend="the_views"/>
+ </entry>
+ <entry></entry>
+ </row>
- <row>
- <entry>
- <xref linkend="source_mode"/>
- </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>
+ <xref linkend="source_mode"/>
+ </entry>
+ <entry>
+ Shows the corresponding XML that is generated automatically in the Source view of
the process definition editor when developing the process.
+ </entry>
+ </row>
- <row>
- <entry>
- <xref linkend="the_properties_view"/>
- </entry>
- <entry>Facilitates configuring and editing of all nodes
properties.</entry>
- </row>
+ <row>
+ <entry>
+ <xref linkend="the_properties_view"/>
+ </entry>
+ <entry>Facilitates configuring and editing of all nodes
properties.</entry>
+ </row>
- <row>
- <entry>
- <xref linkend="jbpm_gpd_editor"/>
- </entry>
- <entry>The plugin is used for designing the workflow.</entry>
- </row>
-
+ <row>
+ <entry>
+ <xref linkend="jbpm_gpd_editor"/>
+ </entry>
+ <entry>The plugin is used for designing the workflow.</entry>
+ </row>
- <row>
- <entry>Interaction with all of the J2EE based integration technologies
including Web Services,
- Java Messaging, J2EE Connectors, JBDC, EJBs.</entry>
- <entry>Enables implementation, provides better functionality and
flexibility.</entry>
- </row>
- <row>
- <entry>Integration with jBoss Seam</entry>
- <entry>Allows to write applications with complex workflows and provides
easier interactions
- between them.</entry>
- </row>
+ <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>
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section>
- <title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools release documentation you can find
at<ulink
url="http://docs.jboss.org/tools/">http://docs.jboss.org/too...
in the corresponding release directory.</para>
- <para>There is some extra information on <ulink
url="http://www.jboss.org/community/wiki/JBPMWiki">JBoss Wiki.
</ulink></para>
- <para>The latest documentation builds are available at <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">htt...
- </section>
+ <row>
+ <entry>Integration with jBoss Seam</entry>
+ <entry>Allows applications to be written 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>
+ You can find JBoss Developer Studio and JBoss Tools release documentation at <ulink
url="http://docs.jboss.org/tools/">http://docs.jboss.org/too...
in the corresponding release directory.
+ </para>
+ <para>Additional information can be found in the <ulink
url="http://www.jboss.org/community/wiki/JBPMWiki">JBoss
Wiki</ulink>.</para>
+ <para>
+ The latest documentation builds are available at <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">htt...;.
+ </para>
+ </section>
+
</chapter>
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Preface.xml
===================================================================
--- branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Preface.xml 2011-08-19 01:15:02
UTC (rev 34081)
+++ branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Preface.xml 2011-08-19 01:23:24
UTC (rev 34082)
@@ -8,9 +8,5 @@
<para>
This manual uses several conventions to highlight certain words and phrases and draw
attention to specific pieces of information. To get more information on these conventions
please refer to the <guilabel>Document Conventions</guilabel> manual, which
can be found on the <ulink
url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index....
Hat Documentation</ulink> website under the <guilabel>JBoss Developer
Studio</guilabel> section.
</para>
- <!--<xi:include href="Common_Content/Conventions.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback
xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include
href="Common_Content/Feedback.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>-->
</preface>
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Revision_History.xml
===================================================================
--- branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Revision_History.xml 2011-08-19
01:15:02 UTC (rev 34081)
+++ branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/Revision_History.xml 2011-08-19
01:23:24 UTC (rev 34082)
@@ -2,31 +2,51 @@
<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>
<appendix>
- <title>Revision History</title>
- <simpara>
- <revhistory>
- <revision>
- <revnumber>1-0</revnumber><date>Wed Jun 09
2010</date>
- <author>
- <firstname>JBoss
Tools</firstname><surname>Documentation
Team</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>Restructured and general updates</member>
- </simplelist>
- </revdescription>
- </revision>
- <revision>
- <revnumber>0-0</revnumber><date>Fri Nov 20
2009</date>
- <author>
-
<firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>Initial creation of book by
publican</member>
- </simplelist>
- </revdescription>
- </revision>
- </revhistory>
- </simpara>
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>1-2</revnumber>
+ <date>Thu Jan 20 2011</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email>mcaspers(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>1-1</revnumber>
+ <date>Wed Jun 09 2010</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Restructured and general updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>1-0</revnumber>
+ <date>Fri Nov 20 2009</date>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
</appendix>
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_2.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_3.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_4.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_5.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_6.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_7.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_8.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_9.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_1.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_2.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_4.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_5.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_9.png
===================================================================
(Binary files differ)
Added:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/runtime_removal/runtime_removal_01.png
===================================================================
(Binary files differ)
Property changes on:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/runtime_removal/runtime_removal_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/the_views/jbpm_1.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/the_views/jbpm_2.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/the_views/jbpm_3.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/images/the_views/the_views_10.png
===================================================================
(Binary files differ)
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent
===================================================================
---
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent 2011-08-19
01:15:02 UTC (rev 34081)
+++
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent 2011-08-19
01:23:24 UTC (rev 34082)
@@ -1,4 +1,7 @@
<!ENTITY PRODUCT "JBoss">
<!ENTITY BOOKID "jBPM_Tools_Reference_Guide">
-<!ENTITY YEAR "2010">
+<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat">
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "jBPM Tools Reference Guide">
+<!ENTITY BZURL "<ulink
url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc...
Modified:
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml
===================================================================
---
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml 2011-08-19
01:15:02 UTC (rev 34081)
+++
branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml 2011-08-19
01:23:24 UTC (rev 34082)
@@ -13,5 +13,6 @@
<xi:include href="Quick_Howto_Guide.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> -->
<xi:include href="tasks.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="the_views.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
+<xi:include href="Feedback.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
</book>
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/master.xml
===================================================================
--- branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/master.xml 2011-08-19 01:15:02 UTC
(rev 34081)
+++ branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/master.xml 2011-08-19 01:23:24 UTC
(rev 34082)
@@ -65,12 +65,12 @@
</copyright>
<releaseinfo> Version: 4.3.0.trunk</releaseinfo>
-<abstract>
+<!--<abstract>
<title/>
<para>
<ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/jbpm/pdf/J...
version</ulink>
</para>
-</abstract>
+</abstract> -->
</bookinfo>
<toc/>
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/tasks.xml
===================================================================
--- branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/tasks.xml 2011-08-19 01:15:02 UTC
(rev 34081)
+++ branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/tasks.xml 2011-08-19 01:23:24 UTC
(rev 34082)
@@ -1,671 +1,561 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter>
- <?dbhtml filename="jboss_jbpm_runtime_installation.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- <keyword>designer</keyword>
- <keyword>process</keyword>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>jBPM runtime</keyword>
- <keyword>JBoss</keyword>
- <keyword>Process</keyword>
- <keyword>Definition</keyword>
- </keywordset>
+ <?dbhtml filename="jboss_jbpm_runtime_installation.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ <keyword>designer</keyword>
+ <keyword>process</keyword>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>jBPM runtime</keyword>
+ <keyword>JBoss</keyword>
+ <keyword>Process</keyword>
+ <keyword>Definition</keyword>
+ </keywordset>
- </chapterinfo>
- <title>Tasks</title>
-<section id="jboss_jbpm_runtime_installation">
+ </chapterinfo>
+ <title>Tasks</title>
+ <section id="jboss_jbpm_runtime_installation">
- <title>JBoss jBPM Runtime Installation</title>
- <para>The main purpose of this chapter is to let you know how to launch the
<property>JBoss
- jBPM</property> (business process management).</para>
- <para>The jBPM plugin (jBPM Designer) is already included into the
<property>JBoss Tools</property>.
- To make it work, you should only download the jBPM runtime (<ulink
-
url="http://sourceforge.net/project/showfiles.php?group_id=70542&...
- >jbpm-jpdl-3.2.3</ulink> currently) and specify the directory where
you extracted the runtime
- either when you create a jBPM project or by using the jBPM preference
pages.</para>
-
- <note>
- <title>Note:</title>
- <para>Try to avoid using spaces in the names of installation folders. It
can provoke problems in
- some situations with Sun-based VMs.</para>
- </note>
-
- <para>Navigate to <emphasis>
- <property>Window > Preferences > JBoss jBPM > Runtime
Locations</property>.
- </emphasis> Here you can add, edit and remove JBoss jBPM installation
locations. Click <emphasis>
- <property>Add</property>
- </emphasis> button. In the dialog that appeared enter a name for a newly added
jBPM runtime and
- point to the correct location of this package on your harddrive. Click
<emphasis>
- <property>OK</property>
- </emphasis> then click <emphasis>
- <property>OK</property>
- </emphasis> again.</para>
-
- <figure>
- <title>Adding jBPM Location</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtime_installation/runtime_installation_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Now, when you have a runtime installed, we are going to demonstrate some
powerful features of
- the jBPM.</para>
-</section>
- <section id="GuidedTourJBossjBPMGPD"
xreflabel="GuidedTourJBossjBPMGPD">
- <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?>
+ <title>JBoss jBPM Runtime Installation</title>
+ <para>This chapter describes how to execute <property>JBoss
jBPM</property> (business process management).</para>
+ <para>
+ The jBPM plugin (jBPM Designer) is already included in <property>JBoss
Tools</property>. To run it the jBPM runtime needs to be downloaded (<ulink
url="http://sourceforge.net/project/showfiles.php?group_id=70542&...
currently), and the directory where you extracted the runtime to needs to be specified,
either when you create a jBPM project or through the jBPM preference pages.
+ </para>
- <title>A Guided Tour of JBoss jBPM GPD</title>
- <para>In this chapter we suggest a step-by-step walk-through of creating
and configuring your
- own simple process. Let's try to organize a new jBPM
project.</para>
- <para>A wizard for creating a jBPM project is included in the GPD plugin.
We have opted to
- create a project based on a template already containing a number of advanced
artifacts that
- we will ignore for this section. In the future we will elaborate this wizard
and offer the
- possibility to create an empty jBPM project as well as projects based on
templates taken
- from the jBPM tutorial.</para>
- <section id="CreatingjBPMProject">
- <?dbhtml filename="CreatingjBPMProject.html"?>
- <title>Creating a jBPM Project</title>
- <para>This section will show you how to use the Creation wizard for
creating a new jBPM
- project with already included source folders.</para>
- <para>At first you should select <emphasis>
- <property>File >New Project...</property>
- </emphasis> and then <emphasis>
- <property>JBoss jBPM > Process Project</property>
- </emphasis> in the New Project dialog:</para>
- <figure>
- <title>New Project Dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Clicking <emphasis>
- <property>Next</property>
- </emphasis> brings us to the wizard page where it's necessary
to specify the
- name and location for the project. We choose, for example,
<emphasis>
- <property>HellojBPM</property>
- </emphasis> as the name and accept the default location.
</para>
- <figure>
- <title>Process Name and Location</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Thus, our project will be created in the workspace root directory
by default. If you
- want to change the directory for your future project, deselect
<emphasis>
- <property>Use default location</property>
- </emphasis> and click <emphasis>
- <property>Browse...</property>
- </emphasis> button to set needed location or simply type
it.</para>
- <para>On the next screen you'll be prompted to select the core
jBPM location that
- we have defined in the previous chapter.</para>
- <figure>
- <title>Core jBPM Location Specifying</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Clicking on <emphasis>
- <property>Finish</property>
- </emphasis> results in the project being generated. The wizard creates
four source
- folders: one for the processes (<emphasis>
- <property>src/main/jpdl</property>
- </emphasis>), one for the java sources (<emphasis>
- <property>src/main/java</property>
- </emphasis>), one for the unit tests (<emphasis>
- <property>src/test/java</property>
- </emphasis>) and one for the resources such as the jbpm.properties
and the
- hibernate.properties files (<emphasis>
- <property>src/main/config</property>
- </emphasis>). In addition a classpath container with all the core
jBPM libraries is
- added to the project</para>
- <figure>
- <title>Layout of the Process Project</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Looking inside the different source folders will reveal a number
of other artifacts
- that were generated, but we will leave these untouched for the moment.
Instead, we will
- look at another wizard that enables us to create an empty process
definition.</para>
- </section>
- <section id="creating_an_empty_process_definition">
- <?dbhtml
filename="creating_an_empty_process_definition.html"?>
- <title>Creating an Empty Process Definition</title>
- <para>Now when the project is set up, we can use a Creation wizard to
create an empty
- process definition. Bring up the <emphasis>
- <property>New</property>
- </emphasis> wizard by clicking the <emphasis>
- <property>File > New > Other...</property>
- </emphasis> menu item. The wizard opens on the <emphasis>
- <property>Select Wizard</property>
- </emphasis> page.</para>
- <figure>
- <title>The Select Wizard Page</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Selecting the <emphasis>
- <property>JBoss jBPM</property>
- </emphasis> category, then the <emphasis>
- <property>Process Definition</property>
- </emphasis> item and clicking on the <emphasis>
- <property>Next</property>
- </emphasis> button brings us to the <emphasis>
- <property>Create Process Definition</property>
- </emphasis> page.</para>
- <figure>
- <title>The Create New Process Defining Page</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>We choose <emphasis>
- <property>hello</property>
- </emphasis> as the name of the process archive file. Click on the
<emphasis>
- <property>Finish</property>
- </emphasis> button to end the wizard and open the process definition
editor.</para>
- <figure>
- <title>The Process Definition Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_6.png"
- scale="60"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>You can see in the Package Explorer that creating a process
definition involves
- creating a folder with the name of the process definition and populating
this folder
- with two .xml files : <emphasis>
- <property>gpd.xml</property>
- </emphasis> , <emphasis>
- <property>processdefinition.xml</property>
</emphasis> and a .jpg file:<emphasis>
-
<property>processimage.jpg</property></emphasis>.</para>
- <para>The <emphasis>
- <property>gpd.xml</property>
- </emphasis> contains the graphical information used by the process
definition editor.
- The <emphasis>
- <property>processdefinition.xml</property>
- </emphasis> file contains the actual process definition info.
- The graphical view of the process is automatically saved in
<emphasis>
- <property>processimage.jpg</property>
- </emphasis>file.
- At present, the GPD assumes that these three files are siblings. More
- sophisticated configuration will be supported later.</para>
-
- <section id="minimal_process_definition">
- <?dbhtml filename="minimal_process_definition.html"?>
- <title>A Minimal Process Definition</title>
- <para>Now we are ready to create a very simple process definition
consisting of a begin
- state, an intermediate state and an end state.</para>
- <para>To make the configuration of actions much easier
it's better to use the
- <emphasis>><property>"jBPM jPDL
3"</property></emphasis> perspective. It provides the tabbed Properties
Editor which allows to configure
- all the relevant properties of the current selected item.
</para>
-
- <section id="adding_the_nodes">
- <?dbhtml filename="adding_the_nodes.html"?>
- <title>Adding the Nodes</title>
- <para>At first select respectively <emphasis>
- <property>Start</property>, </emphasis>
- <emphasis>
- <property>State</property>
- </emphasis> and <emphasis>
- <property>End</property>
- </emphasis> on the tools palette and click on the canvas to
add these nodes to
- the process definition. The result should look similar to
this:</para>
- <figure>
- <title>A Simple Process With Three Nodes</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_7.png"
- scale="60"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="adding_transitions">
- <?dbhtml filename="adding_transitions.html"?>
- <title>Adding Transitions</title>
- <para>Then, we will connect the nodes with transitions. To do
that select the <emphasis>
- <property>Transition</property>
- </emphasis> tool in the tools palette and click on the
<emphasis>
- <property>Start</property>
- </emphasis> node, then move to the <emphasis>
- <property>State</property>
- </emphasis> node and click again to see the transition being
drawn. Perform the
- same steps to create a transition from the <emphasis>
- <property>State</property>
- </emphasis> node to the <emphasis>
- <property>End</property>
- </emphasis> node. The result will look like:</para>
- <figure>
- <title>A Simple Process With Transitions</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_8.png"
- scale="60"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Now, when you've got background knowledge of
simple project creation,
- let's move to more advanced tools.</para>
- </section>
- </section>
- </section>
- </section>
- <section id="The_JBoss_jBPM_Int_Mech"
xreflabel="The_JBoss_jBPM_Int_Mech">
- <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?>
+ <note>
+ <title>Note:</title>
+ <para>Try to avoid using spaces in the names of installation folders. It can
cause problems with Sun based VMs.</para>
+ </note>
- <title>Actions : The JBoss jBPM Integration Mechanism</title>
+ <para>
+ Select
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss
jBPM</guimenuitem><guimenuitem>Runtime
Locations</guimenuitem></menuchoice>. Here you can add, edit and remove JBoss
jBPM installation locations. Click the <guibutton>Add</guibutton> button. In
the subsequent dialog box enter a name for a newly added jBPM runtime and point to the
correct location of this package on your file system. Click the
<guibutton>OK</guibutton> button twice to save the changes.
+ </para>
+ <figure>
+ <title>Adding jBPM Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtime_installation/runtime_installation_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Now that a runtime has been installed, some of the powerful features of the
jBPM can be demonstrated.</para>
+ </section>
+ <section id="GuidedTourJBossjBPMGPD"
xreflabel="GuidedTourJBossjBPMGPD">
+ <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?>
+
+ <title>A Guided Tour of JBoss jBPM GPD</title>
+ <para>
+ This chapter will present a step-by-step walk-through demonstrating how to create and
configure a simple process. First, 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 to create a new
jBPM project that includes the required source folders.</para>
+ <para>
+ At first you should select
<menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New
Project...</guimenuitem></menuchoice> and then
<menuchoice><guimenuitem>JBoss
jBPM</guimenuitem><guimenuitem>Process
Project</guimenuitem></menuchoice> in the New Project dialog:
+ </para>
+ <figure>
+ <title>New Project Dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Clicking the <guibutton>Next</guibutton> button brings us to the wizard
page where the name and location for the project are specified. We choose, for example,
<emphasis><property>HellojBPM</property></emphasis> as the name
and accept the default location.
+ </para>
+ <figure>
+ <title>Process Name and Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The project will be created in the workspace root directory by default. If you want
to change the directory for your future project, deselect
<emphasis><property>Use default location</property></emphasis> and
click the <guibutton>Browse...</guibutton> button to set desired location, or
simply enter the location manually.
+ </para>
+ <para>On the next screen you will be prompted to select the core jBPM location
that we have defined in the previous chapter.</para>
+ <figure>
+ <title>Core jBPM Location Specifying</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Clicking on the <guibutton>Finish</guibutton> button results in the
project being generated. The wizard creates four source folders: one for the processes
(<filename>src/main/jpdl</filename>), one for the java sources
(<filename>src/main/java</filename>), one for the unit tests
(<filename>src/test/java</filename>) and one for the resources such as the
<filename>jbpm.properties</filename> and the
<filename>hibernate.properties</filename> files
(<filename>src/main/config</filename>). In addition a classpath container with
all the core jBPM libraries is added to the project
+ </para>
+ <figure>
+ <title>Layout of the Process Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="creating_an_empty_process_definition">
+ <?dbhtml filename="creating_an_empty_process_definition.html"?>
+ <title>Creating an Empty Process Definition</title>
+ <para>
+ Now when the project is set up, we can use a Creation wizard to create an empty
process definition. Bring up the
<emphasis><property>New</property></emphasis> wizard by selecting
<menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other...</guimenuitem></menuchoice>.
The wizard opens on the <emphasis><property>Select
Wizard</property></emphasis> page.
+ </para>
+ <figure>
+ <title>The Select Wizard Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Selecting the <emphasis><property>JBoss
jBPM</property></emphasis> category, then the
<emphasis><property>jBPM Process Definition</property></emphasis>
item and clicking on the <guibutton>Next</guibutton> button brings us to the
<emphasis><property>Create Process
Definition</property></emphasis> page.
+ </para>
+ <figure>
+ <title>The Create New Process Defining Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ We choose <emphasis><property>hello</property></emphasis> as
the name of the process archive file. Click on the
<guibutton>Finish</guibutton> button to end the wizard and open the process
definition editor.
+ </para>
+ <figure>
+ <title>The Process Definition Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_6.png"
scale="60"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para> In this chapter we will show how to do software integration with
<property>JBoss
- jBPM</property>. The standard mechanism to implement this is to wrap
the functionality you
- want to integrate in a class that implements the <emphasis>
- <property>ActionHandler</property>
- </emphasis> interface. In order to demonstrate it let's specify
Hello World action for our
- process.</para>
-
- <section>
- <title>Creating a Hello World Action</title>
+ <para>
+ You can see in the Package Explorer that creating a process definition involves
creating an XML file called <filename>[process name].jpdl.xml</filename>,
which contains the process definition information. A JPG file called
<filename>[process name].jpg</filename> will also be automatically generated
when changes are saved to the process.
+ </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>
+ The <guilabel>jBPM jPDL 3</guilabel> perspective should be used to aid
in the configuration of the actions. It provides the tabbed <guilabel>Properties
Editor</guilabel> view which provides a way 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>
+ Add the <emphasis><property>Start</property>,
</emphasis><emphasis><property>State</property></emphasis>
and <emphasis><property>End</property></emphasis> nodes to the
process definition by selecting the appropriate option from the tools palette and clicking
on the canvas. The result should look similar to this:
+ </para>
+ <figure>
+ <title>A Simple Process With Three Nodes</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_7.png"
scale="60"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="adding_transitions">
+ <?dbhtml filename="adding_transitions.html"?>
+ <title>Adding Transitions</title>
+ <para>
+ The nodes then need to be connected with transitions. To do that select the
<emphasis><property>Transition</property></emphasis> tool in the
tools palette and click on the
<emphasis><property>Start</property></emphasis> node, then move to
the <emphasis><property>State</property></emphasis> node and click
again to see the transition being drawn. Perform the same steps to create a transition
from the <emphasis><property>State</property></emphasis> node to
the <emphasis><property>End</property></emphasis> node. The result
will look like:
+ </para>
+ <figure>
+ <title>A Simple Process With Transitions</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_8.png"
scale="60"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Now, when you've got background knowledge of simple project
creation,
+ let's move to more advanced tools.</para>
+ </section>
+ </section>
+ </section>
+ </section>
+ <section id="The_JBoss_jBPM_Int_Mech"
xreflabel="The_JBoss_jBPM_Int_Mech">
+ <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?>
+
+ <title>Actions : The JBoss jBPM Integration Mechanism</title>
+
+ <para>
+ This chapter will demonstrate how to integrate with <property>JBoss
jBPM</property>. The standard mechanism to implement this is to wrap the
functionality you want to integrate in a class that implements the
<emphasis><property>ActionHandler</property></emphasis> interface.
In order to demonstrate it let's specify a simple Hello World action for our
process.
+ </para>
+
+ <section>
+ <title>Creating a Hello World Action</title>
+
+ <para>
+ Each Hello World process should integrate one or more Hello World actions, so this is
what we will be doing. We can integrate custom code at different points in the process
definition. To do this we have to specify an action handler, represented by an
implementation of the
<emphasis><property>ActionHandler</property></emphasis> interface,
and attach this piece of code to a particular event. These events are amongst others,
going over a transition, leaving or entering nodes, after and before signaling.
+ </para>
+
+ <para>
+ To make things a little bit more concrete, let's create a new class called
<emphasis><property>HelloActionHandler</property></emphasis>. For
that firstly we will create a new package <code>com.jbay.action</code> in the
<filename>src/main/java</filename> folder of our project. Then, we should call
New Class Creation wizard as usual selecting
<menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Class</guimenuitem></menuchoice>
from the context menu.
+ </para>
+
+ <figure>
+ <title>Creating HelloActionHendler Class</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Notice that two first gaps have been filled automatically. Here, instead of the
<emphasis><property>Package</property></emphasis> option, the
<emphasis><property>Enclose type</property></emphasis> option can
be selected to define the type in which the new class should be created will be enclosed.
+ </para>
+
+ <para>
+ In our case, we leave everything as it is, just type
<code>HelloActionHandler</code> as a name of new class and add
<code>org.jbpm.graph.ActionHendler</code> interface as it is shown in the
picture above.
+ </para>
+
+ <para>
+ Thus, our <code>HelloActionHandler</code> implements the
<code>ActionHandler</code> interface, including the
<code>execute</code> method as shown in the next figure. Here, we add a
variable named <code>greeting</code> to the collection of process variables
and put a message in it: <code>"Hello from
ActionHandler"</code>.
+ </para>
+
+ <figure>
+ <title>A Simple Hello Action</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png"
scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Now, as we have <code>HelloActionHandler</code> 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 required to
associate our Hello World action with a particular event and test the validity of our
actions as well.
+ </para>
+
+ <para>
+ In order to validate our code we will first create a Unit Test that proves the
behavior we want to achieve by adding the <code>ActionHandler</code> to the
process. So we implement another test.
+ </para>
+
+ <para>
+ First we need to create a new Junit Test Case by selecting
<menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JUnit</guimenuitem><guimenuitem>Junit
Test Case</guimenuitem></menuchoice>. Give it a name of
<code>HelloTest</code>, place it in the <code>com.jbay</code>
package, and click the <guibutton>Finish</guibutton> button.
+ </para>
+
+ <figure>
+ <title>Create the Hello Action Test</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/NewJUnitTestCase.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Populate the new class with the following code:
+<programlisting>package com.jbay;
+
+import org.jbpm.graph.def.ProcessDefinition;
+import org.jbpm.graph.exe.ProcessInstance;
+
+import junit.framework.TestCase;
+
+public class HelloTest extends TestCase
+{
+ public void testActionhandler() throws Exception {
+
+ ProcessDefinition definition =
+ ProcessDefinition.parseXmlResource("hello.jpdl.xml");
+
+ ProcessInstance instance = new ProcessInstance(definition);
+ assertNull("The greeting variable should not exist",
+ instance.getContextInstance().getVariable("greeting"));
+
+ instance.signal();
+ assertEquals("The greeting variable is created",
+ instance.getContextInstance().getVariable("greeting"),
+ "Hello from ActionHandler");
+ }
+}
+</programlisting>
+ </para>
+
+ <figure>
+ <title>Create the Hello Action Test</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png"
scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ We assert that no variable called <code>greeting</code> exist. Then we
give the process a signal to move it to the action state. We want to associate the
execution of the action with the event of going over the transition from the start state
to the action state. So after the signal, the process should be in the action state as in
the previous scenario. But moreover, the <code>greeting</code> variable should
exist and contain the string <code>"Hello from
ActionHandler"</code>. That is what we assert in the last lines of the test
method.
+ </para>
+
+ <para>
+ Running the tests now results in a failure. The point is that we did not associate
the action with any particular event in the process definition, so the process variable
did not get set.
+ </para>
+
+ <figure>
+ <title>Test Results Before Integration</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png"
scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Let's do something about it and add an action to the first transition of our
sample process. To do this you can use the Actions tab in the Properties Editor that is
under the graphical canvas. Bring up the popup menu of the action element container and
chose New Action as it's shown on the figure below. The other way to add an action to
the transition is simply to use the dropdown menu that is available under the action icon
in the right upper corner of the Properties View.
+ </para>
+
+ <figure>
+ <title>Adding an Action to a Transition</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After adding the action a tabbed view with three pages will
appear.</para>
+
+ <figure>
+ <title>Configuration Dialog for an Action</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The first of these three pages allows you to give the Action a name. The last page
contains some advanced attributes such as whether the Action is asynchronous. The Details
page is the most important. It allows to choose and configure the actual action handler
implementation.
+ </para>
+
+ <figure>
+ <title>The Details page of an Action Configuration Dialog</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>Each Hello World process should integrate one or more Hello World
actions, so this is
- what we will be doing. We can integrate custom code at different points
in the process
- definition. To do this we have to specify an action handler, represented
by an
- implementation of the <emphasis>
- <property>ActionHandler</property>
- </emphasis> interface, and attach this piece of code to a
particular event. These events
- are amongst others, going over a transition, leaving or entering nodes,
after and before
- signalling. </para>
+
+ <para>Clicking on the <guibutton>Search...</guibutton> button brings
us to a Choose Class dialog.</para>
- <para> To make things a little bit more concrete, let's create
a new class called <emphasis>
- <property>HelloActionHandler</property>.
- </emphasis> For that firstly we'll create a new package
<emphasis>
- <property>com.jbay.action</property>
- </emphasis> in the <emphasis>
- <property>src/java/main</property>
- </emphasis> folder of our project. Then, we should call New Class
Creation wizard as
- usual by right-clicking and navigating <emphasis>
- <property>New > Class</property>.
- </emphasis> </para>
+
+ <figure>
+ <title>The Choose Action Handler Dialog</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Creating HelloActionHendler Class</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+
+ <para>
+ We choose our previously created <code>HelloActionHandler</code> class
and click the <guibutton>OK</guibutton> button. After selecting the action
handler for the action, we can run the test and observe it gives us a green light.
+ </para>
+
+ <figure>
+ <title>Test Results</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png"
scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>There we are. The above objective has been achieved.</para>
+ </section>
+
+ <section>
+ <title> Integration Points</title>
+
+ <para>
+ The different integration points in a process definition are thoroughly documented in
the <ulink
url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User
Guide</ulink>. Instance nodes can contain many action elements. Each of these will
appear in the Action element list of the Actions tab. But each Action also has a
properties view of itself. You can navigate to this view by selecting the added Action in
the outline view.
+ </para>
+
+ </section>
+ </section>
+ <section id="Quick_Howto_Guide"
xreflabel="Quick_Howto_Guide">
+ <?dbhtml filename="Quick_Howto_Guide.html"?>
+
+ <title>Quick Howto Guide</title>
+
+ <para>This chapter contains additional information related to the
<property>JBoss jBPM</property>.</para>
+
+ <section id="change_core_jbpm_inst">
+ <title>Change the Default Core jBPM Installation</title>
+
+ <para>
+ You can change the default <property>jBPM</property> installation by
means of the Eclipse preference mechanism. Open the Preferences dialog by selecting
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice>
and select the <menuchoice><guimenuitem>JBoss
jBPM</guimenuitem><guimenuitem>Runtime
Location</guimenuitem></menuchoice> category. Using this page you can add
multiple <property>jBPM</property> installation locations and change the
default one. The default installation is used for the classpath settings when creating a
new Process Project. Changing the preferences has no influence on already created
projects. Getting rid of a <property>jBPM</property> installation that is
being referenced by a project however will cause the classpath to contain errors.
+ </para>
- <para>Notice that two first gaps have been filled automatically. Here,
instead of <emphasis>
- <property>Package</property>
- </emphasis> option <emphasis>
- <property>Enclose type</property>
- </emphasis> option can be selected where a type in which to enclose a
new class should
- be specified.</para>
-
- <para>In our case, we leave everything as it is, just type
<emphasis>
- <property>HelloActionHandler</property>
- </emphasis> as a name of new class and add <emphasis>
- <property>org.jbpm.graph.ActionHendler</property>
- </emphasis> interface as it's shown in the picture
above.</para>
-
- <para>Thus, our <emphasis>
- <property>HelloActionHandler</property>
- </emphasis> implements the <emphasis>
- <property>ActionHandler</property>
- </emphasis> interface including the <emphasis>
- <property>execute</property>
- </emphasis> method as shown in the next figure. Here, we add a variable
named <emphasis>
- <property>greeting</property>
- </emphasis> to the collection of process variables and put a
message in it :
- <emphasis>"Hello from
ActionHandler"</emphasis>. </para>
-
- <figure>
- <title>A Simple Hello Action</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png"
scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Now, as we have <emphasis>
- <property>HelloActionHandler</property>
- </emphasis> class defined, let's explore how we can handle
it.</para>
- </section>
-
- <section>
- <title>Integrating the Hello World Action</title>
-
- <para>The main purpose of this chapter is to provide you with the steps
associating our
- Hello World action with a particular event and test the correctness of
our actions as
- well.</para>
-
- <para> As good Testcity citizens we will first create a Unit Test that
proves the behaviour
- we want to achieve by adding the <emphasis>
- <property>ActionHandler</property>
- </emphasis> to the process. So we implement another
test.</para>
-
- <para>At first, let's return to the
- code we already saw <!--<xref
linkend="hello_test">-->in the previous chapter and add new test method
<emphasis>
- <property>testActionHendler</property></emphasis>
to it. </para>
-
- <figure>
- <title>Create the Hello Action Test</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>We assert
- that no variable called <emphasis>
- <property>greeting</property>
- </emphasis> exist. Then we give the process a signal to move it to
the auction state. We
- want to associate the execution of the action with the event of going
over the
- transition from the start state to the auction state. So after the
signal, the process
- should be in the auction state as in the previous scenario. But moreover,
the <emphasis>
- <property>greeting</property>
- </emphasis> variable should exist and contain the string
<emphasis>"Hello from
- ActionHandler"</emphasis>. That's what we
assert in the last lines of the test
- method.</para>
-
-
-
- <para> Running the tests now results in a failure. The point is that we
did not associate
- the action with any particular event in the process definition, so the
process variable
- did not get set. </para>
-
- <figure>
- <title>Test Results Before Integration</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Let's do something about it and add an action to the
first transition of our
- sample process. To do this you can use the Actions tab in the Properties
Editor that is
- under the graphical canvas. Bring up the popup menu of the action element
container and
- chose New Action as it's shown on the figure below. The other way to
add an action
- to the transition is simply to use the dropdown menu that is available
under the action
- icon in the right upper corner of the Properties View.</para>
-
- <figure>
- <title>Adding an Action to a Transition</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png"
scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After adding the action a tabbed view with three pages will
appear.</para>
-
- <figure>
- <title>Configuration Dialog for an Action</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png"
scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The first of these three pages allows you to give the Action a
name. The last page
- contains some advanced attributes such as whether the Action is
asynchronous. The
- Details page is the most important. It allows to choose and configure the
actual action
- handler implementation. </para>
-
- <figure>
- <title>The Details page of an Action Configuration
Dialog</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png"
scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>Clicking on the <emphasis>
- <property>Search...</property>
- </emphasis> button brings us to a Choose Class dialog.</para>
-
-
- <figure>
- <title>The Choose Action Handler Dialog</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para> We choose our previously created
'HelloActionHandler' class and
- push the <property>OK</property> button. After the selection
of the action handler for
- the action, we can run the test and observe it gives us a green
light.</para>
-
- <figure>
- <title>Test Results</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png"
- scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>There we are. The above objective has been
achieved.</para>
- </section>
-
- <section>
- <title> Integration Points</title>
-
- <para> The different integration points in a process definition are
thoroughly documented in
- the <ulink
-
url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss
jBPM User Guide</ulink>. Instance nodes can contain many action
- elements. Each of these will appear in the Action element list of the
Actions tab. But
- each Action also has a properties view of itself. You can navigate to
this view by
- selecting the added Action in the outline view. </para>
-
- </section>
- </section>
- <section id="Quick_Howto_Guide"
xreflabel="Quick_Howto_Guide">
- <?dbhtml filename="Quick_Howto_Guide.html"?>
-
- <title>Quick Howto Guide</title>
-
- <para>This chapter contains additional information related to the
<property>JBoss
- jBPM</property>.</para>
-
- <section id="change_core_jbpm_inst">
- <title>Change the Default Core jBPM Installation</title>
-
- <para> You can change the default <property>jBPM</property>
installation by means of the
- Eclipse preference mechanism. Open the Preferences dialog by selecting
<emphasis>
- <property>Window > Preferences</property>
- </emphasis> and select the <emphasis>
- <property>JBoss jBPM > Runtime
Location</property>
- </emphasis> category. Using this page you can add multiple
<property>jBPM</property>
- installation locations and change the default one. The default
installation is used for
- the classpath settings when creating a new Process Project. Changing the
preferences has
- no influence on already created projects. Getting rid of a
<property>jBPM</property>
- installation that's being referenced by a project however will
cause the
- classpath to contain errors. </para>
-
-
- <figure>
- <title>The jBPM Preferences Page</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section>
- <title>Configuring Task Nodes</title>
-
- <para>Here, we'll examine how you can configure the Task nodes
in jBPM jPDL GPD.</para>
-
- <para> You can add Tasks to Task nodes and then configure them in a
similar manner as the
- Action configuration mechanism. Let's consider the process
definition similar
- to the previous one that contains three nodes: Start state, Task node and
End state. The
- <property>Properties view</property> for selected Task node
includes several tabs. </para>
-
- <figure>
- <title>The Properties View of the selected Task Node</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>We should choose the Task tab and then bring up the context menu
or click the button
- in the top right corner of the view to add a Task to our Task
node.</para>
-
- <figure>
- <title>Adding a Task to the Task Node</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png"
- scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Every added Task has its own configuration possibilities. You can
access them through
- the <property>Properties view</property> as
well.</para>
-
- <figure>
- <title>The Task properties</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png"
- scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The <property>General page</property> is a place
where you can specify the name of a
- Task and its description. For instance, let it be <emphasis>
- <property>approve oder</property>
- </emphasis> with appropriate description that you can see in the
figure below.</para>
-
- <figure>
- <title>The Task General Page</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png"
- scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Now, look at <property>Details page</property>.
First, you should specify the due date
- that is a mandatory property for the Task. The due date is the date on
which the task
- should be accomplished. Here you can also set a Task priority as well as
signalling,
- notifying or blocking. The <emphasis>
- <property>Blocking</property>
- </emphasis> attribute indicates that the process will not be able
to continue if this
- task is still unaccomplished. The <emphasis>
- <property>Generate Form...</property>
- </emphasis> button is for creating a simple task form that can be
rendered by the jBPM
- console.</para>
-
- <figure>
- <title>The Task Details Page</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png"
- scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>For our example, we specify the due date as 2 business days,
choose the high priority
- and also check the <emphasis>
- <property>Signalling</property>
- </emphasis> and <emphasis>
- <property>Notify</property>
- </emphasis> attributes. It means that the Task should be
accomplished in 2 business days
- and the assignee will be notified by email when the task is assigned. To
specify how the
- Task should be assigned switch on to the <property>Assignment
page</property>.</para>
-
- <figure>
- <title>The Task Assignment Page</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png"
- scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the <property>Reminder page</property> you can
specify whether the assignee will be reminded of the task
- that awaits him.</para>
-
- <figure>
- <title>The Task Reminder Page</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png"
- scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In our case, the assignee will be reminded by email after two
business hours and
- continue to get reminding every business hour after that.</para>
- <para>In the next figure you can see our configuring generated into
XML.</para>
- <figure>
- <title>The Task Reminder Page</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png"
- scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>We hope, our guide will help you to get started with the jPDL
process language and jBPM
- workflow on the whole. Besides, for additional information you are
welcome on <ulink
-
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
forum</ulink>.</para>
- </section>
- </section>
-
+
+ <figure>
+ <title>The jBPM Preferences Page</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section>
+ <title>Configuring Task Nodes</title>
+
+ <para>Here, we'll examine how you can configure the Task nodes in jBPM
jPDL GPD.</para>
+
+ <para>
+ You can add Tasks to Task nodes and then configure them in a similar manner Actions
are configured. Let's consider the process definition similar to the previous one
that contains three nodes: Start state, Task node and End state. The
<property>Properties view</property> for the selected Task node includes
several tabs.
+ </para>
+
+ <figure>
+ <title>The Properties View of the selected Task Node</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png"
scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ We should choose the Task tab and then bring up the context menu or click the button
in the top right corner of the view to add a Task to our Task node.
+ </para>
+
+ <figure>
+ <title>Adding a Task to the Task Node</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Every added Task has its own configuration possibilities. You can access
them through the <property>Properties view</property> as well.</para>
+
+ <figure>
+ <title>The Task properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The <property>General page</property> is a place where you can specify
the name of a Task and its description. For instance, let it be
<emphasis><property>approve oder</property></emphasis> with
appropriate description that you can see in the figure below.
+ </para>
+
+ <figure>
+ <title>The Task General Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Now, look at <property>Details page</property>. First, you should specify
the due date that is a mandatory property for the Task. The due date is the date on which
the task should be accomplished. Here you can also set a Task priority as well as
signaling, notifying or blocking. The
<emphasis><property>Blocking</property></emphasis> attribute
indicates that the process will not be able to continue if this task is still
unaccomplished. The <guibutton>Generate Form...</guibutton> button is for
creating a simple task form that can be rendered by the jBPM console.
+ </para>
+
+ <figure>
+ <title>The Task Details Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ For our example, we specify the due date as 2 business days, choose the high priority
and also check the
<emphasis><property>Signaling</property></emphasis> and
<emphasis><property>Notify</property></emphasis> attributes. It
means that the Task should be accomplished in 2 business days and the assignee will be
notified by email when the task is assigned. To specify how the Task should be assigned
switch on to the <property>Assignment page</property>.
+ </para>
+
+ <figure>
+ <title>The Task Assignment Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the <property>Reminder page</property> you can specify
whether the assignee will be reminded of the task that awaits him.</para>
+
+ <figure>
+ <title>The Task Reminder Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In our case, the assignee will be reminded by email after two business
hours and continue to get reminding every business hour after that.</para>
+ <para>In the next figure you can see our configuring generated into
XML.</para>
+ <figure>
+ <title>The Task Reminder Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ We hope, our guide will help you to get started with the jPDL process language and
jBPM workflow on the whole. Besides, for additional information you are welcome on
<ulink
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
forum</ulink>.
+ </para>
+ </section>
+ </section>
+ <section>
+ <title>JBoss jBPM Runtime Removal</title>
+ <para>
+ To remove a jBPM runtime select
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss
jBPM</guimenuitem><guimenuitem>Runtime
Locations</guimenuitem></menuchoice>. From here, select the jBPM runtime you
wish to remove and then click the <guibutton>Remove</guibutton> button.
+ </para>
+ <para>
+ Once jBPM runtimes have been installed, one runtime must always remain. Due to this
design, if you only have one jBPM runtime remaining you will not be able to remove it and
the <guibutton>Remove</guibutton> will be greyed out.
+ </para>
+ <note>
+ <para>
+ You may choose any jBPM runtime to be the last remaining, the only requirement is
that there must be one.
+ </para>
+ </note>
+ <figure>
+ <title>Remove button greyed out</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/runtime_removal/runtime_removal_01.png"
/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/the_views.xml
===================================================================
--- branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/the_views.xml 2011-08-19 01:15:02
UTC (rev 34081)
+++ branches/jbosstools-3.2.x/jbpm/docs/reference/en-US/the_views.xml 2011-08-19 01:23:24
UTC (rev 34082)
@@ -1,385 +1,374 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="reference">
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- </keywordset>
- </chapterinfo>
- <title>Reference</title>
- <section>
- <title>Wizards</title>
- <section>
- <title>Process Project Wizard</title>
- <para>This wizard helps to create new jBPM project.It is available with
clicking
- <property>File->New->Other->jBPM 3 Project</property>
in the menu bar.</para>
- <figure>
- <title>New Process Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/jbpm_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>It consists of several pages:</para>
- <itemizedlist>
- <listitem><para>On the first page you can adjust the name of
the project and the directory where it will be created.</para>
- <para>If "<property>Use
default</property>" option is checked the output directory will be the
workspace,
- othervise the user should specify it by himself using
<property>Browse</property> button.</para>
- <figure>
- <title>New Process Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/jbpm_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem><para>On the second page you should point the
location of your jbpm runtime.</para></listitem>
- <listitem><para>The last page is only available for
unabling/disabling
- <emphasis>Generate simple process definition,action handling and
Unit test</emphasis>.If you unable the option all the mentioned code will be
generated automatically.</para></listitem>
- </itemizedlist>
-
- </section>
- <section>
- <title>New JBPM Action Wizard</title>
- <para>This wizard is available by clicking
- <property>File->New->Other->jBPM 3 Action
Handler</property>.</para>
-
- <figure>
- <title>New JBPM Action Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/jbpm_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>It includes the next options to adjust:</para>
-
- <table>
- <title>New JBPM Action Wizard. Options.</title>
- <tgroup cols="3">
- <colspec colnum="1" align="left"
colwidth="1*"/>
- <colspec colnum="2" colwidth="3*"/>
- <colspec colnum="3" align="left"
colwidth="1*"/>
-
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Description</entry>
- <entry>Default</entry>
- </row>
- </thead>
- <tbody>
-
- <row>
- <entry>Source folder</entry>
- <entry>The path to the source folder relative to the
selected project</entry>
- <entry>The source folder of the project selected in the
<emphasis><property>Project</property></emphasis>
field</entry>
- </row>
-
- <row>
- <entry>Package</entry>
- <entry>Enter a package to contain an Action Handler.
- Either type a valid package name or click
-
<emphasis><property>Browse</property></emphasis>
- to select a package via the dialog box.</entry>
- <entry><blank></entry>
- </row>
-
- <row>
- <entry>Enclosing type</entry>
- <entry>Select the enclosing type of your jBPM action
using
-
<emphasis><property>Browse</property></emphasis>
- button.</entry>
- <entry><blank></entry>
- </row>
- <row>
- <entry>Modifiers</entry>
- <entry>Select the modifiers that will be added to the
generated class.</entry>
- <entry>Public</entry>
- </row>
- <row>
- <entry>Name</entry>
- <entry>Type a name for a new Action
Handler</entry>
- <entry><blank></entry>
- </row>
-
- <row>
- <entry>Superclass</entry>
- <entry>Type or click
<emphasis><property>Browse</property></emphasis>
- to select a superclass for an Action
Handler</entry>
- <entry>org.jbpm.graph.def.ActionHandler</entry>
- </row>
-
- <row>
- <entry>Interface</entry>
- <entry>Type or click
<emphasis><property>Add</property></emphasis>
- to select an interface/interfaces for an Action
Handler</entry>
- <entry>org.jbpm.graph.def.ActionHandler</entry>
- </row>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Reference</title>
+ <section>
+ <title>Wizards</title>
+ <section>
+ <title>Process Project Wizard</title>
+ <para>
+ This wizard is used to create new jBPM project. It is available by selecting
<menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>jBPM
3 Project</guimenuitem></menuchoice>.
+ </para>
+ <figure>
+ <title>New Process Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/jbpm_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>It consists of several pages:</para>
+ <itemizedlist>
+ <listitem>
+ <para>On the first page you can adjust the name of the project and the
directory where it will be created.</para>
+ <para>
+ If the <guilabel>Use default</guilabel> option is checked the output
directory will be the workspace, otherwise the user should specify the location by
clicking the <guibutton>Browse</guibutton> button.
+ </para>
+ <figure>
+ <title>New Process Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/jbpm_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>On the second page you should point the location of your jbpm
runtime.</para>
+ </listitem>
+ <listitem>
+ <para>
+ The last page is only available for enabling and disabling <emphasis>Generate
simple process definition,action handling and Unit test</emphasis>. If you enable
the option all the mentioned code will be generated automatically.
+ </para>
+ </listitem>
+ </itemizedlist>
- <row>
- <entry>Which method stubs you would like to
create?</entry>
- <entry>Select the stubs that you would like to be
created automatically.</entry>
- <entry><itemizedlist>
- <listitem><para>Constructors from
superclass</para></listitem>
- <listitem><para>Inherited abstract
methods</para></listitem>
- </itemizedlist>
- </entry>
- </row>
-
- <row>
- <entry>Do you want to add comments?</entry>
- <entry>Select <property>Generate
comments</property> check box if you want comment mask
- to be generated before the class definition.
- </entry>
- <entry><blank></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
+ </section>
+ <section>
+ <title>New JBPM Action Wizard</title>
+ <para>
+ This wizard is available by selecting
<menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>jBPM
3 Action Handler</guimenuitem></menuchoice>.
+ </para>
+
+ <figure>
+ <title>New JBPM Action Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/jbpm_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>It includes the next options to adjust:</para>
+
+ <table>
+ <title>New JBPM Action Wizard. Options.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left"
colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+ <colspec colnum="3" align="left"
colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+
+ <row>
+ <entry>Source folder</entry>
+ <entry>The path to the source folder relative to the selected
project</entry>
+ <entry>The source folder of the project selected in the
<emphasis><property>Project</property>
+ </emphasis> field</entry>
+ </row>
+
+ <row>
+ <entry>Package</entry>
+ <entry>
+ Enter a package to contain an Action Handler. Either type a valid package name or
click the <guibutton>Browse</guibutton> to select a package via the dialog
box.
+ </entry>
+ <entry><blank></entry>
+ </row>
+
+ <row>
+ <entry>Enclosing type</entry>
+ <entry>Select the enclosing type of your jBPM action click the
<guibutton>Browse</guibutton> button.</entry>
+ <entry><blank></entry>
+ </row>
+ <row>
+ <entry>Modifiers</entry>
+ <entry>Select the modifiers that will be added to the generated
class.</entry>
+ <entry>Public</entry>
+ </row>
+ <row>
+ <entry>Name</entry>
+ <entry>Type a name for a new Action Handler</entry>
+ <entry><blank></entry>
+ </row>
+
+ <row>
+ <entry>Superclass</entry>
+ <entry>Type or click the <guibutton>Browse</guibutton> button to
select a superclass for an Action Handler</entry>
+ <entry>org.jbpm.graph.def.ActionHandler</entry>
+ </row>
+
+ <row>
+ <entry>Interface</entry>
+ <entry>Type or click the <guibutton>Add</guibutton> button to
select an interface/interfaces for an Action Handler</entry>
+ <entry>org.jbpm.graph.def.ActionHandler</entry>
+ </row>
+
+ <row>
+ <entry>Which method stubs you would like to create?</entry>
+ <entry>Select the stubs that you would like to be created
automatically.</entry>
+ <entry>
+ <itemizedlist>
+ <listitem>
+ <para>Constructors from superclass</para>
+ </listitem>
+ <listitem>
+ <para>Inherited abstract methods</para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+ </row>
+
+ <row>
+ <entry>Do you want to add comments?</entry>
+ <entry>Select <guilabel>Generate comments</guilabel> check box
if you want comment mask to be generated before the class definition.</entry>
+ <entry><blank></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
-
- </section>
-
- <section id="the_views" xreflabel="the_views">
- <?dbhtml filename="the_views.html"?>
- <title>The views</title>
- <para>Here, it will be explained how to work with views and editors provided by
JBDS.</para>
- <para>The views are used for representation and navigation the resources you
are working on at
- the moment. One of the advantages of all the views is that all modifications made
in the
- current active file are immediately displayed in them. Let’s get acquainted more
closely
- with those that the <property>jPDL perspective</property> provides.
</para>
- <figure>
- <title>The jPDL Perspective Views and Editors</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_0.png"
scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
+ </section>
- <para>As you can see in the picture above, the <property>jPDL
perspective</property> contains a
- complete set of functionality that's necessary for working on the jBPM
project.</para>
+ <section id="the_views" xreflabel="the_views">
+ <?dbhtml filename="the_views.html"?>
+ <title>The views</title>
+ <para>Here, it will be explained how to work with views and editors provided by
JBDS.</para>
+ <para>
+ The views are used to represent and navigate through the resources you are currently
working on. One of the advantages of all the views is that they immediately reflect all
modifications made in the current active file. Let's explore the views that the
<property>jPDL perspective</property> provides in more detail.
+ </para>
- <section id="the_outline_view">
- <?dbhtml filename="the_outline_view.html"?>
- <title>The Outline View</title>
- <para>To have a way to quickly see an outline of the process use the
<emphasis>
- <property>Outline view</property>
- </emphasis> that is presented as the classical tree. If it is not
visible select <emphasis>
- <property>Window > Show view >
Outline</property>. </emphasis></para>
+ <figure>
+ <title>The jPDL Perspective Views and Editors</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_0.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>The Overview View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
+ <para>
+ As you can see in the picture above, the <property>jPDL
perspective</property> contains a complete set of functionality that's
necessary for working on the jBPM project.
+ </para>
- <section id="the_overview">
- <?dbhtml filename="the_outline_view.html"?>
- <title>The Overview</title>
- <para>The main advantage of this view is that it gives visual
representation of the whole
- current developing process. Besides, the <emphasis>
- <property>Overview</property>
- </emphasis> comes as a scrollable thumbnail which enables a better
navigation of the
- process structure if it's too large.</para>
+ <section id="the_outline_view">
+ <?dbhtml filename="the_outline_view.html"?>
+ <title>The Outline View</title>
+ <para>
+ The <emphasis><property>Outline view</property></emphasis>
provides a classical tree that allows you to quickly view the outline of a process. If it
is not visible select
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
view</guimenuitem><guimenuitem>Outline</guimenuitem></menuchoice>.
+ </para>
- <figure>
- <title>The Overview</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
+ <figure>
+ <title>The Overview View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
- <section id="the_properties_view">
- <?dbhtml filename="the_properties_view.html"?>
- <title>The Properties View</title>
- <para> Here, we dwell on the JBDS <property>Properties
view</property>.</para>
- <para>Notice if it's not visible you can access it by navigating
<emphasis>
- <property>Window > Show view >
Properties</property>. </emphasis></para>
- <para>The view shows the relevant properties of the selected item in the
tabbed form. Every
- item has its own set of properties, which can be directly editable in the
Properties
- view or by brining up the context menu.</para>
+ <section id="the_overview">
+ <?dbhtml filename="the_outline_view.html"?>
+ <title>The Overview</title>
+ <para>
+ This view provides a visual representation of the entire current developing process.
The <emphasis><property>Overview</property></emphasis> comes as a
scrollable thumbnail which enables a better navigation of the process structure if it is
too large.
+ </para>
- <figure>
- <title>The Properties View of selected Transition</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>The Overview</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
- <para>For example, on the picture above the Properties view displays all
the properties for
- a selected transition. Its name has been changed to <emphasis>
- <property>to_auction</property>. </emphasis>
We've done it directly in
- active General tab of the view. The same way let's change the name
for the
- second transition to <emphasis>
- <property>to_end</property>. </emphasis></para>
- <para>If no one item is selected, the view represents the properties of the
whole process
- definition. </para>
+ <section id="the_properties_view">
+ <?dbhtml filename="the_properties_view.html"?>
+ <title>The Properties View</title>
+ <para> Here, we dwell on the JBDS <property>Properties
view</property>.</para>
+ <para>
+ The Properties view can be displayed by selecting
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
view</guimenuitem><guimenuitem>Properties</guimenuitem></menuchoice>.
+ </para>
+ <para>
+ This view will list the relevant properties of the selected item in the tabbed form.
Every item has its own set of properties, which can be directly edited in the Properties
view or by brining up the context menu.
+ </para>
- <figure>
- <title>The Properties View of Process Definition</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>The Properties View of selected Transition</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>In this case, it contains six tabs. The first one is the
<emphasis>
- <property>General</property>.</emphasis> It allows to
specify a process name and add
- necessary description. To illustrate let's change the process
definition name
- to <emphasis>
- <property>jbay</property>. </emphasis></para>
- </section>
+ <para>
+ For example, on the picture above the Properties view displays all the properties for
a selected transition. Its name has been changed to
<emphasis><property>to_auction</property></emphasis>. We have done
it directly in active General tab of the view. The same way let's change the name
for the second transition to
<emphasis><property>to_end</property></emphasis>.
+ </para>
+ <para>If no one item is selected, the view represents the properties of the
whole process definition. </para>
- <section id="jbpm_gpd_editor">
- <?dbhtml filename="direct_editing.html"?>
- <title>The jBPM Graphical Process Designer editor.</title>
- <para>The <property>jBPM GPD editor</property> includes four
modes: Diagram, Deployment,
- Design and Source, which are available as switchable tabs at the bottom of
the editor.
- Let's dwell on each of them.</para>
+ <figure>
+ <title>The Properties View of Process Definition</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <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>
+ <para>
+ In this case, it contains six tabs. The first one is the
<emphasis><property>General</property>.</emphasis> It allows to
specify a process name and add necessary description. To illustrate let's change
the process definition name to
<emphasis><property>jbay</property></emphasis>.
+ </para>
+ </section>
- <figure>
- <title>The Diagram mode</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <section id="jbpm_gpd_editor">
+ <?dbhtml filename="direct_editing.html"?>
+ <title>The jBPM Graphical Process Designer editor.</title>
+ <para>
+ The <property>jBPM GPD editor</property> includes four modes: Diagram,
Deployment, Design and Source, which are available as switchable tabs at the bottom of the
editor.
+ </para>
- <para>Besides, some properties can be directly edited in the
<property>Diagram
- mode</property> of the graphical editor. One example of this is the
<emphasis>
- <property>name</property>
- </emphasis> property of nodes. You can edit this directly by
selecting the node of
- which you want to change the name and then click once inside this node.
This enables
- an editor in the node. We change the name of the node to
<emphasis>
- <property>auction</property>.
</emphasis></para>
- </section>
+ <section id="the_diagram_mode">
+ <title>The Diagram mode</title>
+ <para> In this mode we define the process in the form of a diagram using the
tools provided on the left-hand side of the jBPM GPD. </para>
- <section id="source_mode">
- <?dbhtml filename="the_source_view.html"?>
- <title>The Source Mode</title>
- <para>Now, that we have defined a simple process definition, we can
have a look at the
- XML that is being generated under the covers. To see this XML click on
the Source
- tab of the graphical process designer editor.</para>
+ <figure>
+ <title>The Diagram mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>The Source Mode</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The <property>Source mode</property> enables to
easily manipulate our XML. That is
- manually inserting and editing necessary elements or attributes. In
addition, here
- you can take advantage of content assist.</para>
-
- <para>A template is added to better render the jBPM task forms in the
Visual editor.
- Now the jBPM Graphical Process designer can create facelets that are
associated with tasks and are rendered in the jBPM console.</para>
- <figure>
- <title>A task form in VPE</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_6a.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
+ <para>
+ Some properties can be directly edited in the <property>Diagram
mode</property> of the graphical editor. One example of this is the
<emphasis><property>name</property></emphasis> property of nodes.
You can edit this directly by selecting the node of which you want to change the name and
then clicking once inside this node. This enables an editor in the node. We then change
the name of the node to
<emphasis><property>auction</property></emphasis>.
+ </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>Design
mode</property>. You can
- see it in the next picture:</para>
- <figure>
- <title>The Design Mode</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <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>
- <para>As you can see above, this mode looks like a table in the first
column of which
- the process structure is performed. Here, you can also insert, remove and
edit
- elements or attributes, moreover add comments and instructions. Their
values can be
- directly edited in the second column of the Design mode
table.</para>
- <para>For instance, let’s add a comment on the second transition. For
that, you should
- bring up the context menu for it and choose <emphasis>
- <property>Add Before > Comment</property>.
</emphasis></para>
+ <figure>
+ <title>The Source Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The <property>Source mode</property> provides a way to easily manipulate
the raw XML source. In addition, here you can take advantage of content assist.
+ </para>
- <figure>
- <title>Adding a Comment</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Then, we can put the text <emphasis>This transition leads
to the end
- state</emphasis> in the right column as its value.</para>
+ <para>
+ A template is added to better render the jBPM task forms in the Visual editor. Now
the jBPM Graphical Process designer can create facelets that are associated with tasks and
are rendered in the jBPM console.
+ </para>
+ <figure>
+ <title>A task form in VPE</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_6a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
- <figure>
- <title>Comment is added</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <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 the <property>Design
mode</property>. This mode is shown in the next picture:</para>
+ <figure>
+ <title>The Design Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- </section>
+ <para>
+ The Design mode presents a table. The process structure is shown in the first
column. 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 select
<menuchoice><guimenuitem>Add
Before</guimenuitem><guimenuitem>Comment</guimenuitem></menuchoice>.
+ </para>
- <section id="deployment_mode">
- <?dbhtml filename="the_deployment_view.html"?>
- <title>The Deployment Mode</title>
- <para>Finally, to adjust the deployment settings of the project you
should switch on to
- the tab that opens the <property>Deployment mode</property>.
On the picture below
- the <property>Deployment mode</property> is performed with
default settings. Here,
- you can easily modify them or, if the settings won't match your
needs, to
- reset defaults. </para>
- <figure>
- <title>The Deployment Mode</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/the_views/the_views_10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Adding a Comment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Then, we can enter the text <emphasis>This transition leads to the
end state</emphasis> in the right column as its value.</para>
- <para>The <property>Test Connections</property> button can
be used to check whether all your settings are valid before
- deploying the process.</para>
+ <figure>
+ <title>Comment is added</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>To deploy the process on the server you should click the
<property>Delpoy Process Archive</property> button.</para>
+ </section>
- <para>However, prior to testing the connection and deploying the
process on the server you need to
- make sure the server is configured to support jBPM functionality and is
running.</para>
+ <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 select the tab
that opens the <property>Deployment mode</property>. On the picture below the
<property>Deployment mode</property> is performed with default settings. Here,
you can easily modify them or, if the settings do not match your needs, to reset them to
their defaults.
+ </para>
+ <figure>
+ <title>The Deployment Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_10.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>Please, also note that if authentication for deployment is
required you may use the process deployer that is available at
<property>/gpd-deployer/upload</property>.</para>
-
- <para>Now that we've seen how to work with
<property>jPDL
- perspective</property>, let's pass on to the project
testing.</para>
- </section>
- </section>
-</section>
+ <!--para>The <guibutton>Test Connections</guibutton> button can be
used to check whether all your settings are valid before deploying the
process.</para>
+
+ <para>To deploy the process on the server you should click the
<guibutton>Delpoy Process Archive</guibutton> button.</para>
+
+ <para>
+ However, prior to testing the connection and deploying the process on the server you
need to make sure the server is configured to support jBPM functionality and is running.
+ </para>
+
+ <para>
+ Please, also note that if authentication for deployment is required you may use the
process deployer that is available at
<filename>/gpd-deployer/upload</filename>.
+ </para-->
+ </section>
+ </section>
+ </section>
</chapter>
\ No newline at end of file