JBoss Tools SVN: r15195 - branches/jbosstools-3.0.x/jmx/docs/reference/en/images.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:34:14 -0400 (Mon, 11 May 2009)
New Revision: 15195
Added:
branches/jbosstools-3.0.x/jmx/docs/reference/en/images/notifications.png
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Copied: branches/jbosstools-3.0.x/jmx/docs/reference/en/images/notifications.png (from rev 15128, trunk/jmx/docs/reference/en/images/notifications.png)
===================================================================
(Binary files differ)
15 years, 2 months
- 1
- 0
JBoss Tools SVN: r15194 - branches/jbosstools-3.0.x/jmx/docs/reference/en.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:34:05 -0400 (Mon, 11 May 2009)
New Revision: 15194
Added:
branches/jbosstools-3.0.x/jmx/docs/reference/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Copied: branches/jbosstools-3.0.x/jmx/docs/reference/en/master_output.xml (from rev 15128, trunk/jmx/docs/reference/en/master_output.xml)
===================================================================
--- branches/jbosstools-3.0.x/jmx/docs/reference/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/jmx/docs/reference/en/master_output.xml 2009-05-11 16:34:05 UTC (rev 15194)
@@ -0,0 +1,542 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[<!ENTITY introduction SYSTEM "modules/introduction.xml">
+<!ENTITY mbean_explorer SYSTEM "modules/mbean_explorer.xml">
+<!ENTITY mbean_editor SYSTEM "modules/mbean_editor.xml">
+<!ENTITY connection SYSTEM "modules/connection.xml">
+<!ENTITY how_to SYSTEM "modules/how_to.xml">
+<!ENTITY extensions SYSTEM "modules/extensions.xml">
+
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+
+
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>JMX Tools Reference Guide</title>
+
+ <!--author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
+ <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author><firstname>Rob</firstname><surname>Stryker</surname><email>rob.stryker(a)jboss.com</email></author>
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author-->
+
+ <pubdate>December 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo>
+ Version: 1.0.0.GA
+ </releaseinfo>
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/JMX_Tools_Ref...">PDF version</ulink>
+ </para>
+</abstract>
+
+ </bookinfo>
+
+
+ <toc></toc>
+
+<chapter id="intruduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jmx/docs/reference/en/modules/introduction.xml" xreflabel="introduction">
+ <?dbhtml filename="introduction.html"?>
+
+ <title>Introduction</title>
+
+ <para><property moreinfo="none">JMX Tools</property> allows to setup multiple JMX connections and provides view
+ for exploring the JMX tree and execute operations directly from Eclipse.</para>
+
+ <para>This chapter covers the basics of working with <property moreinfo="none">JMX plugin</property>, which is
+ used to manage Java applications through JMX and its RMI Connector.</para>
+
+ <figure float="0">
+ <title>JMX Tools</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/eclipse-jmx_0.2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section>
+ <title> Requirements </title>
+ <para>Requirements to use <property moreinfo="none">JMX Tools</property> are the following:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><property moreinfo="none">JMX Tools</property> is developed on Eclipse 3.4.x milestones</para>
+ </listitem>
+ <listitem>
+ <para><property moreinfo="none">JMX Tools</property> requires that Eclipse is run on a JDK 1.5.0 or above
+ (due to dependencies on JMX packages which were introduced in Java 1.5.0)</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>History</title>
+ <para><property moreinfo="none">JBoss Tools</property>' JMX project is a fork of <ulink url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</ulink>, a project by Jeff Mesnil.
+ It was forked with permission. </para>
+ </section>
+
+ <section>
+ <title>Installation</title>
+ <para>Here, we are going to explain how to install the <property moreinfo="none">JMX plugin</property> into
+ Eclipse.</para>
+
+ <para><property moreinfo="none">JMX Tools</property> is one module of the <property moreinfo="none">JBoss Tools</property>
+ project. <property moreinfo="none">JMX Tools</property> has no dependency on any other part of <property moreinfo="none">JBoss
+ Tools</property>, and can be downloaded standalone. Even though the <property moreinfo="none">JMX
+ Tools</property> have no dependencies, other plugins, such as <property moreinfo="none">AS Tools</property>,
+ do depend on the JMX Tooling and even extend it. </para>
+
+ <para>You can find the <property moreinfo="none">JBoss Tools</property> plugins over at the <ulink url="http://labs.jboss.com/tools/download/index.html">download pages</ulink>. The only
+ package you'll need to get is the JMX Tooling, however the <property moreinfo="none">AS
+ Tools</property> would give you a more full experience when using JMX with JBoss Servers.
+ You can find further download and installation instructions on the JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">InstallingJBossTools</ulink>
+ section.</para>
+ </section>
+
+
+ <section>
+ <title>Quick Start</title>
+
+ <para>To start using the <property moreinfo="none">JMX Tools</property>, it's necessary to open
+ <property moreinfo="none">MBean Explorer</property>. Go to <emphasis><property moreinfo="none">Window > Show View > Other</property></emphasis> and then select
+ <property moreinfo="none">MBean Explorer</property> and click <emphasis><property moreinfo="none">OK</property>.</emphasis></para>
+
+ <para>The <property moreinfo="none">MBean Explorer</property> lists all of the domains, mbeans, attributes, and operations inside a
+ connection. When you double-click on a MBean in the <emphasis><property moreinfo="none">MBean Explorer</property>,</emphasis> it opens a multi-page
+ editor to manage the MBean. The <property moreinfo="none">MBean Editor</property> is composed of these pages:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><emphasis><property moreinfo="none">Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para>
+ </listitem>
+ <listitem>
+ <para><emphasis><property moreinfo="none">Operations page</property>,</emphasis> to invoke operations on the MBean</para>
+ </listitem>
+ <listitem>
+ <para><emphasis><property moreinfo="none">Notifications page</property>,</emphasis> to receive notifications from the MBean</para>
+ </listitem>
+ <listitem>
+ <para><emphasis><property moreinfo="none">Info page</property>,</emphasis> which displays general information about the MBean </para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+
+</chapter>
+
+
+<chapter id="mbean_explorer" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jmx/docs/reference/en/modules/mbean_explorer.xml" xreflabel="mbean_explorer">
+ <?dbhtml filename="mbean_explorer.html"?>
+
+ <title>MBean Explorer</title>
+ <para>The <property moreinfo="none">MBean Explorer</property> displays the MBean features (both attributes and operations) in its
+ hierarchy. Double-clicking on a feature will open a <property moreinfo="none">MBean Editor</property>, display the page
+ corresponding to the feature type and select the feature.</para>
+
+ <figure float="0">
+ <title>MBean Explorer Features</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-explorer-features.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Since it's possible to have many MBean Editors opened at the same time, the <property moreinfo="none">MBean Explorer</property>
+ has the Link With Editor button
+
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/link-with-editor_0.2.0.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+
+ to synchronize selections between the active <property moreinfo="none">MBean Editor</property> and
+ the <property moreinfo="none">MBean Explorer</property> (and vice versa).</para>
+
+ <para>The <property moreinfo="none">MBean Explorer</property> has also a filter text that can be used to filter among all the MBeans
+ the few ones, which interest you.</para>
+
+ <para>For example, if you are only interested by MBeans related to memory, typing memo will show
+ any node (domain, mbean, attribute, or operation) that matches that text, as well as
+ that node's parents and children. So if an MBean matches, all attributes and operations from
+ that bean will show. If, however, an attribute or operation name (a leaf node) matches,
+ only that node and its parents in the tree will show.</para>
+
+ <figure float="0">
+ <title>Query Filter</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-explorer-query.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>The <emphasis>
+ <property moreinfo="none">Collapse All</property></emphasis> button
+
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/collaps_all.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+
+ on the <property moreinfo="none">MBean Explorer</property> toolbar is used to collapse all the MBeans and
+ display only the domains. It is also possible to double click on a node to expand/collapse it. </para>
+
+</chapter>
+
+
+<chapter id="mbean_editor" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jmx/docs/reference/en/modules/mbean_editor.xml" xreflabel="mbean_editor">
+ <?dbhtml filename="mbean_editor.html"?>
+
+ <title>MBean Editor</title>
+
+ <figure float="0">
+ <title>MBean Editor Pages</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-editor_0.2.0.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The <property moreinfo="none">MBean Editor</property> is composed of several pages:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Attributes</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Operations</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page</diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Notifications</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page </diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Info</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page </diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <para> The <emphasis>
+ <property moreinfo="none">Attributes</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">Operations</property>
+ </emphasis> pages display a list for either the MBean attributes or operations as well as
+ details for the selection.</para>
+
+ <para> It is possible to toggle the layout between the list and the details either vertically
+ (by default) or horizontally with the help of the special icons
+
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+
+ in the right top corner of the editor.</para>
+
+ <figure float="0">
+ <title>MBean Editor Horizontal Layout</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section>
+ <title>Notifications Page</title>
+ <para>One more page in the <property moreinfo="none">MBean Editor</property><diffmk:wrapper diffmk:change="added"> is the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Notifications</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page, which gives the possibility to
+ subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp.
+ unchecking) the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Subscribe</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> button in the right top corner. </diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">The list of notifications is refreshed every time a new notification is
+ received:</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">MBean Editor Notifications Page</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/notifications.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note</title>
+ <para>It is only possible to subscribe to MBean, which emits notifications (they must be
+ NotificationBroadcaster).</para>
+ </note>
+
+ </section>
+
+</chapter>
+
+
+<chapter id="connection" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jmx/docs/reference/en/modules/connection.xml" xreflabel="connection">
+ <?dbhtml filename="connection.html"?>
+
+ <title>Connections</title>
+
+ <para>The <property moreinfo="none">MBean Explorer</property> supports several different types of connections.
+ The tooling itself comes only with a default connection type, however other
+ adopters can provide additional connection types that may require additional
+ or non-spec behavior. Connections can be in either the connected state or
+ the disconnected state. Some connection types (such as the default connection type)
+ allow you to control the current state. Other connection types may not. </para>
+
+ <para>Similarly, some connection types may be able to be created, and others may not.
+ The default connection type, for example, can be created and deleted by you
+ at will. The AS Tools connection type, which represents a JBoss server, does not
+ allow you this level of control. A JBoss JMX connection is created when a JBoss server is created
+ in the server's view, and deleted when said server is deleted. The JMX connection for
+ this server is in the connected state only when the server is started. </para>
+
+
+ <section><title>The Default Connection</title>
+
+ <para> There are two ways to connect to an application with remote management enabled:</para>
+
+ <para> The first step is the same for both - to connect to a MBean Server, click on the
+ <emphasis>
+ <property moreinfo="none">New Connection</property></emphasis> icon
+
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/new_connection_icon.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+
+ in the <property moreinfo="none">MBean Explorer</property> menu bar.</para>
+
+ <para>Then to follow the simple one you just need to specify host, port (and optionally user
+ name and password) and click <emphasis>
+ <property moreinfo="none">OK</property>.</emphasis></para>
+
+ <para>The default JMX URL is <emphasis>
+ <property moreinfo="none">service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi</property>.</emphasis></para>
+
+ <para>In case you need to connect to an application which has not used the "standard" JMX URL
+ (e.g. Eclipse Equinox), you need chose more advance way, where it's necessary to specify
+ explicitly a JMX URL in the Advanced tab of the JMX Connection window.</para>
+
+ <note>
+ <title>Note</title>
+ <para>Only JMX URL based on RMI are supported.</para>
+ </note>
+ </section>
+</chapter>
+
+
+<chapter id="how_to" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jmx/docs/reference/en/modules/how_to.xml" xreflabel="how_to">
+ <?dbhtml filename="how_to.html"?>
+ <title>How to ...</title>
+ <para>This chapter will give you answers on most popular questions asked by <property moreinfo="none">JMX
+ plugin</property> users.</para>
+
+ <section>
+ <title>How to Manage Tomcat</title>
+
+ <para>It's possible to manage Tomcat using <property moreinfo="none">JMX Tools</property>.</para>
+
+ <para>Currently, JMX Tooling is able to connect to Tomcat without authentication or with
+ password-based authentication.</para>
+ <para>Using SSL for authentication is not supported: you need to make sure that the System
+ property <emphasis>
+ <property moreinfo="none">com.sun.management.jmxremote.ssl</property>
+ </emphasis> is set to false. </para>
+ <para>More information to manage Tomcat can be found in Tomcat management
+ documentation.</para>
+ <para>Instructions to manage remotely Tomcat are available in Tomcat's monitoring
+ documentation.</para>
+
+ </section>
+
+ <section>
+ <title>How to manage Eclipse Equinox</title>
+
+ <para>You can manage Equinox through the Equinox monitoring framework.</para>
+ <para>Once you have installed the Equinox monitoring framework and restarted Eclipse:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Go to <emphasis>
+ <property moreinfo="none">Window > Open Perspective > Other</property>
+ </emphasis> and select the <property moreinfo="none">JMX perspective</property></para>
+ </listitem>
+
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">JMX Server > Open Connection</property>
+ </emphasis> and click on <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis></para>
+ </listitem>
+
+ <listitem>
+ <para>Switch to the <property moreinfo="none">MBean Explorer</property> by going to <emphasis>
+ <property moreinfo="none">Window > Show View > Other</property>
+ </emphasis> and selecting the MBean Explorer</para>
+ </listitem>
+
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">New Connection</property></emphasis> icon
+
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/new_connection_icon.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+
+ in the <property moreinfo="none">MBean Explorer</property> menu
+ bar </para>
+ </listitem>
+
+ <listitem>
+ <para>Select the <emphasis>
+ <property moreinfo="none">Advanced tab</property></emphasis> and set the JMX URL to <emphasis>
+ <property moreinfo="none">service:jmx:rmi:///jndi/rmi://:8118/jmxserver</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <para>You now have access to the MBeans exposed by Equinox.</para>
+ </section>
+
+
+ <section>
+ <title>Managing JBoss Instances</title>
+
+ <para>Managing JBoss instances is not supported with the <property moreinfo="none">JMX Tools</property>
+ alone. You must also download and install the <property moreinfo="none">AS Tools</property> portion of
+ the <property moreinfo="none">JBoss Tools</property> distribution. Even after installing the proper
+ tooling, you cannot create a JBoss JMX connection yourself or through the Connection
+ Wizard. The first step is to create a JBoss Server. The full instructions for this can
+ be found in the AS Tools section, however, the short summary is: </para>
+ <itemizedlist>
+ <listitem>
+ <para>Open the <property moreinfo="none">JBoss Servers View</property> or the <property moreinfo="none">Servers
+ View</property></para>
+ </listitem>
+
+ <listitem>
+ <para>Right-click in the view and select <emphasis>
+ <property moreinfo="none">New > Server</property>
+ </emphasis></para>
+ </listitem>
+
+ <listitem>
+ <para>In the <emphasis>
+ <property moreinfo="none">JBoss Community</property>
+ </emphasis> section, select a server version</para>
+ </listitem>
+
+ <listitem>
+ <para>If a runtime has not yet been created, you'll be prompted for the
+ server's home directory, JDK, and configuration</para>
+ </listitem>
+
+ <listitem>
+ <para>Finish the wizard and note that you have a new entry in both the
+ <property moreinfo="none">JBoss Server View</property> and the <property moreinfo="none">MBean
+ Explorer</property></para>
+ </listitem>
+
+ <listitem>
+ <para>Start the server by right-clicking it and selecting <emphasis>
+ <property moreinfo="none">Start</property></emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Note that once the server is started, the JMX connection can be
+ expanded</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Now you can explore MBeans exposed by a JBoss instance.</para>
+ </section>
+
+</chapter>
+
+
+<chapter id="extensions" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jmx/docs/reference/en/modules/extensions.xml" xreflabel="extensions">
+ <?dbhtml filename="extensions"?>
+ <title>Extension API</title>
+ <para>This chapter will outline how to contribute your own Server type with some default
+ behavior.</para>
+
+ <section>
+ <title>Why??</title>
+
+ <para>You might be asking yourself why you'd need to extend this framework if JMX is
+ a standard. Perhaps you want a connection to be automatically created after some specific
+ action, or perhaps you want your connection wizard to do more than simply set a host and
+ port. JBoss, for example, requires setting some credentials on the client machine, but
+ using JBoss classes to do it. This requires that the connection have access to JBoss
+ jars.</para>
+ </section>
+
+ <section>
+ <title>Core Extensions</title>
+
+ <para>To create your own JMX Connection type, you must use the
+ org.jboss.tools.jmx.core.MBeanServerConnectionProvider extension point. This point takes
+ one child, a connectionProvider with a class that implements
+ org.jboss.tools.jmx.core.IConnectionProvider.</para>
+
+ <para><diffmk:wrapper diffmk:change="changed">An IConnectionProvider is responsible for creation and deletion of IConnectionWrapper
+ objects. It must also keep a list of listeners that it is expected to inform when a
+ connection is added or removed from its list. </diffmk:wrapper></para>
+
+ <para>Each IConnectionWrapper is expected to handle running arbitrary JMX runnables or getting
+ a "Root" object representing all JMX nodes. There are some utility methods the
+ IConnectionWrapper can make use of.</para>
+ </section>
+
+
+ <section>
+ <title>UI Extensions</title>
+ <para>There are two extension points currently approved for use in the UI</para>
+ <itemizedlist>
+ <listitem>
+ <para>org.jboss.tools.jmx.ui.providerUI - provide an icon, id, displayable name, and
+ wizardPage class for creation of new connections</para>
+ </listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">org.jboss.tools.jmx.ui.attribute.controls - allows you to map class types to some
+ Control to present them in the MBean Editor</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201"><diffmk:wrapper diffmk:change="added">JBoss forum</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+</chapter>
+
+</book>
15 years, 2 months
- 1
- 0
JBoss Tools SVN: r15193 - in branches/jbosstools-3.0.x/jbpm/docs: converter_ref/en/images and 9 other directories.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:32:19 -0400 (Mon, 11 May 2009)
New Revision: 15193
Modified:
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_1.png
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_2.png
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_3.png
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_4.png
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_5.png
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_7.png
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_8.png
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/modules/overview.xml
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/pom.xml
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/Test_Drive_Proc/test_driv_proc_1.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/runtime_installation/runtime_installation_1.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/the_views/the_views_5.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/the_views/the_views_6.png
branches/jbosstools-3.0.x/jbpm/docs/reference/en/master.xml
branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/Introduction.xml
branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml
branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml
branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml
branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml
branches/jbosstools-3.0.x/jbpm/docs/reference/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_1.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_2.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_3.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_4.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_5.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_7.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/images/bpmnconvert_bpmn2jpdl_8.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -1,22 +1,18 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="bpmn2jpdl" >
- <title>Translate a BPMN file to a JPDL file</title>
- <para>In this chapter we provide you with the necessary steps to translate a BPMN file to a JPDL file.</para>
+ <title>Translate a Bpmn file to a JPDL file</title>
+ <para>In this chapter we provide you with the necessary steps to translate a Bpmn file to a JPDL file.</para>
<section id="createproject">
<title>Creating a project</title>
- <para>Before creating a bpmn file, you should have a Project created.</para>
+ <para>Before creating a Bpmn file, you should have a Project created.</para>
<para>Create a project by
- <emphasis><property>New > Project... > Project</property></emphasis>
- . Enter the following information:
- </para>
- <itemizedlist>
- <listitem>
- <para>Project Name: test</para>
- </listitem>
- </itemizedlist>
+ <emphasis><property>New > Project... > General > Project</property></emphasis>. Enter the following information:
+ </para>
+ <para>Project Name: test</para>
+
<figure>
- <title>A Project</title>
+ <title>Creating a Project</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/bpmnconvert_bpmn2jpdl_1.png"></imagedata>
@@ -25,20 +21,15 @@
</figure>
<para>Click on the <property>Finish</property> button.</para>
</section>
-
<section id="createbpmnfile">
- <title>Creating a bpmn file by STP BPMN editor</title>
- <para>Create a bpmn diagram file by
+ <title>Creating a Bpmn File by STP BPMN Editor</title>
+ <para>Create a BPMN diagram file by
<emphasis><property>New > Others... > Bpmn Diagram</property></emphasis>
. Enter the following information:
</para>
- <itemizedlist>
- <listitem>
- <para>File Name: test</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Create BPMN Diagram</title>
+ <para>File Name: test</para>
+ <figure>
+ <title>Creating BPMN Diagram</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/bpmnconvert_bpmn2jpdl_2.png"></imagedata>
@@ -47,12 +38,11 @@
</figure>
<para>Click on the <property>Finish</property> button.</para>
<para>Open the test.bpmn_diagram file by double-click it.</para>
- <para>Draw the bpmn diagram using STP BPMN editor. If you do not know how to use STP BPMN editor, please go to web site: www.eclipse.org/stp to get the information about STP BPMN editor.</para>
+ <para>Draw the Bpmn diagram using STP BPMN editor. If you do not know how to use STP BPMN editor, please visit <ulink url="http://www.eclipse.org/bpmn/">BPMN project page for details</ulink>.</para>
</section>
-
- <section id="bpmntojpdl">
- <title>Exporting a bpmn file to some jpdl files</title>
- <para>A BPMN file may include more than one pool. Every pool can be mapped to a corresponding JPDL file.</para>
+ <section id="bpmntojpdl">
+ <title>Exporting a Bpmn File to Jpdl files</title>
+ <para>A Bpmn file may include more than one pool. Every pool can be mapped to a corresponding Jpdl file.</para>
<itemizedlist>
<listitem>
<para>Select 'test.bpmn' file and right-click it. Open the export wizard by
@@ -73,7 +63,7 @@
<para>Select the BPMN file that you want to translate.
</para>
<figure>
- <title>Choose a BPMN file</title>
+ <title>Choosing a BPMN File</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/bpmnconvert_bpmn2jpdl_4.png"></imagedata>
@@ -86,7 +76,7 @@
<para>Select the Pools of BPMN that you want to translate.
</para>
<figure>
- <title>Choose BPMN Pools</title>
+ <title>Choosing BPMN Pools</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/bpmnconvert_bpmn2jpdl_5.png"></imagedata>
@@ -96,17 +86,9 @@
<para>Click on the <property>Next</property> button.</para>
</listitem>
<listitem>
- <para>In this page, You may get error messages or warning messages that occured during the conversion. If no any messages, this page will be skipped.
+ <para>On the next page, you may get error or warning messages that occurred during the conversion. If there are no messages, this page is skipped.
</para>
- <figure>
- <title>Show Messages</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpmnconvert_bpmn2jpdl_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on the <property>Next</property> button.</para>
+ <para>Click on the <property>Next</property> button.</para>
</listitem>
<listitem>
<para>Select the target location to save the generated JPDL files.
@@ -121,7 +103,7 @@
</figure>
<itemizedlist>
<listitem>
- <para>Overwrite existing resources: if you don't want to overwrite existing resources, please keep uncheck this checkbox.</para>
+ <para>If you'd like to overwrite existing resources,check this "Overwrite existing resources" checkbox.</para>
</listitem>
</itemizedlist>
<para>Click on the <property>Finish</property> button.</para>
@@ -136,8 +118,9 @@
<imagedata fileref="images/bpmnconvert_bpmn2jpdl_8.png"></imagedata>
</imageobject>
</mediaobject>
- </figure>
+ </figure>
+ <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. Besides, for additional information you are welcome on <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
</section>
-
-
+
</chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/modules/overview.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/modules/overview.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/modules/overview.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="overview">
<title>BPMN Convert Overview</title>
-
- <para>JBoss BPMN Convert module is a tool. Users can use it to translate a BPMN file to something else.</para>
- <para>The BPMN file may be written by hands or by some editors. In this guide, we use STP BPMN editor to draw a BPMN file.</para>
- <para>As a part of JBoss tools, this module realizes BPMN -> JPDL translation. Users can get a basic JPDL file from a BPMN file by using this module.</para>
-
-</chapter>
\ No newline at end of file
+ <para>This chapter gives you a short overview of JBoss BPMN Convert module</para>
+ <para>JBoss BPMN Convert module is a tool used for a BPMN file translation</para>
+ <para>As a part of JBoss tools, JBoss BPMN Convert module implements BPMN -> JPDL translation. You can get a basic JPDL file from a BPMN file by using this module.</para>
+ <para>The BPMN file may be written by hands or with the help of some editors. In this guide, we use STP BPMN editor to draw a BPMN file.</para>
+ <para>You can download the editor which is included into BPMN Modeler from Eclipse download or update site. On the <ulink url="http://www.eclipse.org/bpmn">Eclipse BPMN project page</ulink> you can find the necessary links and other related information</para>
+ </chapter>
\ No newline at end of file
Modified: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/converter_ref/pom.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/converter_ref/pom.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -74,7 +74,13 @@
<artifactId>jbosstools-docbook-xslt</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
- </dependencies>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
+ </dependencies>
+
<configuration>
<sourceDocumentName>master.xml</sourceDocumentName>
<sourceDirectory>${pom.basedir}/en</sourceDirectory>
@@ -146,5 +152,6 @@
<cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/org/css/</cssdir>
<translation>en-US</translation>
</properties>
-
+
+
</project>
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/Test_Drive_Proc/test_driv_proc_1.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/runtime_installation/runtime_installation_1.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/the_views/the_views_5.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/images/the_views/the_views_6.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/master.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/reference/en/master.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/reference/en/master.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -59,7 +59,7 @@
<year>2009</year>
<holder>JBoss, a division of Red Hat</holder>
</copyright>
- <releaseinfo> Version: 3.1.5.GA</releaseinfo>
+ <releaseinfo> Version: 3.1.7.GA</releaseinfo>
<abstract>
<title/>
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/Introduction.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/Introduction.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/Introduction.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -131,8 +131,8 @@
<section>
<title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/2.1.0.GA/">here</ulink>.</para>
- <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
+ <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
+ <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -170,6 +170,6 @@
</figure>
<para>We hope, our guide will help you to get started with the jPDL process language and jBPM
workflow on the whole. Besides, for additional information you are welcome on <ulink
- url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=217">our forum</ulink>.</para>
+ url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -223,7 +223,7 @@
</mediaobject>
</figure>
- <para>Tere we are. The above objective has been achieved.</para>
+ <para>There we are. The above objective has been achieved.</para>
</section>
<section>
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -1,221 +1,221 @@
<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="GuidedTourJBossjBPMGPD" xreflabel="GuidedTourJBossjBPMGPD">
- <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- <keyword>JBoss</keyword>
- <keyword>Process</keyword>
- <keyword>Definition</keyword>
- </keywordset>
- </chapterinfo>
- <title>A Guided Tour of JBoss jBPM GPD</title>
- <para>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 Definion 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> and <emphasis>
- <property>processdefinition.xml</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 without the graphical
- rendering info. At present, the GPD assumes that these two files are siblings. More
- sophisticated configuration will be supported later.</para>
-
- <section id="minimal_process_definition">
- <?dbhtml filename="minimal_process_definition.html"?>
- <title>A Minimal Process Definition</title>
- <para>Now we are ready to create a very simple process definition consisting of a begin
- state, an intermediate state and an end state.</para>
- <para>To make the configuration of actions much easier it's better to use the
- jPDL perspective. It provides the tabbed Properties Editor which allows to configure
- all the relevant properties of the current selected item. </para>
-
- <section id="adding_the_nodes">
- <?dbhtml filename="adding_the_nodes.html"?>
- <title>Adding the Nodes</title>
- <para>At first select respectively <emphasis>
- <property>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>
-
-</chapter>
+<chapter id="GuidedTourJBossjBPMGPD" xreflabel="GuidedTourJBossjBPMGPD">
+ <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ <keyword>JBoss</keyword>
+ <keyword>Process</keyword>
+ <keyword>Definition</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>A Guided Tour of JBoss jBPM GPD</title>
+ <para>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> and <emphasis>
+ <property>processdefinition.xml</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 without the graphical
+ rendering info. At present, the GPD assumes that these two files are siblings. More
+ sophisticated configuration will be supported later.</para>
+
+ <section id="minimal_process_definition">
+ <?dbhtml filename="minimal_process_definition.html"?>
+ <title>A Minimal Process Definition</title>
+ <para>Now we are ready to create a very simple process definition consisting of a begin
+ state, an intermediate state and an end state.</para>
+ <para>To make the configuration of actions much easier it's better to use the
+ jPDL perspective. It provides the tabbed Properties Editor which allows to configure
+ all the relevant properties of the current selected item. </para>
+
+ <section id="adding_the_nodes">
+ <?dbhtml filename="adding_the_nodes.html"?>
+ <title>Adding the Nodes</title>
+ <para>At first select respectively <emphasis>
+ <property>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>
+
+</chapter>
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -15,8 +15,8 @@
jBPM</property> (business process management).</para>
<para>The jBPM plugin (jBPM Designer) is already included in the <property>JBoss Tools</property>.
To make it work, you should only download the jBPM runtime (<ulink
- url="http://sourceforge.net/project/showfiles.php?group_id=70542&package_i..."
- >jbpm-jpdl-3.2.2</ulink> currently) and specify the directory where you extracted the runtime
+ url="http://sourceforge.net/project/showfiles.php?group_id=70542&package_i..."
+ >jbpm-jpdl-3.2.3</ulink> currently) and specify the directory where you extracted the runtime
either when you create a jBPM project or by using the jBPM preference pages.</para>
<note>
Modified: branches/jbosstools-3.0.x/jbpm/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/reference/pom.xml 2009-05-11 16:31:59 UTC (rev 15192)
+++ branches/jbosstools-3.0.x/jbpm/docs/reference/pom.xml 2009-05-11 16:32:19 UTC (rev 15193)
@@ -76,6 +76,12 @@
<artifactId>jbosstools-docbook-xslt</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+
+ </dependency>
</dependencies>
<configuration>
<sourceDocumentName>${master}</sourceDocumentName>
15 years, 2 months
- 1
- 0
JBoss Tools SVN: r15192 - branches/jbosstools-3.0.x/jbpm/docs/reference/en.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:31:59 -0400 (Mon, 11 May 2009)
New Revision: 15192
Added:
branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml
Removed:
branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Deleted: branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml 2009-05-11 16:31:41 UTC (rev 15191)
+++ branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml 2009-05-11 16:31:59 UTC (rev 15192)
@@ -1,1288 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.docbook.org/xml/4.3/docbookx.dtd"
-
-
-[<!ENTITY introduction SYSTEM "modules/Introduction.xml">
-<!ENTITY jboss_jbpm_runtime_installation SYSTEM "modules/jboss_jbpm_runtime_installation.xml">
-<!ENTITY guided_tour_jboss_jbpmgpd SYSTEM "modules/guided_tour_jboss_jbpmgpd.xml">
-<!ENTITY the_views SYSTEM "modules/the_views.xml">
-<!ENTITY Test_Drive_Proc SYSTEM "modules/Test_Drive_Proc.xml">
-<!ENTITY The_JBoss_jBPM_Int_Mech SYSTEM "modules/The_JBoss_jBPM_Int_Mech.xml">
-<!ENTITY Quick_Howto_Guide SYSTEM "modules/Quick_Howto_Guide.xml">
-
-<!ENTITY seamlink "../../seam/html_single/index.html">
-<!ENTITY aslink "../../as/html_single/index.html">
-<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
-<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
-<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
-<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
-<!ENTITY jsflink "../../jsf/html_single/index.html">
-<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
-<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
-<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
-<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
-
- ]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
- <bookinfo>
- <title>jBPM Tools Reference Guide</title>
-
- <author>
- <firstname>Anatoly</firstname>
- <surname>Fedosik</surname>
- </author>
- <author>
- <firstname>Koen</firstname>
- <surname>Aers</surname>
- <email>koen.aers(a)jboss.com</email>
- </author>
- <author>
- <firstname>Olga</firstname>
- <surname>Chikvina</surname>
- </author>
- <author>
- <firstname>Svetlana</firstname>
- <surname>Mukhina</surname>
- <email>smukhina(a)exadel.com</email>
- </author>
- <author>
- <firstname>Tom</firstname>
- <surname>Baeyens</surname>
- <email>tom.baeyens(a)jboss.com</email>
- </author>
-
-
- <pubdate>April 2008</pubdate>
- <copyright>
- <year>2007</year>
- <year><diffmk:wrapper diffmk:change="changed">2009</diffmk:wrapper></year>
- <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed"> Version: 3.1.5.GA</diffmk:wrapper></releaseinfo>
-
-<abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jbpm/pdf/JBPM_Refere...">PDF version</ulink>
- </para>
-</abstract>
-
- </bookinfo>
-
- <toc></toc>
-
-<chapter id="Introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Introduction.xml" xreflabel="Introduction">
- <?dbhtml filename="TargetAudience.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- <keyword>Target</keyword>
- <keyword>developers</keyword>
- <keyword>Audience</keyword>
- </keywordset>
- </chapterinfo>
- <title>Introduction</title>
- <para>All developers and process analysts who are beginning to use JBoss jBPM should read this
- Getting Started guide. It will give them a jumpstart showing how to create a process definition.</para>
- <section id="Preface">
- <?dbhtml filename="Preface.html"?>
- <title>Preface</title>
- <para>This document introduces the use of the JBoss jBPM Graphical Process Designer (GPD) to
- create workflow processes. It will help first time users with the following tasks :</para>
- <itemizedlist>
- <listitem>
- <para>Install the JBoss jBPM GPD Eclipse plugin available from the JBoss jBPM download
- area</para>
- </listitem>
- <listitem>
- <para>Set up a Java project in Eclipse and prepare it to do test driven process
- development</para>
- </listitem>
- <listitem>
- <para>Using the creation wizard to create an empty process definition</para>
- </listitem>
- <listitem>
- <para>Use the designer palette to draw the first processdefinition</para>
- </listitem>
- <listitem>
- <para>Show how the xml processdefinition can be inspected as an xml file</para>
- </listitem>
- <listitem>
- <para>Set up a Java project in Eclipse and prepare it to do test driven process
- development</para>
- </listitem>
- <listitem>
- <para>Write an example process test case</para>
- </listitem>
- </itemizedlist>
- <para>If you have questions, please feel free to contact <ulink url="mailto:koen.aers@jboss.com">Koen Aers</ulink> or <ulink url="mailto:tom.baeyens@jboss.com">Tom Baeyens</ulink> for more
- information.</para>
- </section>
-
- <section id="feature_list">
-
- <title>Feature list</title>
-
- <para> JBoss jBPM is a workflow that enables creating and automatization business processes. Look
- at the list of features below to understand its main functionality.</para>
- <table>
- <title>Key Functionality for JBoss jBPM</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- </row>
- </thead>
- <tbody>
-
- <row>
- <entry>
- <link linkend="minimal_process_definition">jBDL support</link>
- </entry>
- <entry>Enables managing workflow processes as well as human tasks and interactions between
- them. jBDL combines the best both Java and declarative process techniques.</entry>
- </row>
-
- <row>
- <entry>
- <link linkend="GuidedTourJBossjBPMGPD">Support of Graphical Process Designer (GPD)</link>
- </entry>
- <entry>Is used for simplifying declarative process development and visualizations of all
- actions.</entry>
- </row>
-
- <row>
- <entry>
- <link linkend="CreatingjBPMProject">Project Creation wizard</link>
- </entry>
- <entry>Allows to create a new jBPM template project that already includes all advanced
- artifacts and core jBPM libraries.</entry>
- </row>
-
- <row>
- <entry>
- <link linkend="minimal_process_definition">Rich palette of pre-build process nodes</link>
- </entry>
- <entry>Provides process-building functionality and gives opportunity even non-programmers to
- develop processes.</entry>
- </row>
-
- <row>
- <entry>
- <link linkend="source_mode">Support of XML code view</link>
- </entry>
- <entry>Shows the corresponding XML that's generated automatically in the Source view
- of the process definition editor when developing the process.</entry>
- </row>
-
- <row>
- <entry>
- <link linkend="the_properties_view">Properties view</link>
- </entry>
- <entry>Facilitates configuring and editing of all nodes properties.</entry>
- </row>
-
- <row>
- <entry>Interaction with all of the J2EE based integration technologies including Web Services,
- Java Messaging, J2EE Connectors, JBDC, EJBs.</entry>
- <entry>Enables implementation, provides better functionality and flexibility.</entry>
- </row>
-
- <row>
- <entry>Integration with jBoss Seam</entry>
- <entry>Allows to write applications with complex workflows and provides easier interactions
- between them.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section>
- <title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/2.1.0.GA/">here</ulink>.</para>
- <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
- </section>
-
-</chapter>
-
-
-<chapter id="jboss_jbpm_runtime_installation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml" xreflabel="jboss_jbpm_runtime_installation">
- <?dbhtml filename="jboss_jbpm_runtime_installation.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- <keyword>designer</keyword>
- <keyword>process</keyword>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>jBPM runtime</keyword>
- </keywordset>
- </chapterinfo>
- <title>JBoss jBPM Runtime Installation</title>
- <para>The main purpose of this chapter is to let you know how to launch the <property moreinfo="none">JBoss
- jBPM</property> (business process management).</para>
- <para>The jBPM plugin (jBPM Designer) is already included in the <property moreinfo="none">JBoss Tools</property>.
- To make it work, you should only download the jBPM runtime (<ulink url="http://sourceforge.net/project/showfiles.php?group_id=70542&package_i...">jbpm-jpdl-3.2.2</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 moreinfo="none">Window > Preferences > JBoss jBPM > Runtime Locations</property>.
- </emphasis> Here you can add, edit and remove JBoss jBPM installation locations. Click <emphasis>
- <property moreinfo="none">Add</property>
- </emphasis> button. In the dialog that appeared enter a name for a newly added jBPM runtime and
- point to the correct location of this package on your harddrive. Click <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis> then click <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis> again.</para>
-
- <figure float="0">
- <title>Adding jBPM Location</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/runtime_installation/runtime_installation_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Now, when you have a runtime installed, we are going to demonstrate some powerful features of
- the jBPM.</para>
-</chapter>
-
-
-<chapter id="GuidedTourJBossjBPMGPD" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml" xreflabel="GuidedTourJBossjBPMGPD">
- <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- <keyword>JBoss</keyword>
- <keyword>Process</keyword>
- <keyword>Definition</keyword>
- </keywordset>
- </chapterinfo>
- <title>A Guided Tour of JBoss jBPM GPD</title>
- <para>In this chapter we suggest a step-by-step walk-through of creating and configuring your
- own simple process. Let's try to organize a new jBPM project.</para>
- <para>A wizard for creating a jBPM project is included in the GPD plugin. We have opted to
- create a project based on a template already containing a number of advanced artifacts that
- we will ignore for this section. In the future we will elaborate this wizard and offer the
- possibility to create an empty jBPM project as well as projects based on templates taken
- from the jBPM tutorial.</para>
- <section id="CreatingjBPMProject">
- <?dbhtml filename="CreatingjBPMProject.html"?>
- <title>Creating a jBPM Project</title>
- <para>This section will show you how to use the Creation wizard for creating a new jBPM
- project with already included source folders.</para>
- <para>At first you should select <emphasis>
- <property moreinfo="none">File >New Project...</property>
- </emphasis> and then <emphasis>
- <property moreinfo="none">JBoss jBPM > Process Project</property>
- </emphasis> in the New Project dialog:</para>
- <figure float="0">
- <title>New Project Dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Clicking <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> brings us to the wizard page where it's necessary to specify the
- name and location for the project. We choose, for example, <emphasis>
- <property moreinfo="none">HellojBPM</property>
- </emphasis> as the name and accept the default location. </para>
- <figure float="0">
- <title>Process Name and Location</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Thus, our project will be created in the workspace root directory by default. If you
- want to change the directory for your future project, deselect <emphasis>
- <property moreinfo="none">Use default location</property>
- </emphasis> and click <emphasis>
- <property moreinfo="none">Browse...</property>
- </emphasis> button to set needed location or simply type it.</para>
- <para>On the next screen you'll be prompted to select the core jBPM location that
- we have defined in the previous chapter.</para>
- <figure float="0">
- <title>Core jBPM Location Specifying</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_9.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Clicking on <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> results in the project being generated. The wizard creates four source
- folders: one for the processes (<emphasis>
- <property moreinfo="none">src/main/jpdl</property>
- </emphasis>), one for the java sources (<emphasis>
- <property moreinfo="none">src/main/java</property>
- </emphasis>), one for the unit tests (<emphasis>
- <property moreinfo="none">src/test/java</property>
- </emphasis>) and one for the resources such as the jbpm.properties and the
- hibernate.properties files (<emphasis>
- <property moreinfo="none">src/main/config</property>
- </emphasis>). In addition a classpath container with all the core jBPM libraries is
- added to the project</para>
- <figure float="0">
- <title>Layout of the Process Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Looking inside the different source folders will reveal a number of other artifacts
- that were generated, but we will leave these untouched for the moment. Instead, we will
- look at another wizard that enables us to create an empty process definition.</para>
- </section>
- <section id="creating_an_empty_process_definition">
- <?dbhtml filename="creating_an_empty_process_definition.html"?>
- <title>Creating an Empty Process Definition</title>
- <para>Now when the project is set up, we can use a Creation wizard to create an empty
- process definition. Bring up the <emphasis>
- <property moreinfo="none">New</property>
- </emphasis> wizard by clicking the <emphasis>
- <property moreinfo="none">File > New > Other...</property>
- </emphasis> menu item. The wizard opens on the <emphasis>
- <property moreinfo="none">Select Wizard</property>
- </emphasis> page.</para>
- <figure float="0">
- <title>The Select Wizard Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Selecting the <emphasis>
- <property moreinfo="none">JBoss jBPM</property>
- </emphasis> category, then the <emphasis>
- <property moreinfo="none">Process Definition</property>
- </emphasis> item and clicking on the <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> button brings us to the <emphasis>
- <property moreinfo="none">Create Process Definition</property>
- </emphasis> page.</para>
- <figure float="0">
- <title>The Create New Process Definion Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>We choose <emphasis>
- <property moreinfo="none">hello</property>
- </emphasis> as the name of the process archive file. Click on the <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> button to end the wizard and open the process definition editor.</para>
- <figure float="0">
- <title>The Process Definition Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_6.png" scale="60"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>You can see in the Package Explorer that creating a process definition involves
- creating a folder with the name of the process definition and populating this folder
- with two .xml files : <emphasis>
- <property moreinfo="none">gpd.xml</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">processdefinition.xml</property>. </emphasis></para>
- <para>The <emphasis>
- <property moreinfo="none">gpd.xml</property>
- </emphasis> contains the graphical information used by the process definition editor.
- The <emphasis>
- <property moreinfo="none">processdefinition.xml</property>
- </emphasis> file contains the actual process definition info without the graphical
- rendering info. At present, the GPD assumes that these two files are siblings. More
- sophisticated configuration will be supported later.</para>
-
- <section id="minimal_process_definition">
- <?dbhtml filename="minimal_process_definition.html"?>
- <title>A Minimal Process Definition</title>
- <para>Now we are ready to create a very simple process definition consisting of a begin
- state, an intermediate state and an end state.</para>
- <para>To make the configuration of actions much easier it's better to use the
- jPDL perspective. It provides the tabbed Properties Editor which allows to configure
- all the relevant properties of the current selected item. </para>
-
- <section id="adding_the_nodes">
- <?dbhtml filename="adding_the_nodes.html"?>
- <title>Adding the Nodes</title>
- <para>At first select respectively <emphasis>
- <property moreinfo="none">Start</property>, </emphasis>
- <emphasis>
- <property moreinfo="none">State</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">End</property>
- </emphasis> on the tools palette and click on the canvas to add these nodes to
- the process definition. The result should look similar to this:</para>
- <figure float="0">
- <title>A Simple Process With Three Nodes</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_7.png" scale="60"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="adding_transitions">
- <?dbhtml filename="adding_transitions.html"?>
- <title>Adding Transitions</title>
- <para>Then, we will connect the nodes with transitions. To do that select the <emphasis>
- <property moreinfo="none">Transition</property>
- </emphasis> tool in the tools palette and click on the <emphasis>
- <property moreinfo="none">Start</property>
- </emphasis> node, then move to the <emphasis>
- <property moreinfo="none">State</property>
- </emphasis> node and click again to see the transition being drawn. Perform the
- same steps to create a transition from the <emphasis>
- <property moreinfo="none">State</property>
- </emphasis> node to the <emphasis>
- <property moreinfo="none">End</property>
- </emphasis> node. The result will look like:</para>
- <figure float="0">
- <title>A Simple Process With Transitions</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_8.png" scale="60"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Now, when you've got background knowledge of simple project creation,
- let's move to more advanced tools.</para>
- </section>
- </section>
- </section>
-
-</chapter>
-
-
-<chapter id="the_views" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/the_views.xml" xreflabel="the_views">
- <?dbhtml filename="the_views.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>The views</title>
-
- <para>Here, it will be explained how to work with views and editors provided by JBDS.</para>
- <para><diffmk:wrapper diffmk:change="changed">The views are used for representation and navigation the resources you are working on at
- the moment. One of the advantages of all the views is that all modifications made in the
- current active file are immediately displayed in them. Let’s get acquainted more closely
- with those that the </diffmk:wrapper><property moreinfo="none">jPDL perspective</property> provides. </para>
-
- <figure float="0">
- <title>The jPDL Perspective Views and Editors</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_0.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As you can see in the picture above, the <property moreinfo="none">jPDL perspective</property> contains a
- complete set of functionality that's necessary for working on the jBPM project.</para>
-
- <section id="the_outline_view">
- <?dbhtml filename="the_outline_view.html"?>
- <title>The Outline View</title>
- <para>To have a way to quickly see an outline of the process use the <emphasis>
- <property moreinfo="none">Outline view</property>
- </emphasis> that is presented as the classical tree. If it is not visible select <emphasis>
- <property moreinfo="none">Window > Show view > Outline</property>. </emphasis></para>
-
- <figure float="0">
- <title>The Overview View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="the_overview">
- <?dbhtml filename="the_outline_view.html"?>
- <title>The Overview</title>
- <para><diffmk:wrapper diffmk:change="changed">The main advantage of this view is that it gives visual representation of the whole
- current developing process. Besides, the </diffmk:wrapper><emphasis>
- <property moreinfo="none">Overview</property>
- </emphasis> comes as a scrollable thumbnail which enables a better navigation of the
- process structure if it's too large.</para>
-
- <figure float="0">
- <title>The Overview</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="the_properties_view">
- <?dbhtml filename="the_properties_view.html"?>
- <title>The Properties View</title>
- <para> Here, we dwell on the JBDS <property moreinfo="none">Properties view</property>.</para>
- <para>Notice if it's not visible you can access it by navigating <emphasis>
- <property moreinfo="none">Window > Show view > Properties</property>. </emphasis></para>
- <para>The view shows the relevant properties of the selected item in the tabbed form. Every
- item has its own set of properties, which can be directly editable in the Properties
- view or by brining up the context menu.</para>
-
- <figure float="0">
- <title>The Properties View of selected Transition</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>For example, on the picture above the Properties view displays all the properties for
- a selected transition. Its name has been changed to <emphasis>
- <property moreinfo="none">to_auction</property>. </emphasis> We've done it directly in
- active General tab of the view. The same way let's change the name for the
- second transition to <emphasis>
- <property moreinfo="none">to_end</property>. </emphasis></para>
- <para>If no one item is selected, the view represents the properties of the whole process
- definition. </para>
-
- <figure float="0">
- <title>The Properties View of Process Definition</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In this case, it contains six tabs. The first one is the <emphasis>
- <property moreinfo="none">General</property>.</emphasis> It allows to specify a process name and add
- necessary description. To illustrate let's change the process definition name
- to <emphasis>
- <property moreinfo="none">jbay</property>. </emphasis></para>
- </section>
-
- <section id="jbpm_gpd_editor">
- <?dbhtml filename="direct_editing.html"?>
- <title>The jBPM Graphical Process Designer editor.</title>
- <para>The <property moreinfo="none">jBPM GPD editor</property> includes four modes: Diagram, Deployment,
- Design and Source, which are available as switchable tabs at the bottom of the editor.
- Let's dwell on each of them.</para>
-
- <section id="the_diagram_mode">
- <title>The Diagram mode</title>
- <para> In this mode we define the process in the form of a diagram by means of tools
- provided on the left-hand side of the jBPM GPD. </para>
-
- <figure float="0">
- <title>The Diagram mode</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Besides, some properties can be directly edited in the <property moreinfo="none">Diagram
- mode</property> of the graphical editor. One example of this is the <emphasis>
- <property moreinfo="none">name</property>
- </emphasis> property of nodes. You can edit this directly by selecting the node of
- which you want to change the name and then click once inside this node. This enables
- an editor in the node. We change the name of the node to <emphasis>
- <property moreinfo="none">auction</property>. </emphasis></para>
- </section>
-
- <section id="source_mode">
- <?dbhtml filename="the_source_view.html"?>
- <title>The Source Mode</title>
- <para>Now, that we have defined a simple process definition, we can have a look at the
- XML that is being generated under the covers. To see this XML click on the Source
- tab of the graphical process designer editor.</para>
-
- <figure float="0">
- <title>The Source Mode</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The <property moreinfo="none">Source mode</property> enables to easily manipulate our XML. That is
- manually inserting and editing necessary elements or attributes. In addition, here
- you can take advantage of content assist.</para>
- </section>
-
- <section id="design_mode">
- <?dbhtml filename="the_design_view.html"?>
- <title>The Design Mode</title>
- <para>One more way to edit your file is to use <property moreinfo="none">Design mode</property>. You can
- see it in the next picture:</para>
- <figure float="0">
- <title>The Design Mode</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As you can see above, this mode looks like a table in the first column of which
- the process structure is performed. Here, you can also insert, remove and edit
- elements or attributes, moreover add comments and instructions. Their values can be
- directly edited in the second column of the Design mode table.</para>
- <para>For instance, let’s add a comment on the second transition. For that, you should
- bring up the context menu for it and choose <emphasis>
- <property moreinfo="none">Add Before > Comment</property>. </emphasis></para>
-
- <figure float="0">
- <title>Adding a Comment</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Then, we can put the text <emphasis>This transition leads to the end
- state</emphasis> in the right column as its value.</para>
-
- <figure float="0">
- <title>Comment is added</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_9.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section id="deployment_mode">
- <?dbhtml filename="the_deployment_view.html"?>
- <title>The Deployment Mode</title>
- <para>Finally, to adjust the deployment settings of the project you should switch on to
- the tab that opens the <property moreinfo="none">Deployment mode</property>. On the picture below
- the <property moreinfo="none">Deployment mode</property> is performed with default settings. Here,
- you can easily modify them or, if the settings won't match your needs, to
- reset defaults. </para>
- <figure float="0">
- <title>The Deployment Mode</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/the_views/the_views_10.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The button <emphasis>
- <property moreinfo="none">Test Connections</property>
- </emphasis> is necessary to make sure whether all your settings are valid before
- deploying the process.</para>
- <para>Now that we've seen how to work with <property moreinfo="none">jPDL
- perspective</property>, let's pass on to the project testing.</para>
- </section>
- </section>
-</chapter>
-
-<chapter id="Test_Drive_Proc_Development" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml" xreflabel="Test_Drive_Proc_Development">
- <?dbhtml filename="Test_Drive_Proc_Development.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- <keyword></keyword>
- <keyword></keyword>
- <keyword></keyword>
- <keyword></keyword>
- </keywordset>
- </chapterinfo>
- <title>Test Driven Process Development</title>
-
- <para> One of the most important advantages of JBoss jBPM's lightweight approach to BPM
- and workflow management is that developers can easily leverage their usual programming
- skills and techniques. One of these well-known techniques is Unit Testing and Test Driven
- Development. </para>
- <para>In this chapter we will show how developers, making use of the JBoss jBPM GPD, can use a
- technique we have baptized <property moreinfo="none">Test Driven Process Development</property> to create
- process definitions and test their correctness. </para>
-
- <para> When creating the <emphasis>
- <property moreinfo="none">HellojBPM</property>
- </emphasis> project the Project Creation wizard has already put in place all the library
- requirements we need to start writing the jBPM unit tests. They are contained in the jBPM
- Library container and the most important of them is the <emphasis>
- <property moreinfo="none">.jar</property>
- </emphasis> file containing the core jBPM classes. While working on the project you could
- find them all in the <property moreinfo="none">Package Explorer</property>.</para>
-
- <figure float="0">
- <title>The jBPM Libraries</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It must be noted that it is possible to change the location of the core jBPM installation
- by changing the preference settings. More on this <link linkend="change_core_jbpm_inst">see
- later</link> in this book.</para>
-
- <para> With that extra knowledge on the project settings, you can create your first test. To do
- this, we create the <emphasis>
- <property moreinfo="none">com.jbay</property>
- </emphasis> package in the <emphasis>
- <property moreinfo="none">test/java</property>
- </emphasis> source folder. Then we bring up the context menu on this package and select <emphasis>
- <property moreinfo="none">New > Other...</property>
- </emphasis></para>
-
- <figure float="0">
- <title>Call the JUnit Test Case Creation wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> And then <emphasis>
- <property moreinfo="none">Java > JUnit > JUnit Test Case</property>
- </emphasis> to call the specialized JUnite Test case creation wizard.</para>
- <figure float="0">
- <title>Call the JUnit Test Case Creation wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The wizard looks as follows:</para>
-
- <figure float="0">
- <title>Create Test Dialog</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>By default JUnite 3 version of testing framework is selected. Of course, you can choose
- new advanced JUnit 4 version. In this case you'll be prompted to add new JUnit
- Library to your build path. To add it automatically just click on the appropriate link. In
- the <emphasis>
- <property moreinfo="none">Class under test</property>
- </emphasis> section you can specify the class to test.</para>
-
- <figure float="0">
- <title>A First Test Scenario</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Then, we call the test class <emphasis>
- <property moreinfo="none">HelloTest</property>
- </emphasis> and press <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> button to complete.</para>
-
- <para> Next, we should write a simple test scenario as shown on the next figure. Let's
- study the code of this test case. </para>
-
- <figure float="0" id="hello_test">
- <title>A First Test Scenario</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_6.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In the first line of the method, a jBPM process archive object is created. We use a
- constructor accepting the filename of the archive. In our case it is the <emphasis>
- <property moreinfo="none">hello</property>
- </emphasis> file we created earlier and which lives in the <emphasis>
- <property moreinfo="none">src/main/jpdl</property>
- </emphasis> folder of our project. After asserting that this object is really created, we
- extract a process definition object from it. This object is fed to the constructor of a
- process instance object. We have a process instance object, but this process is not yet
- started, so we can safely assert that its root token still resides in the start node. After
- signalling the token will move to the next state and the process will be in the <emphasis>
- <property moreinfo="none">auction</property>
- </emphasis> state. Finally another signal will end the process. </para>
-
-
- <para> After writing this test we can check whether it works as expected by running it .</para>
-
- <figure float="0">
- <title>Running the Process Test</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_7.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>All went well as we have a green light:</para>
-
- <figure float="0">
- <title>Successful Test Run</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_8.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Of course, this simple scenario was not very interesting, but the purpose of it was to
- show how you can reuse your development skills in a very straightforward way when doing
- process development. To see how more interesting processes and process test
- scenario's can be developed, we suggest you to read the <ulink url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink> and to
- study the API reference. You can find it in the jBPM download folder. (To get started we
- downloaded jbpm-jpdl-3.2.2 in <link linkend="jboss_jbpm_runtime_installation">the second
- chapter</link>. You should just remember where you extracted it.) All we've mentioned are in the 'javadoc- *' subfolders of the 'doc' folder.
- Moreover, some more examples will be given later in this book.</para>
-
-</chapter>
-
-
-<chapter id="The_JBoss_jBPM_Int_Mech" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml" xreflabel="The_JBoss_jBPM_Int_Mech">
- <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- <keyword></keyword>
- <keyword></keyword>
- <keyword></keyword>
- <keyword></keyword>
- </keywordset>
- </chapterinfo>
- <title>Actions : The JBoss jBPM Integration Mechanism</title>
-
- <para> In this chapter we will show how to do software integration with <property moreinfo="none">JBoss
- jBPM</property>. The standard mechanism to implement this is to wrap the functionality you
- want to integrate in a class that implements the <emphasis>
- <property moreinfo="none">ActionHandler</property>
- </emphasis> interface. In order to demonstrate it let's specify Hello World action for our
- process.</para>
-
- <section>
- <title>Creating a Hello World Action</title>
-
- <para>Each Hello World process should integrate one or more Hello World actions, so this is
- what we will be doing. We can integrate custom code at different points in the process
- definition. To do this we have to specify an action handler, represented by an
- implementation of the <emphasis>
- <property moreinfo="none">ActionHandler</property>
- </emphasis> interface, and attach this piece of code to a particular event. These events
- are amongst others, going over a transition, leaving or entering nodes, after and before
- signalling. </para>
-
- <para> To make things a little bit more concrete, let's create a new class called <emphasis>
- <property moreinfo="none">HelloActionHandler</property>.
- </emphasis> For that firstly we'll create a new package <emphasis>
- <property moreinfo="none">com.jbay.action</property>
- </emphasis> in the <emphasis>
- <property moreinfo="none">src/java/main</property>
- </emphasis> folder of our project. Then, we should call New Class Creation wizard as
- usual by right-clicking and navigating <emphasis>
- <property moreinfo="none">New > Class</property>.
- </emphasis> </para>
-
- <figure float="0">
- <title>Creating HelloActionHendler Class</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Notice that two first gaps have been filled automatically. Here, instead of <emphasis>
- <property moreinfo="none">Package</property>
- </emphasis> option <emphasis>
- <property moreinfo="none">Enclose type</property>
- </emphasis> option can be selected where a type in which to enclose a new class should
- be specified.</para>
-
- <para>In our case, we leave everything as it is, just type <emphasis>
- <property moreinfo="none">HelloActionHandler</property>
- </emphasis> as a name of new class and add <emphasis>
- <property moreinfo="none">org.jbpm.graph.ActionHendler</property>
- </emphasis> interface as it's shown in the picture above.</para>
-
- <para>Thus, our <emphasis>
- <property moreinfo="none">HelloActionHandler</property>
- </emphasis> implements the <emphasis>
- <property moreinfo="none">ActionHandler</property>
- </emphasis> interface including the <emphasis>
- <property moreinfo="none">execute</property>
- </emphasis> method as shown in the next figure. Here, we add a variable named <emphasis>
- <property moreinfo="none">greeting</property>
- </emphasis> to the collection of process variables and put a message in it :
- <emphasis>"Hello from ActionHandler"</emphasis>. </para>
-
- <figure float="0">
- <title>A Simple Hello Action</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Now, as we have <emphasis>
- <property moreinfo="none">HelloActionHandler</property>
- </emphasis> class defined, let's explore how we can handle it.</para>
- </section>
-
- <section>
- <title>Integrating the Hello World Action</title>
-
- <para>The main purpose of this chapter is to provide you with the steps associating our
- Hello World action with a particular event and test the correctness of our actions as
- well.</para>
-
- <para> As good Testcity citizens we will first create a Unit Test that proves the behaviour
- we want to achieve by adding the <emphasis>
- <property moreinfo="none">ActionHandler</property>
- </emphasis> to the process. So we implement another test.</para>
-
- <para>At first, let's return to the
- code we already saw <link linkend="hello_test">in the previous chapter</link> and add new test method <emphasis>
- <property moreinfo="none">testActionHendler</property></emphasis> to it. </para>
-
- <figure float="0">
- <title>Create the Hello Action Test</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>We assert
- that no variable called <emphasis>
- <property moreinfo="none">greeting</property>
- </emphasis> exist. Then we give the process a signal to move it to the auction state. We
- want to associate the execution of the action with the event of going over the
- transition from the start state to the auction state. So after the signal, the process
- should be in the auction state as in the previous scenario. But moreover, the <emphasis>
- <property moreinfo="none">greeting</property>
- </emphasis> variable should exist and contain the string <emphasis>"Hello from
- ActionHandler"</emphasis>. That's what we assert in the last lines of the test
- method.</para>
-
-
-
- <para> Running the tests now results in a failure. The point is that we did not associate
- the action with any particular event in the process definition, so the process variable
- did not get set. </para>
-
- <figure float="0">
- <title>Test Results Before Integration</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Let's do something about it and add an action to the first transition of our
- sample process. To do this you can use the Actions tab in the Properties Editor that is
- under the graphical canvas. Bring up the popup menu of the action element container and
- chose New Action as it's shown on the figure below. The other way to add an action
- to the transition is simply to use the dropdown menu that is available under the action
- icon in the right upper corner of the Properties View.</para>
-
- <figure float="0">
- <title>Adding an Action to a Transition</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After adding the action a tabbed view with three pages will appear.</para>
-
- <figure float="0">
- <title>Configuration Dialog for an Action</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The first of these three pages allows you to give the Action a name. The last page
- contains some advanced attributes such as whether the Action is asynchronous. The
- Details page is the most important. It allows to choose and configure the actual action
- handler implementation. </para>
-
- <figure float="0">
- <title>The Details page of an Action Configuration Dialog</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>Clicking on the <emphasis>
- <property moreinfo="none">Search...</property>
- </emphasis> button brings us to a Choose Class dialog.</para>
-
-
- <figure float="0">
- <title>The Choose Action Handler Dialog</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para> We choose our previously created 'HelloActionHandler' class and
- push the <property moreinfo="none">OK</property> button. After the selection of the action handler for
- the action, we can run the test and observe it gives us a green light.</para>
-
- <figure float="0">
- <title>Test Results</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png" scale="70"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Tere we are. The above objective has been achieved.</para>
- </section>
-
- <section>
- <title> Integration Points</title>
-
- <para> The different integration points in a process definition are thoroughly documented in
- the <ulink url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink>. Instance nodes can contain many action
- elements. Each of these will appear in the Action element list of the Actions tab. But
- each Action also has a properties view of itself. You can navigate to this view by
- selecting the added Action in the outline view. </para>
-
- </section>
-
-</chapter>
-
-
-<chapter id="Quick_Howto_Guide" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml" xreflabel="Quick_Howto_Guide">
- <?dbhtml filename="Quick_Howto_Guide.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>jBPM</keyword>
- <keyword></keyword>
- <keyword></keyword>
- <keyword></keyword>
- <keyword></keyword>
- </keywordset>
- </chapterinfo>
- <title>Quick Howto Guide</title>
-
- <para>This chapter contains additional information related to the <property moreinfo="none">JBoss
- jBPM</property>.</para>
-
- <section id="change_core_jbpm_inst">
- <title>Change the Default Core jBPM Installation</title>
-
- <para> You can change the default <property moreinfo="none">jBPM</property> installation by means of the
- Eclipse preference mechanism. Open the Preferences dialog by selecting <emphasis>
- <property moreinfo="none">Window > Preferences</property>
- </emphasis> and select the <emphasis>
- <property moreinfo="none">JBoss jBPM > Runtime Location</property>
- </emphasis> category. Using this page you can add multiple <property moreinfo="none">jBPM</property>
- installation locations and change the default one. The default installation is used for
- the classpath settings when creating a new Process Project. Changing the preferences has
- no influence on already created projects. Getting rid of a <property moreinfo="none">jBPM</property>
- installation that's being referenced by a project however will cause the
- classpath to contain errors. </para>
-
-
- <figure float="0">
- <title>The jBPM Preferences Page</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section>
- <title>Configuring Task Nodes</title>
-
- <para>Here, we'll examine how you can configure the Task nodes in jBPM jPDL GPD.</para>
-
- <para> You can add Tasks to Task nodes and then configure them in a similar manner as the
- Action configuration mechanism. Let's consider the process definition similar
- to the previous one that contains three nodes: Start state, Task node and End state. The
- <property moreinfo="none">Properties view</property> for selected Task node includes several tabs. </para>
-
- <figure float="0">
- <title>The Properties View of the selected Task Node</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png" scale="75"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>We should choose the Task tab and then bring up the context menu or click the button
- in the top right corner of the view to add a Task to our Task node.</para>
-
- <figure float="0">
- <title>Adding a Task to the Task Node</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Every added Task has its own configuration possibilities. You can access them through
- the <property moreinfo="none">Properties view</property> as well.</para>
-
- <figure float="0">
- <title>The Task properties</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The <property moreinfo="none">General page</property> is a place where you can specify the name of a
- Task and its description. For instance, let it be <emphasis>
- <property moreinfo="none">approve oder</property>
- </emphasis> with appropriate description that you can see in the figure below.</para>
-
- <figure float="0">
- <title>The Task General Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Now, look at <property moreinfo="none">Details page</property>. First, you should specify the due date
- that is a mandatory property for the Task. The due date is the date on which the task
- should be accomplished. Here you can also set a Task priority as well as signalling,
- notifying or blocking. The <emphasis>
- <property moreinfo="none">Blocking</property>
- </emphasis> attribute indicates that the process will not be able to continue if this
- task is still unaccomplished. The <emphasis>
- <property moreinfo="none">Generate Form...</property>
- </emphasis> button is for creating a simple task form that can be rendered by the jBPM
- console.</para>
-
- <figure float="0">
- <title>The Task Details Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>For our example, we specify the due date as 2 business days, choose the high priority
- and also check the <emphasis>
- <property moreinfo="none">Signalling</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">Notify</property>
- </emphasis> attributes. It means that the Task should be accomplished in 2 business days
- and the assignee will be notified by email when the task is assigned. To specify how the
- Task should be assigned switch on to the <property moreinfo="none">Assignment page</property>.</para>
-
- <figure float="0">
- <title>The Task Assignment Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the <property moreinfo="none">Reminder page</property> you can specify whether the assignee will be reminded of the task
- that awaits him.</para>
-
- <figure float="0">
- <title>The Task Reminder Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In our case, the assignee will be reminded by email after two business hours and
- continue to get reminding every business hour after that.</para>
- <para>In the next figure you can see our configuring generated into XML.</para>
- <figure float="0">
- <title>The Task Reminder Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>We hope, our guide will help you to get started with the jPDL process language and jBPM
- workflow on the whole. Besides, for additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=217">our forum</ulink>.</para>
- </section>
-</chapter>
-
-
- <!-- TODO: drools used in this section is not available for eclipse .3.3 &AddBusinessProcess; -->
-</book>
Copied: branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml (from rev 15128, trunk/jbpm/docs/reference/en/master_output.xml)
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml 2009-05-11 16:31:59 UTC (rev 15192)
@@ -0,0 +1,1064 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+
+[<!ENTITY introduction SYSTEM "modules/Introduction.xml">
+<!ENTITY jboss_jbpm_runtime_installation SYSTEM "modules/jboss_jbpm_runtime_installation.xml">
+<!ENTITY guided_tour_jboss_jbpmgpd SYSTEM "modules/guided_tour_jboss_jbpmgpd.xml">
+<!ENTITY the_views SYSTEM "modules/the_views.xml">
+<!ENTITY Test_Drive_Proc SYSTEM "modules/Test_Drive_Proc.xml">
+<!ENTITY The_JBoss_jBPM_Int_Mech SYSTEM "modules/The_JBoss_jBPM_Int_Mech.xml">
+<!ENTITY Quick_Howto_Guide SYSTEM "modules/Quick_Howto_Guide.xml">
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+
+ ]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+ <bookinfo>
+ <title>jBPM Tools Reference Guide</title>
+
+ <author>
+ <firstname>Anatoly</firstname>
+ <surname>Fedosik</surname>
+ </author>
+ <author>
+ <firstname>Koen</firstname>
+ <surname>Aers</surname>
+ <email>koen.aers(a)jboss.com</email>
+ </author>
+ <author>
+ <firstname>Olga</firstname>
+ <surname>Chikvina</surname>
+ </author>
+ <author>
+ <firstname>Svetlana</firstname>
+ <surname>Mukhina</surname>
+ <email>smukhina(a)exadel.com</email>
+ </author>
+ <author>
+ <firstname>Tom</firstname>
+ <surname>Baeyens</surname>
+ <email>tom.baeyens(a)jboss.com</email>
+ </author>
+
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed"> Version: 3.1.7.GA</diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jbpm/pdf/JBPM_Refere...">PDF version</ulink>
+ </para>
+</abstract>
+
+ </bookinfo>
+
+ <toc></toc>
+
+<chapter id="Introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Introduction.xml" xreflabel="Introduction">
+ <?dbhtml filename="TargetAudience.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ <keyword>Target</keyword>
+ <keyword>developers</keyword>
+ <keyword>Audience</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Introduction</title>
+ <para>All developers and process analysts who are beginning to use JBoss jBPM should read this
+ Getting Started guide. It will give them a jumpstart showing how to create a process definition.</para>
+ <section id="Preface">
+ <?dbhtml filename="Preface.html"?>
+ <title>Preface</title>
+ <para>This document introduces the use of the JBoss jBPM Graphical Process Designer (GPD) to
+ create workflow processes. It will help first time users with the following tasks :</para>
+ <itemizedlist>
+ <listitem>
+ <para>Install the JBoss jBPM GPD Eclipse plugin available from the JBoss jBPM download
+ area</para>
+ </listitem>
+ <listitem>
+ <para>Set up a Java project in Eclipse and prepare it to do test driven process
+ development</para>
+ </listitem>
+ <listitem>
+ <para>Using the creation wizard to create an empty process definition</para>
+ </listitem>
+ <listitem>
+ <para>Use the designer palette to draw the first processdefinition</para>
+ </listitem>
+ <listitem>
+ <para>Show how the xml processdefinition can be inspected as an xml file</para>
+ </listitem>
+ <listitem>
+ <para>Set up a Java project in Eclipse and prepare it to do test driven process
+ development</para>
+ </listitem>
+ <listitem>
+ <para>Write an example process test case</para>
+ </listitem>
+ </itemizedlist>
+ <para>If you have questions, please feel free to contact <ulink url="mailto:koen.aers@jboss.com">Koen Aers</ulink> or <ulink url="mailto:tom.baeyens@jboss.com">Tom Baeyens</ulink> for more
+ information.</para>
+ </section>
+
+ <section id="feature_list">
+
+ <title>Feature list</title>
+
+ <para> JBoss jBPM is a workflow that enables creating and automatization business processes. Look
+ at the list of features below to understand its main functionality.</para>
+ <table>
+ <title>Key Functionality for JBoss jBPM</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ </row>
+ </thead>
+ <tbody>
+
+ <row>
+ <entry>
+ <link linkend="minimal_process_definition">jBDL support</link>
+ </entry>
+ <entry>Enables managing workflow processes as well as human tasks and interactions between
+ them. jBDL combines the best both Java and declarative process techniques.</entry>
+ </row>
+
+ <row>
+ <entry>
+ <link linkend="GuidedTourJBossjBPMGPD">Support of Graphical Process Designer (GPD)</link>
+ </entry>
+ <entry>Is used for simplifying declarative process development and visualizations of all
+ actions.</entry>
+ </row>
+
+ <row>
+ <entry>
+ <link linkend="CreatingjBPMProject">Project Creation wizard</link>
+ </entry>
+ <entry>Allows to create a new jBPM template project that already includes all advanced
+ artifacts and core jBPM libraries.</entry>
+ </row>
+
+ <row>
+ <entry>
+ <link linkend="minimal_process_definition">Rich palette of pre-build process nodes</link>
+ </entry>
+ <entry>Provides process-building functionality and gives opportunity even non-programmers to
+ develop processes.</entry>
+ </row>
+
+ <row>
+ <entry>
+ <link linkend="source_mode">Support of XML code view</link>
+ </entry>
+ <entry>Shows the corresponding XML that's generated automatically in the Source view
+ of the process definition editor when developing the process.</entry>
+ </row>
+
+ <row>
+ <entry>
+ <link linkend="the_properties_view">Properties view</link>
+ </entry>
+ <entry>Facilitates configuring and editing of all nodes properties.</entry>
+ </row>
+
+ <row>
+ <entry>Interaction with all of the J2EE based integration technologies including Web Services,
+ Java Messaging, J2EE Connectors, JBDC, EJBs.</entry>
+ <entry>Enables implementation, provides better functionality and flexibility.</entry>
+ </row>
+
+ <row>
+ <entry>Integration with jBoss Seam</entry>
+ <entry>Allows to write applications with complex workflows and provides easier interactions
+ between them.</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+ <para><diffmk:wrapper diffmk:change="changed">All JBoss Developer Studio/JBoss Tools release documentation you can find at</diffmk:wrapper><diffmk:wrapper diffmk:change="changed">http://docs.jboss.org/tools</diffmk:wrapper><diffmk:wrapper diffmk:change="changed"> in the corresponding release directory.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">The latest documentation builds are available at </diffmk:wrapper><ulink url="http://download.jboss.org/jbosstools/nightly-docs/"><diffmk:wrapper diffmk:change="changed">http://download.jboss.org/jbosstools/nightly-docs</diffmk:wrapper></ulink>.</para>
+ </section>
+
+</chapter>
+
+
+<chapter id="jboss_jbpm_runtime_installation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml" xreflabel="jboss_jbpm_runtime_installation">
+ <?dbhtml filename="jboss_jbpm_runtime_installation.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ <keyword>designer</keyword>
+ <keyword>process</keyword>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>jBPM runtime</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>JBoss jBPM Runtime Installation</title>
+ <para>The main purpose of this chapter is to let you know how to launch the <property moreinfo="none">JBoss
+ jBPM</property> (business process management).</para>
+ <para>The jBPM plugin (jBPM Designer) is already included in the <property moreinfo="none">JBoss Tools</property>.
+ To make it work, you should only download the jBPM runtime (<diffmk:wrapper diffmk:change="changed">jbpm-jpdl-3.2.3</diffmk:wrapper> currently) and specify the directory where you extracted the runtime
+ either when you create a jBPM project or by using the jBPM preference pages.</para>
+
+ <note>
+ <title>Note:</title>
+ <para>Try to avoid using spaces in the names of installation folders. It can provoke problems in
+ some situations with Sun-based VMs.</para>
+ </note>
+
+ <para>Navigate to <emphasis>
+ <property moreinfo="none">Window > Preferences > JBoss jBPM > Runtime Locations</property>.
+ </emphasis> Here you can add, edit and remove JBoss jBPM installation locations. Click <emphasis>
+ <property moreinfo="none">Add</property>
+ </emphasis> button. In the dialog that appeared enter a name for a newly added jBPM runtime and
+ point to the correct location of this package on your harddrive. Click <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis> then click <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis> again.</para>
+
+ <figure float="0">
+ <title>Adding jBPM Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/runtime_installation/runtime_installation_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Now, when you have a runtime installed, we are going to demonstrate some powerful features of
+ the jBPM.</para>
+ </chapter>
+
+<chapter id="the_views" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/the_views.xml" xreflabel="the_views">
+ <?dbhtml filename="the_views.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>The views</title>
+
+ <para>Here, it will be explained how to work with views and editors provided by JBDS.</para>
+ <para>The views are used for representation and navigation the resources you are working on at
+ the moment. One of the advantages of all the views is that all modifications made in the
+ current active file are immediately displayed in them. Let’s get acquainted more closely
+ with those that the <property moreinfo="none">jPDL perspective</property> provides. </para>
+
+ <figure float="0">
+ <title>The jPDL Perspective Views and Editors</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_0.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As you can see in the picture above, the <property moreinfo="none">jPDL perspective</property> contains a
+ complete set of functionality that's necessary for working on the jBPM project.</para>
+
+ <section id="the_outline_view">
+ <?dbhtml filename="the_outline_view.html"?>
+ <title>The Outline View</title>
+ <para>To have a way to quickly see an outline of the process use the <emphasis>
+ <property moreinfo="none">Outline view</property>
+ </emphasis> that is presented as the classical tree. If it is not visible select <emphasis>
+ <property moreinfo="none">Window > Show view > Outline</property>. </emphasis></para>
+
+ <figure float="0">
+ <title>The Overview View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="the_overview">
+ <?dbhtml filename="the_outline_view.html"?>
+ <title>The Overview</title>
+ <para>The main advantage of this view is that it gives visual representation of the whole
+ current developing process. Besides, the <emphasis>
+ <property moreinfo="none">Overview</property>
+ </emphasis> comes as a scrollable thumbnail which enables a better navigation of the
+ process structure if it's too large.</para>
+
+ <figure float="0">
+ <title>The Overview</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="the_properties_view">
+ <?dbhtml filename="the_properties_view.html"?>
+ <title>The Properties View</title>
+ <para> Here, we dwell on the JBDS <property moreinfo="none">Properties view</property>.</para>
+ <para>Notice if it's not visible you can access it by navigating <emphasis>
+ <property moreinfo="none">Window > Show view > Properties</property>. </emphasis></para>
+ <para>The view shows the relevant properties of the selected item in the tabbed form. Every
+ item has its own set of properties, which can be directly editable in the Properties
+ view or by brining up the context menu.</para>
+
+ <figure float="0">
+ <title>The Properties View of selected Transition</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>For example, on the picture above the Properties view displays all the properties for
+ a selected transition. Its name has been changed to <emphasis>
+ <property moreinfo="none">to_auction</property>. </emphasis> We've done it directly in
+ active General tab of the view. The same way let's change the name for the
+ second transition to <emphasis>
+ <property moreinfo="none">to_end</property>. </emphasis></para>
+ <para>If no one item is selected, the view represents the properties of the whole process
+ definition. </para>
+
+ <figure float="0">
+ <title>The Properties View of Process Definition</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In this case, it contains six tabs. The first one is the <emphasis>
+ <property moreinfo="none">General</property>.</emphasis> It allows to specify a process name and add
+ necessary description. To illustrate let's change the process definition name
+ to <emphasis>
+ <property moreinfo="none">jbay</property>. </emphasis></para>
+ </section>
+
+ <section id="jbpm_gpd_editor">
+ <?dbhtml filename="direct_editing.html"?>
+ <title>The jBPM Graphical Process Designer editor.</title>
+ <para>The <property moreinfo="none">jBPM GPD editor</property> includes four modes: Diagram, Deployment,
+ Design and Source, which are available as switchable tabs at the bottom of the editor.
+ Let's dwell on each of them.</para>
+
+ <section id="the_diagram_mode">
+ <title>The Diagram mode</title>
+ <para> In this mode we define the process in the form of a diagram by means of tools
+ provided on the left-hand side of the jBPM GPD. </para>
+
+ <figure float="0">
+ <title>The Diagram mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Besides, some properties can be directly edited in the <property moreinfo="none">Diagram
+ mode</property> of the graphical editor. One example of this is the <emphasis>
+ <property moreinfo="none">name</property>
+ </emphasis> property of nodes. You can edit this directly by selecting the node of
+ which you want to change the name and then click once inside this node. This enables
+ an editor in the node. We change the name of the node to <emphasis>
+ <property moreinfo="none">auction</property>. </emphasis></para>
+ </section>
+
+ <section id="source_mode">
+ <?dbhtml filename="the_source_view.html"?>
+ <title>The Source Mode</title>
+ <para>Now, that we have defined a simple process definition, we can have a look at the
+ XML that is being generated under the covers. To see this XML click on the Source
+ tab of the graphical process designer editor.</para>
+
+ <figure float="0">
+ <title>The Source Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The <property moreinfo="none">Source mode</property> enables to easily manipulate our XML. That is
+ manually inserting and editing necessary elements or attributes. In addition, here
+ you can take advantage of content assist.</para>
+ </section>
+
+ <section id="design_mode">
+ <?dbhtml filename="the_design_view.html"?>
+ <title>The Design Mode</title>
+ <para>One more way to edit your file is to use <property moreinfo="none">Design mode</property>. You can
+ see it in the next picture:</para>
+ <figure float="0">
+ <title>The Design Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As you can see above, this mode looks like a table in the first column of which
+ the process structure is performed. Here, you can also insert, remove and edit
+ elements or attributes, moreover add comments and instructions. Their values can be
+ directly edited in the second column of the Design mode table.</para>
+ <para>For instance, let’s add a comment on the second transition. For that, you should
+ bring up the context menu for it and choose <emphasis>
+ <property moreinfo="none">Add Before > Comment</property>. </emphasis></para>
+
+ <figure float="0">
+ <title>Adding a Comment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Then, we can put the text <emphasis>This transition leads to the end
+ state</emphasis> in the right column as its value.</para>
+
+ <figure float="0">
+ <title>Comment is added</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="deployment_mode">
+ <?dbhtml filename="the_deployment_view.html"?>
+ <title>The Deployment Mode</title>
+ <para>Finally, to adjust the deployment settings of the project you should switch on to
+ the tab that opens the <property moreinfo="none">Deployment mode</property>. On the picture below
+ the <property moreinfo="none">Deployment mode</property> is performed with default settings. Here,
+ you can easily modify them or, if the settings won't match your needs, to
+ reset defaults. </para>
+ <figure float="0">
+ <title>The Deployment Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/the_views/the_views_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The button <emphasis>
+ <property moreinfo="none">Test Connections</property>
+ </emphasis> is necessary to make sure whether all your settings are valid before
+ deploying the process.</para>
+ <para>Now that we've seen how to work with <property moreinfo="none">jPDL
+ perspective</property>, let's pass on to the project testing.</para>
+ </section>
+ </section>
+</chapter>
+
+<chapter id="Test_Drive_Proc_Development" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml" xreflabel="Test_Drive_Proc_Development">
+ <?dbhtml filename="Test_Drive_Proc_Development.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Test Driven Process Development</title>
+
+ <para> One of the most important advantages of JBoss jBPM's lightweight approach to BPM
+ and workflow management is that developers can easily leverage their usual programming
+ skills and techniques. One of these well-known techniques is Unit Testing and Test Driven
+ Development. </para>
+ <para>In this chapter we will show how developers, making use of the JBoss jBPM GPD, can use a
+ technique we have baptized <property moreinfo="none">Test Driven Process Development</property> to create
+ process definitions and test their correctness. </para>
+
+ <para> When creating the <emphasis>
+ <property moreinfo="none">HellojBPM</property>
+ </emphasis> project the Project Creation wizard has already put in place all the library
+ requirements we need to start writing the jBPM unit tests. They are contained in the jBPM
+ Library container and the most important of them is the <emphasis>
+ <property moreinfo="none">.jar</property>
+ </emphasis> file containing the core jBPM classes. While working on the project you could
+ find them all in the <property moreinfo="none">Package Explorer</property>.</para>
+
+ <figure float="0">
+ <title>The jBPM Libraries</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It must be noted that it is possible to change the location of the core jBPM installation
+ by changing the preference settings. More on this <link linkend="change_core_jbpm_inst">see
+ later</link> in this book.</para>
+
+ <para> With that extra knowledge on the project settings, you can create your first test. To do
+ this, we create the <emphasis>
+ <property moreinfo="none">com.jbay</property>
+ </emphasis> package in the <emphasis>
+ <property moreinfo="none">test/java</property>
+ </emphasis> source folder. Then we bring up the context menu on this package and select <emphasis>
+ <property moreinfo="none">New > Other...</property>
+ </emphasis></para>
+
+ <figure float="0">
+ <title>Call the JUnit Test Case Creation wizard</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> And then <emphasis>
+ <property moreinfo="none">Java > JUnit > JUnit Test Case</property>
+ </emphasis> to call the specialized JUnite Test case creation wizard.</para>
+ <figure float="0">
+ <title>Call the JUnit Test Case Creation wizard</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The wizard looks as follows:</para>
+
+ <figure float="0">
+ <title>Create Test Dialog</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>By default JUnite 3 version of testing framework is selected. Of course, you can choose
+ new advanced JUnit 4 version. In this case you'll be prompted to add new JUnit
+ Library to your build path. To add it automatically just click on the appropriate link. In
+ the <emphasis>
+ <property moreinfo="none">Class under test</property>
+ </emphasis> section you can specify the class to test.</para>
+
+ <figure float="0">
+ <title>A First Test Scenario</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Then, we call the test class <emphasis>
+ <property moreinfo="none">HelloTest</property>
+ </emphasis> and press <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button to complete.</para>
+
+ <para> Next, we should write a simple test scenario as shown on the next figure. Let's
+ study the code of this test case. </para>
+
+ <figure float="0" id="hello_test">
+ <title>A First Test Scenario</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_6.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In the first line of the method, a jBPM process archive object is created. We use a
+ constructor accepting the filename of the archive. In our case it is the <emphasis>
+ <property moreinfo="none">hello</property>
+ </emphasis> file we created earlier and which lives in the <emphasis>
+ <property moreinfo="none">src/main/jpdl</property>
+ </emphasis> folder of our project. After asserting that this object is really created, we
+ extract a process definition object from it. This object is fed to the constructor of a
+ process instance object. We have a process instance object, but this process is not yet
+ started, so we can safely assert that its root token still resides in the start node. After
+ signalling the token will move to the next state and the process will be in the <emphasis>
+ <property moreinfo="none">auction</property>
+ </emphasis> state. Finally another signal will end the process. </para>
+
+
+ <para> After writing this test we can check whether it works as expected by running it .</para>
+
+ <figure float="0">
+ <title>Running the Process Test</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_7.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>All went well as we have a green light:</para>
+
+ <figure float="0">
+ <title>Successful Test Run</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_8.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Of course, this simple scenario was not very interesting, but the purpose of it was to
+ show how you can reuse your development skills in a very straightforward way when doing
+ process development. To see how more interesting processes and process test
+ scenario's can be developed, we suggest you to read the <ulink url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink> and to
+ study the API reference. You can find it in the jBPM download folder. (To get started we
+ downloaded jbpm-jpdl-3.2.2 in <link linkend="jboss_jbpm_runtime_installation">the second
+ chapter</link>. You should just remember where you extracted it.) All we've mentioned are in the 'javadoc- *' subfolders of the 'doc' folder.
+ Moreover, some more examples will be given later in this book.</para>
+
+</chapter>
+
+
+<chapter id="The_JBoss_jBPM_Int_Mech" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml" xreflabel="The_JBoss_jBPM_Int_Mech">
+ <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Actions : The JBoss jBPM Integration Mechanism</title>
+
+ <para> In this chapter we will show how to do software integration with <property moreinfo="none">JBoss
+ jBPM</property>. The standard mechanism to implement this is to wrap the functionality you
+ want to integrate in a class that implements the <emphasis>
+ <property moreinfo="none">ActionHandler</property>
+ </emphasis> interface. In order to demonstrate it let's specify Hello World action for our
+ process.</para>
+
+ <section>
+ <title>Creating a Hello World Action</title>
+
+ <para>Each Hello World process should integrate one or more Hello World actions, so this is
+ what we will be doing. We can integrate custom code at different points in the process
+ definition. To do this we have to specify an action handler, represented by an
+ implementation of the <emphasis>
+ <property moreinfo="none">ActionHandler</property>
+ </emphasis> interface, and attach this piece of code to a particular event. These events
+ are amongst others, going over a transition, leaving or entering nodes, after and before
+ signalling. </para>
+
+ <para> To make things a little bit more concrete, let's create a new class called <emphasis>
+ <property moreinfo="none">HelloActionHandler</property>.
+ </emphasis> For that firstly we'll create a new package <emphasis>
+ <property moreinfo="none">com.jbay.action</property>
+ </emphasis> in the <emphasis>
+ <property moreinfo="none">src/java/main</property>
+ </emphasis> folder of our project. Then, we should call New Class Creation wizard as
+ usual by right-clicking and navigating <emphasis>
+ <property moreinfo="none">New > Class</property>.
+ </emphasis> </para>
+
+ <figure float="0">
+ <title>Creating HelloActionHendler Class</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Notice that two first gaps have been filled automatically. Here, instead of <emphasis>
+ <property moreinfo="none">Package</property>
+ </emphasis> option <emphasis>
+ <property moreinfo="none">Enclose type</property>
+ </emphasis> option can be selected where a type in which to enclose a new class should
+ be specified.</para>
+
+ <para>In our case, we leave everything as it is, just type <emphasis>
+ <property moreinfo="none">HelloActionHandler</property>
+ </emphasis> as a name of new class and add <emphasis>
+ <property moreinfo="none">org.jbpm.graph.ActionHendler</property>
+ </emphasis> interface as it's shown in the picture above.</para>
+
+ <para>Thus, our <emphasis>
+ <property moreinfo="none">HelloActionHandler</property>
+ </emphasis> implements the <emphasis>
+ <property moreinfo="none">ActionHandler</property>
+ </emphasis> interface including the <emphasis>
+ <property moreinfo="none">execute</property>
+ </emphasis> method as shown in the next figure. Here, we add a variable named <emphasis>
+ <property moreinfo="none">greeting</property>
+ </emphasis> to the collection of process variables and put a message in it :
+ <emphasis>"Hello from ActionHandler"</emphasis>. </para>
+
+ <figure float="0">
+ <title>A Simple Hello Action</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Now, as we have <emphasis>
+ <property moreinfo="none">HelloActionHandler</property>
+ </emphasis> class defined, let's explore how we can handle it.</para>
+ </section>
+
+ <section>
+ <title>Integrating the Hello World Action</title>
+
+ <para>The main purpose of this chapter is to provide you with the steps associating our
+ Hello World action with a particular event and test the correctness of our actions as
+ well.</para>
+
+ <para> As good Testcity citizens we will first create a Unit Test that proves the behaviour
+ we want to achieve by adding the <emphasis>
+ <property moreinfo="none">ActionHandler</property>
+ </emphasis> to the process. So we implement another test.</para>
+
+ <para>At first, let's return to the
+ code we already saw <link linkend="hello_test">in the previous chapter</link> and add new test method <emphasis>
+ <property moreinfo="none">testActionHendler</property></emphasis> to it. </para>
+
+ <figure float="0">
+ <title>Create the Hello Action Test</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>We assert
+ that no variable called <emphasis>
+ <property moreinfo="none">greeting</property>
+ </emphasis> exist. Then we give the process a signal to move it to the auction state. We
+ want to associate the execution of the action with the event of going over the
+ transition from the start state to the auction state. So after the signal, the process
+ should be in the auction state as in the previous scenario. But moreover, the <emphasis>
+ <property moreinfo="none">greeting</property>
+ </emphasis> variable should exist and contain the string <emphasis>"Hello from
+ ActionHandler"</emphasis>. That's what we assert in the last lines of the test
+ method.</para>
+
+
+
+ <para> Running the tests now results in a failure. The point is that we did not associate
+ the action with any particular event in the process definition, so the process variable
+ did not get set. </para>
+
+ <figure float="0">
+ <title>Test Results Before Integration</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Let's do something about it and add an action to the first transition of our
+ sample process. To do this you can use the Actions tab in the Properties Editor that is
+ under the graphical canvas. Bring up the popup menu of the action element container and
+ chose New Action as it's shown on the figure below. The other way to add an action
+ to the transition is simply to use the dropdown menu that is available under the action
+ icon in the right upper corner of the Properties View.</para>
+
+ <figure float="0">
+ <title>Adding an Action to a Transition</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After adding the action a tabbed view with three pages will appear.</para>
+
+ <figure float="0">
+ <title>Configuration Dialog for an Action</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The first of these three pages allows you to give the Action a name. The last page
+ contains some advanced attributes such as whether the Action is asynchronous. The
+ Details page is the most important. It allows to choose and configure the actual action
+ handler implementation. </para>
+
+ <figure float="0">
+ <title>The Details page of an Action Configuration Dialog</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>Clicking on the <emphasis>
+ <property moreinfo="none">Search...</property>
+ </emphasis> button brings us to a Choose Class dialog.</para>
+
+
+ <figure float="0">
+ <title>The Choose Action Handler Dialog</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para> We choose our previously created 'HelloActionHandler' class and
+ push the <property moreinfo="none">OK</property> button. After the selection of the action handler for
+ the action, we can run the test and observe it gives us a green light.</para>
+
+ <figure float="0">
+ <title>Test Results</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">There we are. The above objective has been achieved.</diffmk:wrapper></para>
+ </section>
+
+ <section>
+ <title> Integration Points</title>
+
+ <para> The different integration points in a process definition are thoroughly documented in
+ the <ulink url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink>. Instance nodes can contain many action
+ elements. Each of these will appear in the Action element list of the Actions tab. But
+ each Action also has a properties view of itself. You can navigate to this view by
+ selecting the added Action in the outline view. </para>
+
+ </section>
+
+</chapter>
+
+
+<chapter id="Quick_Howto_Guide" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml" xreflabel="Quick_Howto_Guide">
+ <?dbhtml filename="Quick_Howto_Guide.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>jBPM</keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Quick Howto Guide</title>
+
+ <para>This chapter contains additional information related to the <property moreinfo="none">JBoss
+ jBPM</property>.</para>
+
+ <section id="change_core_jbpm_inst">
+ <title>Change the Default Core jBPM Installation</title>
+
+ <para> You can change the default <property moreinfo="none">jBPM</property> installation by means of the
+ Eclipse preference mechanism. Open the Preferences dialog by selecting <emphasis>
+ <property moreinfo="none">Window > Preferences</property>
+ </emphasis> and select the <emphasis>
+ <property moreinfo="none">JBoss jBPM > Runtime Location</property>
+ </emphasis> category. Using this page you can add multiple <property moreinfo="none">jBPM</property>
+ installation locations and change the default one. The default installation is used for
+ the classpath settings when creating a new Process Project. Changing the preferences has
+ no influence on already created projects. Getting rid of a <property moreinfo="none">jBPM</property>
+ installation that's being referenced by a project however will cause the
+ classpath to contain errors. </para>
+
+
+ <figure float="0">
+ <title>The jBPM Preferences Page</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section>
+ <title>Configuring Task Nodes</title>
+
+ <para>Here, we'll examine how you can configure the Task nodes in jBPM jPDL GPD.</para>
+
+ <para> You can add Tasks to Task nodes and then configure them in a similar manner as the
+ Action configuration mechanism. Let's consider the process definition similar
+ to the previous one that contains three nodes: Start state, Task node and End state. The
+ <property moreinfo="none">Properties view</property> for selected Task node includes several tabs. </para>
+
+ <figure float="0">
+ <title>The Properties View of the selected Task Node</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>We should choose the Task tab and then bring up the context menu or click the button
+ in the top right corner of the view to add a Task to our Task node.</para>
+
+ <figure float="0">
+ <title>Adding a Task to the Task Node</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Every added Task has its own configuration possibilities. You can access them through
+ the <property moreinfo="none">Properties view</property> as well.</para>
+
+ <figure float="0">
+ <title>The Task properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The <property moreinfo="none">General page</property> is a place where you can specify the name of a
+ Task and its description. For instance, let it be <emphasis>
+ <property moreinfo="none">approve oder</property>
+ </emphasis> with appropriate description that you can see in the figure below.</para>
+
+ <figure float="0">
+ <title>The Task General Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Now, look at <property moreinfo="none">Details page</property>. First, you should specify the due date
+ that is a mandatory property for the Task. The due date is the date on which the task
+ should be accomplished. Here you can also set a Task priority as well as signalling,
+ notifying or blocking. The <emphasis>
+ <property moreinfo="none">Blocking</property>
+ </emphasis> attribute indicates that the process will not be able to continue if this
+ task is still unaccomplished. The <emphasis>
+ <property moreinfo="none">Generate Form...</property>
+ </emphasis> button is for creating a simple task form that can be rendered by the jBPM
+ console.</para>
+
+ <figure float="0">
+ <title>The Task Details Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>For our example, we specify the due date as 2 business days, choose the high priority
+ and also check the <emphasis>
+ <property moreinfo="none">Signalling</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">Notify</property>
+ </emphasis> attributes. It means that the Task should be accomplished in 2 business days
+ and the assignee will be notified by email when the task is assigned. To specify how the
+ Task should be assigned switch on to the <property moreinfo="none">Assignment page</property>.</para>
+
+ <figure float="0">
+ <title>The Task Assignment Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the <property moreinfo="none">Reminder page</property> you can specify whether the assignee will be reminded of the task
+ that awaits him.</para>
+
+ <figure float="0">
+ <title>The Task Reminder Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In our case, the assignee will be reminded by email after two business hours and
+ continue to get reminding every business hour after that.</para>
+ <para>In the next figure you can see our configuring generated into XML.</para>
+ <figure float="0">
+ <title>The Task Reminder Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>We hope, our guide will help you to get started with the jPDL process language and jBPM
+ workflow on the whole. Besides, for additional information you are welcome on <diffmk:wrapper diffmk:change="changed">JBoss forum</diffmk:wrapper></para>.</section>
+ </chapter>
+</book>
15 years, 2 months
- 1
- 0
JBoss Tools SVN: r15191 - branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:31:41 -0400 (Mon, 11 May 2009)
New Revision: 15191
Added:
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/master_output.xml
Removed:
branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Deleted: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/master_output.xml 2009-05-11 16:27:29 UTC (rev 15190)
+++ branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/master_output.xml 2009-05-11 16:31:41 UTC (rev 15191)
@@ -1,184 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
-"http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd"
-
-[<!ENTITY overview SYSTEM "modules/overview.xml">
-<!ENTITY bpmn2jpdl SYSTEM "modules/bpmn2jpdl.xml">
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>BPMN Convert User Guide</title>
- <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author>
- <pubdate>October 2008</pubdate>
- <copyright>
- <year>2008</year>
- <year diffmk:change="added"><diffmk:wrapper diffmk:change="added">2009</diffmk:wrapper></year>
- <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.0.0.GA
- </diffmk:wrapper></releaseinfo>
-<abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/bpmn_convert_guide/p...">PDF version</ulink>
- </para>
-</abstract>
-
-
- </bookinfo>
-
- <toc></toc>
-
-<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/converter_ref/en/modules/overview.xml">
- <title>BPMN Convert Overview</title>
-
- <para>JBoss BPMN Convert module is a tool. Users can use it to translate a BPMN file to something else.</para>
- <para>The BPMN file may be written by hands or by some editors. In this guide, we use STP BPMN editor to draw a BPMN file.</para>
- <para>As a part of JBoss tools, this module realizes BPMN -> JPDL translation. Users can get a basic JPDL file from a BPMN file by using this module.</para>
-
-</chapter>
-
-<chapter id="bpmn2jpdl" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml">
- <title>Translate a BPMN file to a JPDL file</title>
- <para>In this chapter we provide you with the necessary steps to translate a BPMN file to a JPDL file.</para>
-
- <section id="createproject">
- <title>Creating a project</title>
- <para>Before creating a bpmn file, you should have a Project created.</para>
- <para>Create a project by
- <emphasis><property moreinfo="none">New > Project... > Project</property></emphasis>
- . Enter the following information:
- </para>
- <itemizedlist>
- <listitem>
- <para>Project Name: test</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>A Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpmnconvert_bpmn2jpdl_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on the <property moreinfo="none">Finish</property> button.</para>
- </section>
-
- <section id="createbpmnfile">
- <title>Creating a bpmn file by STP BPMN editor</title>
- <para>Create a bpmn diagram file by
- <emphasis><property moreinfo="none">New > Others... > Bpmn Diagram</property></emphasis>
- . Enter the following information:
- </para>
- <itemizedlist>
- <listitem>
- <para>File Name: test</para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Create BPMN Diagram</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpmnconvert_bpmn2jpdl_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on the <property moreinfo="none">Finish</property> button.</para>
- <para>Open the test.bpmn_diagram file by double-click it.</para>
- <para>Draw the bpmn diagram using STP BPMN editor. If you do not know how to use STP BPMN editor, please go to web site: www.eclipse.org/stp to get the information about STP BPMN editor.</para>
- </section>
-
- <section id="bpmntojpdl">
- <title>Exporting a bpmn file to some jpdl files</title>
- <para>A BPMN file may include more than one pool. Every pool can be mapped to a corresponding JPDL file.</para>
- <itemizedlist>
- <listitem>
- <para>Select 'test.bpmn' file and right-click it. Open the export wizard by
- <emphasis><property moreinfo="none">Export... > BPMN Export > BPMN -> JPDL</property></emphasis>
- .
- </para>
- <figure float="0">
- <title>BPMN Export</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpmnconvert_bpmn2jpdl_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on the <property moreinfo="none">Next</property> button.</para>
- </listitem>
- <listitem>
- <para>Select the BPMN file that you want to translate.
- </para>
- <figure float="0">
- <title>Choose a BPMN file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpmnconvert_bpmn2jpdl_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on the <property moreinfo="none">Next</property> button.</para>
- </listitem>
- <listitem>
- <para>Select the Pools of BPMN that you want to translate.
- </para>
- <figure float="0">
- <title>Choose BPMN Pools</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpmnconvert_bpmn2jpdl_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on the <property moreinfo="none">Next</property> button.</para>
- </listitem>
- <listitem>
- <para>In this page, You may get error messages or warning messages that occured during the conversion. If no any messages, this page will be skipped.
- </para>
- <figure float="0">
- <title>Show Messages</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpmnconvert_bpmn2jpdl_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on the <property moreinfo="none">Next</property> button.</para>
- </listitem>
- <listitem>
- <para>Select the target location to save the generated JPDL files.
- </para>
- <figure float="0">
- <title>Target Location</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpmnconvert_bpmn2jpdl_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Overwrite existing resources: if you don't want to overwrite existing resources, please keep uncheck this checkbox.</para>
- </listitem>
- </itemizedlist>
- <para>Click on the <property moreinfo="none">Finish</property> button.</para>
- <para>Then the JPDL files are generated to the target location.</para>
- </listitem>
- </itemizedlist>
- <para>The generated files look like this: </para>
- <figure float="0">
- <title>The Generated JPDL Files</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/bpmnconvert_bpmn2jpdl_8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
-
-</chapter>
-</book>
Copied: branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/master_output.xml (from rev 15128, trunk/jbpm/docs/converter_ref/en/master_output.xml)
===================================================================
--- branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/jbpm/docs/converter_ref/en/master_output.xml 2009-05-11 16:31:41 UTC (rev 15191)
@@ -0,0 +1,166 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd"
+
+[<!ENTITY overview SYSTEM "modules/overview.xml">
+<!ENTITY bpmn2jpdl SYSTEM "modules/bpmn2jpdl.xml">
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>BPMN Convert User Guide</title>
+ <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author>
+ <pubdate>October 2008</pubdate>
+ <copyright>
+ <year>2008</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo>
+ Version: 1.0.0.GA
+ </releaseinfo>
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/bpmn_convert_guide/p...">PDF version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+
+ <toc></toc>
+
+<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/converter_ref/en/modules/overview.xml">
+ <title>BPMN Convert Overview</title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This chapter gives you a short overview of JBoss BPMN Convert module</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">JBoss BPMN Convert module is a tool used for a BPMN file translation</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">As a part of JBoss tools, JBoss BPMN Convert module implements BPMN -> JPDL translation. You can get a basic JPDL file from a BPMN file by using this module.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">The BPMN file may be written by hands or with the help of some editors. In this guide, we use STP BPMN editor to draw a BPMN file.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can download the editor which is included into BPMN Modeler from Eclipse download or update site. On the </diffmk:wrapper><ulink diffmk:change="added" url="http://www.eclipse.org/bpmn"><diffmk:wrapper diffmk:change="added">Eclipse BPMN project page</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> you can find the necessary links and other related information</diffmk:wrapper></para>
+ </chapter>
+
+<chapter id="bpmn2jpdl" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml">
+ <title><diffmk:wrapper diffmk:change="changed">Translate a Bpmn file to a JPDL file</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">In this chapter we provide you with the necessary steps to translate a Bpmn file to a JPDL file.</diffmk:wrapper></para>
+
+ <section id="createproject">
+ <title>Creating a project</title>
+ <para><diffmk:wrapper diffmk:change="changed">Before creating a Bpmn file, you should have a Project created.</diffmk:wrapper></para>
+ <para>Create a project by
+ <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New > Project... > General > Project</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed">. Enter the following information:
+ </diffmk:wrapper></para>
+ <para>Project Name: test</para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Creating a Project</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpmnconvert_bpmn2jpdl_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on the <property moreinfo="none">Finish</property> button.</para>
+ </section>
+ <section id="createbpmnfile">
+ <title><diffmk:wrapper diffmk:change="changed">Creating a Bpmn File by STP BPMN Editor</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">Create a BPMN diagram file by
+ </diffmk:wrapper><emphasis><property moreinfo="none">New > Others... > Bpmn Diagram</property></emphasis>
+ . Enter the following information:
+ </para>
+ <para>File Name: test</para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Creating BPMN Diagram</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpmnconvert_bpmn2jpdl_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on the <property moreinfo="none">Finish</property> button.</para>
+ <para>Open the test.bpmn_diagram file by double-click it.</para>
+ <para><diffmk:wrapper diffmk:change="added">Draw the Bpmn diagram using STP BPMN editor. If you do not know how to use STP BPMN editor, please visit </diffmk:wrapper><ulink diffmk:change="added" url="http://www.eclipse.org/bpmn/"><diffmk:wrapper diffmk:change="added">BPMN project page for details</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </section>
+ <section id="bpmntojpdl">
+ <title><diffmk:wrapper diffmk:change="changed">Exporting a Bpmn File to Jpdl files</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">A Bpmn file may include more than one pool. Every pool can be mapped to a corresponding Jpdl file.</diffmk:wrapper></para>
+ <itemizedlist>
+ <listitem>
+ <para>Select 'test.bpmn' file and right-click it. Open the export wizard by
+ <emphasis><property moreinfo="none">Export... > BPMN Export > BPMN -> JPDL</property></emphasis>
+ .
+ </para>
+ <figure float="0">
+ <title>BPMN Export</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpmnconvert_bpmn2jpdl_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on the <property moreinfo="none">Next</property> button.</para>
+ </listitem>
+ <listitem>
+ <para>Select the BPMN file that you want to translate.
+ </para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Choosing a BPMN File</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpmnconvert_bpmn2jpdl_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on the <property moreinfo="none">Next</property> button.</para>
+ </listitem>
+ <listitem>
+ <para>Select the Pools of BPMN that you want to translate.
+ </para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Choosing BPMN Pools</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpmnconvert_bpmn2jpdl_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on the <property moreinfo="none">Next</property> button.</para>
+ </listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="changed">On the next page, you may get error or warning messages that occurred during the conversion. If there are no messages, this page is skipped.
+ </diffmk:wrapper></para>
+ <para>Click on the <property moreinfo="none">Next</property> button.</para>
+ </listitem>
+ <listitem>
+ <para>Select the target location to save the generated JPDL files.
+ </para>
+ <figure float="0">
+ <title>Target Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpmnconvert_bpmn2jpdl_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="changed">If you'd like to overwrite existing resources,check this "Overwrite existing resources" checkbox.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+ <para>Click on the <property moreinfo="none">Finish</property> button.</para>
+ <para>Then the JPDL files are generated to the target location.</para>
+ </listitem>
+ </itemizedlist>
+ <para>The generated files look like this: </para>
+ <figure float="0">
+ <title>The Generated JPDL Files</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/bpmnconvert_bpmn2jpdl_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We hope, this guide helped you to get started with the JBoss BPMN Convert module. Besides, for additional information you are welcome on </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201"><diffmk:wrapper diffmk:change="added">JBoss forum</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </section>
+
+</chapter>
+</book>
15 years, 2 months
- 1
- 0
JBoss Tools SVN: r15190 - in branches/jbosstools-3.0.x/hibernatetools/docs/reference: en/images/plugins and 1 other directories.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:27:29 -0400 (Mon, 11 May 2009)
New Revision: 15190
Removed:
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_23.png
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_24.png
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_25.png
Modified:
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/codegen.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/plugins.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/preface.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/setup.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Deleted: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_23.png
===================================================================
(Binary files differ)
Deleted: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_24.png
===================================================================
(Binary files differ)
Deleted: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_25.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/codegen.xml
===================================================================
--- branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/codegen.xml 2009-05-11 16:27:17 UTC (rev 15189)
+++ branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/codegen.xml 2009-05-11 16:27:29 UTC (rev 15190)
@@ -353,7 +353,7 @@
</emphasis> attributes, unless you are defining a class without bi-directional
associations.</para>
- <para>We recomend instead to add the <emphasis>
+ <para>We recommend instead to add the <emphasis>
<property>meta</property>
</emphasis> attributes at the property level:</para>
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/plugins.xml
===================================================================
--- branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/plugins.xml 2009-05-11 16:27:17 UTC (rev 15189)
+++ branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/plugins.xml 2009-05-11 16:27:29 UTC (rev 15190)
@@ -268,8 +268,8 @@
<entry>
<para>DTP provided connection that you can use instead of what is in cfg.xml and jpa
- persistence.xml. It's possible to use already configured connection or
- specify a new one here.</para>
+ persistence.xml. It's possible to use either already configured hibernate or
+ JPA connection or specify a new one here.</para>
</entry>
<entry>
@@ -807,7 +807,7 @@
</entry>
<entry>
- <para>A table that has a multi-colum primary key a <composite-id>
+ <para>A table that has a multi-column primary key a <composite-id>
mapping will always be created. If this option is enabled and there are matching
foreign-keys each key column is still considered a 'basic' scalar (string, long,
etc.) instead of a reference to an entity. If you disable this option a
@@ -838,27 +838,24 @@
strategy.</para>
</entry>
</row>
-
+
<row>
<entry>
<para>Detect one-to-one associations</para>
</entry>
-
+
<entry>
- <para>
- Reverse engineering detects one-to-one associations via primary key and both hbm.xml and annotation generation generates the proper code for it.
- </para>
- <para>
- The detection is enabled by default (except for Seam 1.2 and Seam 2.0) reverse engineering.
- For Hibernate Tools generation there is a checkbox to disable if not wanted.
-
- </para>
+ <para> Reverse engineering detects one-to-one associations via primary key and both
+ hbm.xml and annotation generation generates the proper code for it. </para>
+ <para> The detection is enabled by default (except for Seam 1.2 and Seam 2.0)
+ reverse engineering. For Hibernate Tools generation there is a checkbox to disable
+ if not wanted. </para>
</entry>
</row>
-
-
-
+
+
+
<row>
<entry>
<para>Use custom templates</para>
@@ -1240,13 +1237,13 @@
<tip>
<title>Tip:</title>
- <para>If the property is a directory, it is
- possible to browse directories in the Value field.</para>
+ <para>If the property is a directory, it is possible to browse directories in the Value
+ field.</para>
</tip>
-
+
<figure>
<title>Specifying the Property Value</title>
-
+
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_8b.png"/>
@@ -1899,53 +1896,116 @@
support Eclipse Dali integration what now makes it possible to use a Hibernate as a complete
JPA development platform.</para>
- <para>When starting your new JPA project from <emphasis>
- <property>New > Other... > JPA > JPA Project</property>
+ <para>When starting a new JPA project from <emphasis>
+ <property>New > Other > JPA > JPA Project</property>
</emphasis> (or simply <emphasis>
- <property>New > JPA Project</property>
- </emphasis> in <property>JPA Perspective</property>) on the JPA Facet page you'll be
- prompted to choose Hibernate as a target platform.</para>
+ <property>New > JPA Project</property>
+ </emphasis> in <property>JPA Perspective</property>), the first wizard page looks as
+ follows.</para>
<figure>
+ <title>Starting JPA Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/dali_integration1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It's possible here to select a target runtime and change the project
+ configuration, or you can leave everything as it is.</para>
+
+ <para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the
+ proper database connection, if it is defined, or add a new one by clicking the <emphasis>
+ <property>Add connection</property>
+ </emphasis> link.</para>
+
+ <para>Hitting <emphasis>
+ <property>Finish</property>
+ </emphasis> will generate the project.</para>
+
+ <figure>
<title>Targeting at Hibernate Platform</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/plugins/plugins_23.png"/>
+ <imagedata fileref="images/plugins/dali_integration2.png"/>
</imageobject>
</mediaobject>
</figure>
+ <note>
+ <title>Note:</title>
+
+ <para>Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, a
+ Hibernate Console Configuration for the project is created automatically when the
+ wizard finishes its work. It allows a full usage of <property>Hibernate Tools</property>
+ features without additional setup.</para>
+ </note>
+
<para>By enabling Hibernate platform specific features you can now generate DDL and Entities.
For that find <emphasis>
- <property>JPA Tools > Generate DDL.../Generate Entities...</property>
+ <property>JPA Tools > Generate DDL/Generate Entities</property>
</emphasis> options in the context menu of your JPA project.</para>
<figure>
<title>Generate DDL/Entities</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/plugins/plugins_24.png"/>
+ <imagedata fileref="images/plugins/dali_integration3.png"/>
</imageobject>
</mediaobject>
</figure>
- <para>The Generate DDL/Entities wizards first will ask you to choose the <property>Console
- Configuration</property>.</para>
+ <note>
+ <title>Note:</title>
+ <para>Please, remember to put the proper database driver to the classpath of your
+ project.</para>
+ </note>
+
+ <para>The <property>Generate DDL/Entities wizards</property> first will ask you to choose the directory where all
+ output will be written.</para>
+
<figure>
<title>Generate Entities Wizard</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/plugins/plugins_25.png"/>
+ <imagedata fileref="images/plugins/dali_integration4.png"/>
</imageobject>
</mediaobject>
</figure>
- <note>
- <title>Note:</title>
+ <para>To generate entities you can use:</para>
- <para>Please note, currently the wizards require that you have a <link linkend="console_conf"
- >Hibernate Console Configuration</link> already configured.</para>
- </note>
+ <itemizedlist>
+ <listitem>
+ <para>a Hibernate Console Configuration (proposed by default)</para>
+ <para>Just make sure that the <emphasis>
+ <property>Use Console Configuration</property>
+ </emphasis> checkbox is selected and choose a needed configuration from the <emphasis>
+ <property>Console
+ configurations</property></emphasis> list box.</para>
+
+ <figure>
+ <title>Generate Entities Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/dali_integration5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+
+ <itemizedlist>
+ <listitem>
+ <para>or a DTP connection directly</para>
+ <para>Just uncheck <emphasis>
+ <property>Use Console Configuration</property>
+ </emphasis> and adjust database settings.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/preface.xml
===================================================================
--- branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/preface.xml 2009-05-11 16:27:17 UTC (rev 15189)
+++ branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/preface.xml 2009-05-11 16:27:29 UTC (rev 15190)
@@ -143,9 +143,9 @@
<section>
<title>Other relevant resources on the topic</title>
- <para>Hibernate Tools page on the <ulink url="http://www.hibernate.org/255.html">hibernate.org</ulink>.</para>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://www.jboss.com/products/devstudio/docs">here</ulink>.</para>
- <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
+ <!--para>Hibernate Tools page on the <ulink url="http://www.hibernate.org/255.html">hibernate.org</ulink>.</para-->
+ <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
+ <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml
===================================================================
--- branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2009-05-11 16:27:17 UTC (rev 15189)
+++ branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2009-05-11 16:27:29 UTC (rev 15190)
@@ -61,13 +61,13 @@
<hibernate-reverse-engineering>
<type-mapping>
- <!-- jdbc-type is name fom java.sql.Types -->
+ <!-- jdbc-type is name for java.sql.Types -->
<sql-type jdbc-type="VARCHAR" length='20' hibernate-type="SomeUserType" />
<sql-type jdbc-type="VARCHAR" length='1' hibernate-type="yes_no" />
- <!-- length, scale and precision can be used to specify the mapping precisly -->
+ <!-- length, scale and precision can be used to specify the mapping precisely -->
<sql-type jdbc-type="NUMERIC" precision='1' hibernate-type="boolean" />
<!-- the type-mappings are ordered. This mapping will be consulted last,
- thus overriden by the previous one if precision=1 for the column -->
+ thus overridden by the previous one if precision=1 for the column -->
<sql-type jdbc-type="NUMERIC" hibernate-type="long" />
</type-mapping>
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/setup.xml
===================================================================
--- branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/setup.xml 2009-05-11 16:27:17 UTC (rev 15189)
+++ branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/setup.xml 2009-05-11 16:27:29 UTC (rev 15190)
@@ -3,31 +3,35 @@
<title>Download and install Hibernate Tools</title>
<para><property>Hibernate Tools</property> can be used "standalone" via Ant
- 1.6.x or fully integrated into an Eclipse 3.3.x + WTP 2.x based IDE, such as <property>JBoss
- Tools</property> or a default Eclipse 3.3.x + WTP 2.x installation. The following describes
- the install steps in these environments.</para>
+ 1.6.x or fully integrated into an Eclipse + WTP based IDE, such as <property>JBDS/JBoss
+ Tools</property>, or a default Eclipse + WTP installation. The following sections describe the
+ install steps in these environments.</para>
+ <note>
+ <title>Note:</title>
+ <para>The <property>Hibernate Tools 3.2.4.GA</property> (the current release version) requires
+ Eclipse Ganymede 3.4.2.</para>
+ </note>
+
<section>
<title>JBoss Tools</title>
- <para><property>JBoss Tools 2.x</property> includes <property>Hibernate Tools</property> and
- thus nothing is required besides <ulink url="http://labs.jboss.com/tools/download/index.html"
- >downloading</ulink> and <ulink
- url="&gsglink;#JBossToolsInstall"
- >installing JBoss Tools</ulink>. If you need to update to a newer version of the
- <property>Hibernate Tools</property> just follow the instructions in the Eclipse IDE
- section.</para>
+ <para><property>JBoss Tools 3.0.0.GA</property> (the latest release) includes
+ <property>Hibernate Tools 3.2.4.GA</property> and thus nothing is required besides <ulink
+ url="http://jboss.org/tools/download/stable/3_0_0_GA.html">downloading</ulink> and <ulink
+ url="&gsglink;#JBossToolsInstall">installing JBoss Tools</ulink>. If you need to update
+ to a newer version of the <property>Hibernate Tools</property> just follow the instructions in
+ the Eclipse IDE section.</para>
</section>
<section>
<title>Eclipse IDE</title>
- <para>To install into any <property>Eclipse 3.3.x</property> based Eclipse IDE you can either
- download the <property>Hibernate Tools</property> distribution from the <ulink
- url="http://www.hibernate.org/6.html">Hibernate website</ulink> or use the <ulink
- url="http://download.jboss.org/jbosstools/updates/stable/">JBoss Tools Update Site</ulink>
- (see also <ulink url="http://tools.hibernate.org">http://tools.hibernate.org</ulink> for links
- to the update site).</para>
+ <para>To install the <property>Hibernate Tools</property> into any <property>Eclipse 3.4.x</property> based IDE you
+ can either download the <property>Hibernate Tools</property> distribution from the <ulink
+ url="http://jboss.org/tools/download/stable/3_0_0_GA.html">JBoss Tools download page</ulink>
+ or from the <ulink url="http://download.jboss.org/jbosstools/updates/stable/">JBoss Tools
+ Update Site</ulink>.</para>
<para>If you download the <property>Hibernate Tools</property> distribution you need to place
the <emphasis>
@@ -36,10 +40,12 @@
<property>/feature</property>
</emphasis> directory into your eclipse directory or eclipse extensions directory. Sometimes
Eclipse does not automatically detect new plugins and thus the tools will not be activated. To
- ensure eclipse sees these changes just clean up the cached plugin information by running eclipse with the <emphasis>
- <property>-clean</property></emphasis> option, e.g. <emphasis>
- <property>eclipse
- -clean</property>.</emphasis> Using the updatesite does not require any additional steps.</para>
+ ensure eclipse sees these changes just clean up the cached plugin information by running
+ eclipse with the <emphasis>
+ <property>-clean</property>
+ </emphasis> option, e.g. <emphasis>
+ <property>eclipse -clean</property>.</emphasis> Using the updatesite does not require any
+ additional steps.</para>
<note>
<title>Note:</title>
@@ -55,7 +61,7 @@
<title>Usage of Eclipse WTP</title>
<para>The <property>Hibernate Tools</property> plugins currently use <property>WTP
- 2.x</property> which at this time is the latest stable release from the Eclipse Webtools
+ 3.x</property> which at this time is the latest stable release from the Eclipse Webtools
project.</para>
<para>Because the WTP project not always have had proper versioning of their plugins there
@@ -75,8 +81,8 @@
</emphasis> and associated libraries. The libraries are included in the distribution from the
Hibernate website and the Eclipse updatesite. The libraries are located in the eclipse plugins
directory at <emphasis>
- <property>/plugins/org.hibernate.eclipse.x.x.x/lib/tools/</property></emphasis>. These libraries are 100%
- independent from the eclipse platform. How to use these via ant tasks are described in the
- <link linkend="ant">Ant Tools</link> chapter.</para>
+ <property>/plugins/org.hibernate.eclipse.x.x.x/lib/tools/</property>
+ </emphasis>. These libraries are 100% independent from the eclipse platform. How to use these
+ via ant tasks are described in the <link linkend="ant">Ant Tools</link> chapter.</para>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/hibernatetools/docs/reference/pom.xml 2009-05-11 16:27:17 UTC (rev 15189)
+++ branches/jbosstools-3.0.x/hibernatetools/docs/reference/pom.xml 2009-05-11 16:27:29 UTC (rev 15190)
@@ -77,6 +77,11 @@
<artifactId>jbosstools-docbook-xslt</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
</dependencies>
<configuration>
<sourceDocumentName>${master}</sourceDocumentName>
15 years, 2 months
- 1
- 0
JBoss Tools SVN: r15188 - in branches/jbosstools-3.0.x/esb/docs/esb_ref_guide: en and 3 other directories.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:19:33 -0400 (Mon, 11 May 2009)
New Revision: 15188
Modified:
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_editor/01_esb_tree_view.png
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_editor/04_esb_add_provider.png
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/09_esb_runtime_new.png
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master.xml
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/modules/esb_editor.xml
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/modules/esb_support.xml
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Modified: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_editor/01_esb_tree_view.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_editor/04_esb_add_provider.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/09_esb_runtime_new.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master.xml
===================================================================
--- branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master.xml 2009-05-11 16:19:15 UTC (rev 15187)
+++ branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master.xml 2009-05-11 16:19:33 UTC (rev 15188)
@@ -33,7 +33,7 @@
<holder>JBoss, a division of Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 1.1.0.GA
+ Version: 1.1.1.GA
</releaseinfo>
<abstract>
Modified: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/modules/esb_editor.xml
===================================================================
--- branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/modules/esb_editor.xml 2009-05-11 16:19:15 UTC (rev 15187)
+++ branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/modules/esb_editor.xml 2009-05-11 16:19:33 UTC (rev 15188)
@@ -77,6 +77,8 @@
</imageobject>
</mediaobject>
</figure>
+ <para>Then you can add Channels and Properties for the Providers the same way or using the forms with <property>Add</property>, <property>Edit</property> and
+ <property>Remove</property> buttons to the right.</para>
<para>You can easily add a new Service too:</para>
<figure>
@@ -281,7 +283,11 @@
</figure>
<para>In summary, this reference supplies you with all necessary information on the
- functionality that JBoss ESB Editor provides for work with JBoss ESB.</para>
+ functionality that JBoss ESB Editor provides for work with JBoss ESB.</para>
+
+ <para>We hope, this guide helped you to get started with the JBoss ESB Tools. Besides, for additional information you are welcome on <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
+
</section>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/modules/esb_support.xml
===================================================================
--- branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/modules/esb_support.xml 2009-05-11 16:19:15 UTC (rev 15187)
+++ branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/modules/esb_support.xml 2009-05-11 16:19:33 UTC (rev 15188)
@@ -70,7 +70,7 @@
<property>Next</property>
</emphasis> brings you to the ESB facet installation page where you can
specify Java Source Directory and ESB Content Directory. ESB Content Directory is a folder that contains the most of
- artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options:,
+ artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options:
</para>
<para>1. Use <emphasis>
<property>Server Supplied ESB Runtime</property>
@@ -132,18 +132,40 @@
<para> Clicking <emphasis>
<property>Next</property>
</emphasis> brings you to the wizard page where you can select a ESB project example from the example list.
- Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.</para>
- <figure>
- <title>JBoss Tools ESB Project Examples</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/06_esb_project_example.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.</para>
+ <para>Here is a list of ready examples available:</para>
+
+ <itemizedlist>
+
+ <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Example</emphasis> - demonstrates the minimal files necessary to make a basic ESB component execute as well as to prove that the ESB os properly configured.</para></listitem>
+ <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Action Example</emphasis> - demonstrates the use of multiple action invocations from a single configuration. You can use a single Action class and make multiple method calls or use multiple Action classes. </para></listitem>
+ <listitem><para><emphasis role="bold">JBoss ESB HelloWorld File Action Example</emphasis> - demonstrates using the File gateway feature of the JBoss ESB. Files that are found in a particular directory with a particular extension are sent to a JMS queue with actions for processing.</para></listitem>
+ <listitem><para><emphasis role="bold">JBoss ESB Web Service consumer1 Example</emphasis> - demonstrates how to consume a 181 Web Service in an ESB action.</para></listitem>
+ <listitem><para><emphasis role="bold">JBoss ESB Web Service producer Example</emphasis> - demonstrates how to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcessor action.</para></listitem>
+ <listitem><para><emphasis role="bold">JBoss ESB Smooks CSV -> XML Example</emphasis> - demonstrates how to transform a comma separated value (CSV) file to an XML.</para></listitem>
+ <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> POJO Example</emphasis> - demonstrates the use of Smooks performing a simple transformation by converting an XML file into Java POJOs.</para></listitem>
+ <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML date-manipulation Example</emphasis> - demonstrates how to manually define and apply a Message Transformation within JBoss ESB.</para></listitem>
+ <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML Example</emphasis> - a very basic example of how to manually define and apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console. </para></listitem>
+
+ </itemizedlist>
+
+
- <para>Select <emphasis><property>JBoss ESB HelloWorld Example</property> </emphasis> ESB and Client project, and then click
- <emphasis><property>Finish</property></emphasis>, then you will get two projects created. </para>
+ <para>We will take as our example <emphasis><property>JBoss ESB HelloWorld Example</property> </emphasis> ESB and Client project:</para>
+
+
+ <figure>
+ <title>JBoss Tools ESB Project Examples</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/06_esb_project_example.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>Choose them using the Ctrl button and then click
+ <emphasis><property>Finish</property></emphasis>. As a result you will get two projects created:</para>
<figure>
<title>JBoss ESB Project Examples: helloworld and helloworld_testclient</title>
<mediaobject>
@@ -158,7 +180,7 @@
<section>
<title>Deploying a ESB Project</title>
- <para>In this chapter youwill see how to deploy a ESB project using the WTP deployment framework.</para>
+ <para>In this chapter you will see how to deploy a ESB project using the WTP deployment framework.</para>
<para>Before deploying the project, open the JBoss Server View by selecting <emphasis><property>Window > Show View > Other >
Server > JBoss Server View</property></emphasis>,
@@ -188,8 +210,53 @@
</figure>
<para>Thus, you have just added the ESB project to the JBoss server module list. Right click the JBoss Server and select <emphasis><property>Publish</property></emphasis> to publish the project on the server.
- You can check the deploying result in the Console view.</para>
+ You can check the deploying result in the Console view.</para>
+ <para>The <emphasis><property>Run</property></emphasis> and <emphasis><property>Debug</property></emphasis> options work on ESB projects causing a (re)deploy for a user designated server.</para>
+ <para>You can also use the "Finger touch" for a quick restart of the project without restarting the server:</para>
+ <figure>
+ <title>Finger Touch button</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/23_finger_touch.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR) and now it is also available for jboss-esb.xml in ESB projects.</para>
+ <para>You can also deploy your ESB project as an .esb archive. Right-click on the project, choose <emphasis><property>Export</property></emphasis>:</para>
+ <figure>
+ <title>Export of ESB project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/24_export_button.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Choose <emphasis><property>ESB</property></emphasis> > <emphasis><property>ESB File</property></emphasis> and click <emphasis><property>Next</property></emphasis>:</para>
+
+ <figure><title>Choosing ESB File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/25_esb_file.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>And finally export the ESB project to the file system: choose the destination, choose the target runtime if need a specific one and make the appropriate settings for the archive. Then click <emphasis><property>Finish</property></emphasis>.</para>
+
+ <figure><title>ESB Export</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/26_esb_export.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Your project is deployed as an .esb archive.</para>
+ <para>An ESB archive can be created for ESB projects only. It is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB installed.</para>
+
+
</section>
<section>
@@ -329,7 +396,7 @@
<para>You can find out what is SOA here: <ulink url="http://www.jboss.org/jbossesb/resources/SOABasics.html">Basics of SOA</ulink> and <ulink url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and EOA</ulink>.</para>
<para>To configure the JBoss Enterprise SOA platform select <emphasis>
- <property>Window > Preferences > Server > Runtime Enironments</property></emphasis>, that will open the Server Runtime Environments Preferences page where you can add, remove and edit a Server Runtime Environment.</para>
+ <property>Window > Preferences > Server > Runtime Environments</property></emphasis>, that will open the Server Runtime Environments Preferences page where you can add, remove and edit a Server Runtime Environment.</para>
<figure>
<title>Configure new Server Runtime Environment</title>
@@ -350,7 +417,7 @@
</mediaobject>
</figure>
- <para>On the next step you can specify a name of the server runtime environement and browse to its location. Click <emphasis><property>Finish</property></emphasis> to add the server runtime environment.</para>
+ <para>On the next step you can specify a name of the server runtime environment and browse to its location. Click <emphasis><property>Finish</property></emphasis> to add the server runtime environment.</para>
<figure>
Modified: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/pom.xml 2009-05-11 16:19:15 UTC (rev 15187)
+++ branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/pom.xml 2009-05-11 16:19:33 UTC (rev 15188)
@@ -77,6 +77,11 @@
<artifactId>jbosstools-docbook-xslt</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
</dependencies>
<configuration>
15 years, 2 months
- 1
- 0
JBoss Tools SVN: r15187 - branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:19:15 -0400 (Mon, 11 May 2009)
New Revision: 15187
Added:
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml
Removed:
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Deleted: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml 2009-05-11 16:19:04 UTC (rev 15186)
+++ branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml 2009-05-11 16:19:15 UTC (rev 15187)
@@ -1,891 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.docbook.org/xml/4.3/docbookx.dtd"
-
-[<!ENTITY introduction SYSTEM "modules/introduction.xml">
-<!ENTITY esb_support SYSTEM "modules/esb_support.xml">
-<!ENTITY esb_editor SYSTEM "modules/esb_editor.xml">
-
-<!ENTITY seamlink "../../seam/html_single/index.html">
-<!ENTITY aslink "../../as/html_single/index.html">
-<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
-<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
-<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
-<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
-<!ENTITY jsflink "../../jsf/html_single/index.html">
-<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
-<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
-<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
-<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
-
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>ESB Tools Reference Guide</title>
- <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
- <author><firstname>Tatyana</firstname><surname>Romanovich</surname></author>
-
- <pubdate>April 2008</pubdate>
- <copyright>
- <year>2007</year>
- <year><diffmk:wrapper diffmk:change="changed">2009</diffmk:wrapper></year>
- <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.1.0.GA
- </diffmk:wrapper></releaseinfo>
-
-<abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/esb_ref_guide/pdf/ES...">PDF version</ulink>
- </para>
-</abstract>
-
-</bookinfo>
- <toc></toc>
-
-
-<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml">
- <?dbhtml filename="introduction.html"?>
-
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- <keyword>JBoss Tools</keyword>
- <keyword>JBDS</keyword>
- <keyword>ESB</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Introduction</title>
-
- <section>
-
- <title>What is ESB?</title>
-
- <para>ESB (Enterprise Service Bus) - an abstraction layer on top of implementation of an
- enterprise messaging system that provides the features Service Oriented
- Architectures may be implemented with.</para>
- <para>If you want to develop applications using ESB technology JBoss ESB also meets your
- needs. The JBoss Tools provide an ESB editor and all necessary wizards for creating an ESB
- file.</para>
- <para>In this guide we provide you with the information on JBoss ESB support (installation, configuration and deployment) and usage of ESB Editor which allows you to
- develop an ESB file much faster and with far fewer errors so sparing your time.</para>
-
- </section>
-
- <section>
- <title>Other relevant resources on the topic</title>
-
- <para>You can find a set of benefits and other extra information on:</para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink url="http://www.jboss.org/jbossesb">JBoss ESB</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB
- Documentation Library</ulink>
- </para>
- </listitem>
- </itemizedlist>
-
- <para>The latest <property moreinfo="none">JBoss Tools/JBoss Developer Studio</property> documentation
- builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
-
- </section>
-</chapter>
-
-
-<chapter id="esb_support" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_support.xml">
- <?dbhtml filename="esb_support.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>ESB</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>ESB Support</title>
-
- <para>In this section we will focus on all concepts that <property moreinfo="none">JBoss Tools</property>
- integrate for working with JBoss ESB.</para>
-
- <section>
- <title>ESB Tools Installation</title>
-
- <para>This chapter will provide you with the information on how to install
- JBoss ESB plugin into Eclipse.</para>
-
- <para>ESB Tools come as one module of JBoss Tools project. Since ESB Tools have a
- dependence on other JBoss Tools modules we recommend you to install a bundle
- of all <ulink url="http://labs.jboss.com/tools/download/index.html">JBoss
- Tools plug-ins</ulink>. You can find all necessary installation instructions on JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">InstallingJBossTools</ulink> section.</para>
- </section>
-
- <section>
- <title>Creating a ESB Project</title>
- <para>In this chapter we suggest a step-by-step walk-through of creating a new
- ESB project. Let's try to create a new JBoss ESB project.</para>
-
- <para>We will show you how to use the ESB Project Creation wizard for creating a new ESB project and setting basic ESB classpath.</para>
-
- <para>Select <emphasis>
- <property moreinfo="none">File >New > Project...</property>
- </emphasis> in the main menu bar or context menu for selected project and
- then <emphasis>
- <property moreinfo="none">ESB > ESB Project</property>
- </emphasis> in the dialog opened:</para>
-
- <figure float="0">
- <title>Select a Wizard dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/01_create_esb_project.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Clicking <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> brings you to the JBoss ESB Project wizard page where a project name, ESB version and target JBoss Runtime are to be specified. Specify, for example, <emphasis>
- <property moreinfo="none">helloworld</property>
- </emphasis> as a Project name and accept the default ESB version.</para>
- <figure float="0">
- <title>JBoss ESB Project wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/02_create_esb_project.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Clicking <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> brings you to the ESB facet installation page where you can
- specify Java Source Directory and ESB Content Directory. ESB Content Directory is a folder that contains the most of
- artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options:
- </diffmk:wrapper></para>
- <para>1. Use <emphasis>
- <property moreinfo="none">Server Supplied ESB Runtime</property>
- </emphasis>
-
- </para>
- <para> 2. Select a ESB runtime from the JBoss ESB runtime list predefined in the preferences
- </para>
- <para>If you choose the first option, make sure that the project has the Target JBoss Runtime set and this runtime has a ESB runtime installed.
- </para>
- <figure float="0">
- <title>Install ESB facet step</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/03_create_esb_project.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> and a ESB project with the default <emphasis><property moreinfo="none">jboss-esb.xml</property></emphasis>
- will be created. </para>
-
- <figure float="0">
- <title>The generated ESB project structure</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/04_create_esb_project.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section id="ESB_project_wizard" xreflabel="here">
- <title>Creating ESB Project using JBoss Tools Project Examples Wizard</title>
- <para>JBoss Tools provides a Project Example wizard that is an easy way for users to create some kinds of projects to be used as examples with some predefined structure. Let's start
- creating a ESB project using this wizard.</para>
-
- <para>Before creating a ESB project example create JBoss Runtime with name <emphasis><property moreinfo="none">
- JBoss 4.2 Runtime</property></emphasis>, it will be used by your ESB project example. </para>
-
- <para>Select <emphasis>
- <property moreinfo="none">File >New > Others </property>
- </emphasis> , in the main menu bar or context menu for selected project and
- then <emphasis>
- <property moreinfo="none">JBoss Tools > Project Examples</property>
- </emphasis> in the New dialog:</para>
-
- <figure float="0">
- <title>Select a wizard - Project Examples</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/05_esb_project_example.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Clicking <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> brings you to the wizard page where you can select a ESB project example from the example list.
- Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Here is a list of ready examples available:</diffmk:wrapper></para>
-
- <itemizedlist diffmk:change="added">
-
- <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB HelloWorld Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates the minimal files necessary to make a basic ESB component execute as well as to prove that the ESB os properly configured.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB HelloWorld Action Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates the use of multiple action invocations from a single configuration. You can use a single Action class and make multiple method calls or use multiple Action classes. </diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB HelloWorld File Action Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates using the File gateway feature of the JBoss ESB. Files that are found in a particular directory with a particular extension are sent to a JMS queue with actions for processing.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Web Service consumer1 Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates how to consume a 181 Web Service in an ESB action.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Web Service producer Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates how to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcessor action.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Smooks CSV -> XML Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates how to transform a comma separated value (CSV) file to an XML.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Smooks XML -> POJO Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates the use of Smooks performing a simpe transformation by converting an XML file into Java POJOs.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Smooks XML -> XML date-manipulation Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates how to manually define and apply a Message Transformation within JBoss ESB.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Smooks XML -> XML Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - a very basic example of how to manually define and apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console. </diffmk:wrapper></para></listitem>
-
- </itemizedlist>
-
-
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We will take as our example </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss ESB HelloWorld Example</diffmk:wrapper></property> </emphasis><diffmk:wrapper diffmk:change="added"> ESB and Client project:</diffmk:wrapper></para>
-
-
- <figure diffmk:change="added" float="0">
- <title>JBoss Tools ESB Project Examples</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/06_esb_project_example.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para><diffmk:wrapper diffmk:change="changed">Choose them using the Ctrl button and then click
- </diffmk:wrapper><emphasis><property moreinfo="none">Finish</property></emphasis><diffmk:wrapper diffmk:change="changed">. As a result you will get two projects created:</diffmk:wrapper></para>
- <figure float="0">
- <title>JBoss ESB Project Examples: helloworld and helloworld_testclient</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/07_esb_project_example.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Deploy the HelloWorld ESB project and run a test class in the client Java project to see the test result in the Console view.</para>
- </section>
-
- <section>
- <title>Deploying a ESB Project</title>
- <para>In this chapter youwill see how to deploy a ESB project using the WTP deployment framework.</para>
-
- <para>Before deploying the project, open the JBoss Server View by selecting <emphasis><property moreinfo="none">Window > Show View > Other >
- Server > JBoss Server View</property></emphasis>,
- create a JBoss Server in the Server view and start it, and then right click the created JBoss server,
- select <emphasis><property moreinfo="none"> </property> Add and Remove Projects</emphasis>,
- and add the ESB projects you want to deploy from the left side to the right side in the opened dialog. </para>
-
- <figure float="0">
- <title>Add and Remove Projects</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/08_esb_project_deploy.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Click <emphasis><property moreinfo="none">Finish</property> </emphasis> to add the project to the server.
- You also can drag the ESB project from the Project View to the server.</para>
-
- <figure float="0">
- <title>JBoss Server View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/09_esb_runtime_new.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Thus, you have just added the ESB project to the JBoss server module list. Right click the JBoss Server and select <emphasis><property moreinfo="none">Publish</property></emphasis><diffmk:wrapper diffmk:change="added"> to publish the project on the server.
- You can check the deploying result in the Console view.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Run</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Debug</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> options work on ESB projects causing a (re)deploy for a user designated server.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can also use the "Finger touch" for a quick restart of the project without restarting the server:</diffmk:wrapper></para>
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Finger Touch button</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/esb_project/23_finger_touch.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR) and now it is also available for jboss-esb.xml in ESB projects.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can also deploy your ESB project as an .esb archive. Right-click on the project, choose </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Export</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">:</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Export of ESB project</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/esb_project/24_export_button.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Choose </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> > </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB File</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">:</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0"><title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Choosing ESB File</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/esb_project/25_esb_file.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">And finally export the ESB project to the file system: choose the destination, choose the target runtime if need a specific one and make the appropriate settings for the archive. Then click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0"><title diffmk:change="added"><diffmk:wrapper diffmk:change="added">ESB Export</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/esb_project/26_esb_export.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Your project is deployed as an .esb archive.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">An ESB archive can be created for ESB projects only. It is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB installed.</diffmk:wrapper></para>
-
-
- </section>
-
- <section>
- <title>Creating a ESB File</title>
- <para>In this chapter we suggest a step-by-step walk-through of creating your own
- simple file. Let's try to organize a new ESB file.</para>
-
- <para>We will show you how to use the Creation wizard for creating a new ESB file.</para>
-
- <para>At first you should open any project. Select <emphasis>
- <property moreinfo="none">File >New > Other...</property>
- </emphasis> in the main menu bar or context menu for selected project and
- then <emphasis>
- <property moreinfo="none">ESB > ESB File</property>
- </emphasis> in the New dialog:</para>
-
- <figure float="0">
- <title>Select a wizard - ESB File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_support/01_create_esb.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Clicking <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> brings you to the wizard page where a folder, a name and a version for the file should be specified. Choose, for example, <emphasis>
- <property moreinfo="none">jboss-esb.xml</property>
- </emphasis> as the name and accept the selected projects folder and the default
- version.</para>
- <figure float="0">
- <title>Folder, Name and Version for ESB file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_support/02_create_esb.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Thus, your file will be created in the selected projects folder by default. If
- you want to change the folder for your future file click <emphasis>
- <property moreinfo="none">Browse...</property>
- </emphasis> button to set needed folder or simply type it.</para>
-
- <para>Clicking on <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> results in the file being generated. The wizard creates one xml
- file.</para>
-
- </section>
-
- <section role="updated">
- <title>Configuring ESB Runtime in Preferences</title>
- <para>In this chapter you will know how to predefine a JBoss ESB runtime on the Preferences page.</para>
-
- <para>You may already know, there are two ways to set JBoss ESB runtime when creating a ESB project,
- one is to use the project target JBoss runtime, and another is to select a JBoss ESB runtime predefined in JBoss Tools preferences.
- Let's configure it.</para>
-
- <para>Select <emphasis>
- <property moreinfo="none">Window >Preferences > JBoss Tools > JBoss ESB Runtime</property>
- </emphasis>, to open the JBoss ESB Runtime Preferences page where you can add, remove and Edit a JBoss ESB runtime.</para>
-
- <figure float="0">
- <title>JBoss ESB Runtimes</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/10_esb_runtime.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Select <emphasis><property moreinfo="none">Add</property></emphasis> to open a dialog where you can specify the JBoss ESB runtime location, name and version number.
- You also can customize the libraries of the runtime by checking the <emphasis><property moreinfo="none">Customize JBoss ESB Runtime jars</property> </emphasis> checkbox. </para>
-
- <figure float="0">
- <title>Configure new JBoss ESB Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/11_esb_runtime_new.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The new JBoss ESB Runtime will be configured. Click <emphasis> <property moreinfo="none">OK</property> </emphasis> to finish and save the preferences.
- You can use the configuration when creating a JBoss ESB project. </para>
- <para>When a ESB runtime is configured for your ESB project you are able to change it to any other using the classpath container page for ESB runtime. To do that, turn to the Package Explorer view and right-click the "JBoss ESB Runtime" library. Select <emphasis><property moreinfo="none">Properties</property></emphasis> and a table listing all available JBoss ESB runtimes will appear:</para>
-
- <figure float="0">
- <title>Classpath Container Page to change ESB runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/20_classpath_container.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
-
- <para>Choose one of them to set to the ESB project and click <emphasis><property moreinfo="none">Ok</property></emphasis>.</para>
- <para>ESB container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file, select <emphasis><property moreinfo="none">Properties</property></emphasis>. Choose <emphasis><property moreinfo="none">Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para>
-
- <figure float="0">
- <title>Classpath Container: Java Source Attachment</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/21_source.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para>
- <para>To change Javadoc Location choose <emphasis><property moreinfo="none">Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property moreinfo="none">package-list</property></emphasis>:</para>
-
- <figure float="0">
- <title>Classpath Container: Javadoc Location</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/22_Javadoc.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para>
-
- </section>
-
-
- <section id="using_SOA">
- <title>Using and Configuring SOA Platform</title>
-
- <para>In this chapter you will know what is JBoss Enterprise SOA Platform and how you can configure it to use for your ESB projects. </para>
-
- <para>JBoss Enterprise SOA Platform delivers a flexible, standards-based platform to integrate applications, SOA services, business events and automate business processes. The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para>
- <para>Having configured JBoss Enterprise SOA Platform for your ESB project you don't need to install and configure ESB server and runtime as they are already included.</para>
-
- <para>Check here to find more details on the platform: <ulink url="http://www.jboss.com/products/platforms/soa">JBoss Enterprise SOA Platform</ulink> and <ulink url="http://www.jboss.com/products/platforms/soa/components">JBoss Enterprise SOA Platform Component Details</ulink>.</para>
- <para>You can find out what is SOA here: <ulink url="http://www.jboss.org/jbossesb/resources/SOABasics.html">Basics of SOA</ulink> and <ulink url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and EOA</ulink>.</para>
-
- <para>To configure the JBoss Enterprise SOA platform select <emphasis>
- <property moreinfo="none">Window > Preferences > Server > Runtime Enironments</property></emphasis>, that will open the Server Runtime Environments Preferences page where you can add, remove and edit a Server Runtime Environment.</para>
-
- <figure float="0">
- <title>Configure new Server Runtime Environment</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/13NewServerRuntimeEnv.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Select <emphasis><property moreinfo="none">Add</property></emphasis>, choose <emphasis><property moreinfo="none">JBoss 4.2 Runtime</property></emphasis> as a type of runtime environment, check the <emphasis><property moreinfo="none">Create a new local server</property></emphasis> checkbox and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para>
- <figure float="0">
- <title>Type of Server Runtime Environment</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/14typeOfRuntime.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the next step you can specify a name of the server runtime environement and browse to its location. Click <emphasis><property moreinfo="none">Finish</property></emphasis> to add the server runtime environment.</para>
-
-
- <figure float="0">
- <title>New Server Runtime Environment Details</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/15AddNew.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Now you have your SOA platform configured. To check the configuration create a ESB Project using instructions described <xref linkend="ESB_project_wizard"></xref>. As a result you will have two projects created:</para>
-
- <figure float="0">
- <title>Helloworld Projects Created</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/16HelloworldProjects.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Then you will need to add JBoss ESB libraries to your projects to configure the SOA server runtime exactly for your projects. Right-click on your project, select <emphasis><property moreinfo="none">Build Path > Add Libraries</property></emphasis>:</para>
-
- <figure float="0">
- <title>Add Libraries</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/17_Add_new_libraries.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Choose <emphasis><property moreinfo="none">JBoss ESB Libraries</property></emphasis> and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para>
-
- <figure float="0">
- <title>ESB Libraries</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/18_select_libraries.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Select the necessary runtime to add to the project classpath:</para>
-
-
- <figure float="0">
- <title>Select a ESB runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_project/19_select_runtime.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click <emphasis><property moreinfo="none">Finish</property></emphasis>.</para>
- <para>Now you can deploy your Helloworld project to the server and run a test class in the client Java project to see the test result in the Console view.</para>
-
-
-
-</section>
-
-
-
-
-
-
-
-
-
-
-</chapter>
-
-
-<chapter id="esb_editor" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml" xreflabel="esb_editor">
- <?dbhtml filename="esbEditor.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss ESB</keyword>
- <keyword>Editor</keyword>
- <keyword>ESB</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>ESB Editor</title>
-
- <para> ESB editor has lots of useful features, they are described in details in this chapter. In
- addition you'll get to know with how <property moreinfo="none">ESB Editor</property> uses combined
- visual and source editing of esb files.</para>
-
- <section id="esb_file" role="updated">
-
- <title>ESB File Editor</title>
- <para><property moreinfo="none">ESB File Editor</property> is a powerful and customizable tool. ESB File
- Editor allows developing an application using ESB technology.</para>
-
- <para>ESB file editor has two tabs: Tree and Source.</para>
-
- <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a
- tree format. By selecting any node you can see and edit its properties which will appear
- in the right-hand area. For example, a Provider:</para>
- <figure float="0">
- <title>Tree View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/01_esb_tree_view.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of
- the editor and work in <property moreinfo="none">Source view</property>.</para>
-
- <figure float="0" id="sourceView">
- <title>Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/02_esb_source_view.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The Source view for the editor displays a text content of the ESB file. It is always
- synchronized with <property moreinfo="none">Tree view</property>, so any changes made in one of the
- views will immediately appear in the other.</para>
-
- <para>No matter what view you select, you get full integration with <property moreinfo="none">Outline
- view</property>. For example, you can work in the Source view with the help of the
- Outline view. The Outline view shows a tree structure of the ESB file. Simply select any
- element in the <property moreinfo="none">Outline view</property> and it will jump to the same place in
- the Source editor, so you can navigate through the source code with Outline view.</para>
- <figure float="0">
- <title>Outline View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/03_esb_outline_view.png" scale="70"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Adding, editing or deleting of some artifacts operations are available right in the
- <property moreinfo="none">Tree view</property> . Right-click any node and select one of the
- available actions in the context menu. For example, you can easily add a new Provider:</para>
- <para></para>
- <figure float="0">
- <title>Adding New Provider</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/04_esb_add_provider.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Then you can add Channels and Properties for the Providers the same way or using the forms with </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Edit</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and
- </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Remove</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> buttons to the right.</diffmk:wrapper></para>
-
- <para>You can easily add a new Service too:</para>
- <figure float="0">
- <title>Adding New Service</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/05_esb_add_service.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The same way you can create a listener for service and other elements of ESB:</para>
- <figure float="0">
- <title>Adding New Listener for Service</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/06_esb_add_listener.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The same actions can be done in the right part of <property moreinfo="none">Tree view</property> tab
- (Form editor) using <property moreinfo="none">Add</property>, <property moreinfo="none">Edit</property> and
- <property moreinfo="none">Remove</property> buttons.</para>
-
-
- <para>In order to add a new generic Action to your ESB XML file you should select the
- Actions node under the Services, then right-click and choose <emphasis>
- <property moreinfo="none">New > Generic Action</property>. </emphasis></para>
-
- <figure float="0">
- <title>Adding New Action in the Tree View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/11_esb_editor.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Or instead make use of <emphasis>
- <property moreinfo="none">Add...</property>
- </emphasis> button in the <property moreinfo="none">Form editor</property> on the left.</para>
- <figure float="0">
- <title>Adding New Action in the Form Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/12_esb_editor.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As you can see on the bath figures above, the context menu will also prompt you to
- insert one of the Actions that are supplied out-of-the-box with <property moreinfo="none">JBoss
- ESB</property>. After choosing one an appeared <property moreinfo="none">New Action wizard</property>
- will ask you to fill out a name field and other fields specific for each Action
- property. For example, for <emphasis>
- <property moreinfo="none">Content Based Router</property>
- </emphasis> Action the wizard looks as follows:</para>
-
- <figure float="0">
- <title>New Action Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/13_esb_editor.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After confirming creating the Action you can see it in the Tree under the <emphasis>
- <property moreinfo="none">Actions</property>
- </emphasis> node and preview as well as edit its settings in the <property moreinfo="none">Form
- editor</property> on the left.</para>
-
- <figure float="0">
- <title>Form Editor for Content Based Router</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/14_esb_editor.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para><property moreinfo="none">ESB editor</property> can recognize some specific objects. On the figure you
- can see <emphasis>org.jboss.soa.esb.actions.ContentBasedRouter</emphasis> in the <emphasis>
- <property moreinfo="none">Class</property>
- </emphasis> section.</para>
-
- </section>
-
- <section id="esb_editors_features">
-
- <title>ESB Editors Features</title>
- <para>JBoss ESB tooling has powerful editor features that help you easily make use of
- content and code assist.</para>
- <para>This last chapter covers capabilities on how you can use ESB editor.</para>
-
- <section id="ESBsyntaxvalidation84">
-
- <title>ESB syntax validation</title>
- <para>When working in <property moreinfo="none">JBoss ESB editor</property> you are constantly provided
- with feedback and contextual error checking as you type. In the Source viewer, if at
- any point a tag is incorrect or incomplete, an error will be indicated next to the
- line and also in the <property moreinfo="none">Problems view</property> below.</para>
- </section>
-
- <section id="ESBSupportXMLSchema">
- <title>Support for XML Schema</title>
-
- <para>JBoss ESB Framework fully <link linkend="sourceView"><diffmk:wrapper diffmk:change="changed">supports XML files based on
- schemas as well as DTDs</diffmk:wrapper></link>.</para>
- <note diffmk:change="added"><title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The schema used behind ESB editor now uses the latest version available (from SOA-P 4.3). This removes the errors/warnings some users have reported seeing when using SOA-P specific esb.xml files.</diffmk:wrapper></para> </note>
-
- </section>
-
- <!--<section id="OpenOnSelection">
-
- <title>OpenOn</title>
-
- <para><property>OpenOn</property> let's you easily navigate through your
- project without using the Package Explorer view (project tree). With OpenOn, you can
- simply click on a reference to another file and that file will be opened.</para>
-
- <para>OpenOn is available for the XML files </para>
-
- <para>Press and hold down the Ctrl key. As you move the mouse cursor over different
- file references in the file, they display an underline. When you have the mouse
- cursor over the name of the file you want to open, click and the file will open
- in its own editor. In this example the managed bean NameBean will open.</para>
-
- </section>
- -->
-
- <section id="ESBContentAssist">
-
- <title>Content Assist for ESB XML file</title>
-
- <para>When you work with any ESB XML file <property moreinfo="none">Content Assist</property> is
- available to help you. It provides pop-up tip to help you complete your code
- statements. It allows you to write your code faster and with more accuracy. Content
- assist is always available in the Source mode. Simply type <emphasis>
- <property moreinfo="none">Ctrl-Space</property>
- </emphasis> to see what is available.</para>
-
- <para>Content Assist for ESB XML file:</para>
- <figure float="0">
- <title>Content Assist for ESB XML file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/08_esb_features.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Content Assist for attributes:</para>
- <figure float="0">
- <title>Content Assist for attributes:</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/09_esb_features.png" scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <!-- </section>
-
- <section id="ContentAssistWithinTreeEditor">
-
- <title>Content Assist within Tree ESB Editor</title>
-
- <para>JBoss Developer Studio also provides Content Assist when working within the Tree ESB editor.
- Just click <emphasis><property>Ctrl-Space</property>.</emphasis></para>
- <figure>
- <title>Content Assist in Tree ESB Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/esb_file/09_editors_features.png" scale="85"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section> -->
- </section>
-
- <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing">
-
- <title>Synchronized Source and Visual Editing</title>
-
- <para>ESB file can be edited in either source or extra visual modes at the same time.</para>
-
- <para>JBoss Tools provide you two different editors to speed your development: a
- graphical view (<property moreinfo="none">Tree</property>) and source (<property moreinfo="none">Source</property>).
- At the same time, you always have full control over esb source file. Any changes you
- make in the source view will immediately appear in the tree view. Both views are
- synchronized, you can edit the file in any view.</para>
-
- <figure float="0">
- <title>Two Views are Synchronized</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/esb_editor/10_esb_features.png" scale="70"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In summary, this reference supplies you with all necessary information on the
- functionality that JBoss ESB Editor provides for work with JBoss ESB.</para>
- </section>
- </section>
-</chapter>
-
-
-</book>
Copied: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml (from rev 15128, trunk/esb/docs/esb_ref_guide/en/master_output.xml)
===================================================================
--- branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml 2009-05-11 16:19:15 UTC (rev 15187)
@@ -0,0 +1,894 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[<!ENTITY introduction SYSTEM "modules/introduction.xml">
+<!ENTITY esb_support SYSTEM "modules/esb_support.xml">
+<!ENTITY esb_editor SYSTEM "modules/esb_editor.xml">
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>ESB Tools Reference Guide</title>
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+ <author><firstname>Tatyana</firstname><surname>Romanovich</surname></author>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 1.1.1.GA
+ </diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/esb_ref_guide/pdf/ES...">PDF version</ulink>
+ </para>
+</abstract>
+
+</bookinfo>
+ <toc></toc>
+
+
+<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml">
+ <?dbhtml filename="introduction.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JBDS</keyword>
+ <keyword>ESB</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Introduction</title>
+
+ <section>
+
+ <title>What is ESB?</title>
+
+ <para>ESB (Enterprise Service Bus) - an abstraction layer on top of implementation of an
+ enterprise messaging system that provides the features Service Oriented
+ Architectures may be implemented with.</para>
+ <para>If you want to develop applications using ESB technology JBoss ESB also meets your
+ needs. The JBoss Tools provide an ESB editor and all necessary wizards for creating an ESB
+ file.</para>
+ <para>In this guide we provide you with the information on JBoss ESB support (installation, configuration and deployment) and usage of ESB Editor which allows you to
+ develop an ESB file much faster and with far fewer errors so sparing your time.</para>
+
+ </section>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+
+ <para>You can find a set of benefits and other extra information on:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.org/jbossesb">JBoss ESB</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB
+ Documentation Library</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The latest <property moreinfo="none">JBoss Tools/JBoss Developer Studio</property> documentation
+ builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
+
+ </section>
+</chapter>
+
+
+<chapter id="esb_support" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_support.xml">
+ <?dbhtml filename="esb_support.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>ESB</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>ESB Support</title>
+
+ <para>In this section we will focus on all concepts that <property moreinfo="none">JBoss Tools</property>
+ integrate for working with JBoss ESB.</para>
+
+ <section>
+ <title>ESB Tools Installation</title>
+
+ <para>This chapter will provide you with the information on how to install
+ JBoss ESB plugin into Eclipse.</para>
+
+ <para>ESB Tools come as one module of JBoss Tools project. Since ESB Tools have a
+ dependence on other JBoss Tools modules we recommend you to install a bundle
+ of all <ulink url="http://labs.jboss.com/tools/download/index.html">JBoss
+ Tools plug-ins</ulink>. You can find all necessary installation instructions on JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">InstallingJBossTools</ulink> section.</para>
+ </section>
+
+ <section>
+ <title>Creating a ESB Project</title>
+ <para>In this chapter we suggest a step-by-step walk-through of creating a new
+ ESB project. Let's try to create a new JBoss ESB project.</para>
+
+ <para>We will show you how to use the ESB Project Creation wizard for creating a new ESB project and setting basic ESB classpath.</para>
+
+ <para>Select <emphasis>
+ <property moreinfo="none">File >New > Project...</property>
+ </emphasis> in the main menu bar or context menu for selected project and
+ then <emphasis>
+ <property moreinfo="none">ESB > ESB Project</property>
+ </emphasis> in the dialog opened:</para>
+
+ <figure float="0">
+ <title>Select a Wizard dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/01_create_esb_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Clicking <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> brings you to the JBoss ESB Project wizard page where a project name, ESB version and target JBoss Runtime are to be specified. Specify, for example, <emphasis>
+ <property moreinfo="none">helloworld</property>
+ </emphasis> as a Project name and accept the default ESB version.</para>
+ <figure float="0">
+ <title>JBoss ESB Project wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/02_create_esb_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Clicking <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> brings you to the ESB facet installation page where you can
+ specify Java Source Directory and ESB Content Directory. ESB Content Directory is a folder that contains the most of
+ artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options:
+ </diffmk:wrapper></para>
+ <para>1. Use <emphasis>
+ <property moreinfo="none">Server Supplied ESB Runtime</property>
+ </emphasis>
+
+ </para>
+ <para> 2. Select a ESB runtime from the JBoss ESB runtime list predefined in the preferences
+ </para>
+ <para>If you choose the first option, make sure that the project has the Target JBoss Runtime set and this runtime has a ESB runtime installed.
+ </para>
+ <figure float="0">
+ <title>Install ESB facet step</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/03_create_esb_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> and a ESB project with the default <emphasis><property moreinfo="none">jboss-esb.xml</property></emphasis>
+ will be created. </para>
+
+ <figure float="0">
+ <title>The generated ESB project structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/04_create_esb_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="ESB_project_wizard" xreflabel="here">
+ <title>Creating ESB Project using JBoss Tools Project Examples Wizard</title>
+ <para>JBoss Tools provides a Project Example wizard that is an easy way for users to create some kinds of projects to be used as examples with some predefined structure. Let's start
+ creating a ESB project using this wizard.</para>
+
+ <para>Before creating a ESB project example create JBoss Runtime with name <emphasis><property moreinfo="none">
+ JBoss 4.2 Runtime</property></emphasis>, it will be used by your ESB project example. </para>
+
+ <para>Select <emphasis>
+ <property moreinfo="none">File >New > Others </property>
+ </emphasis> , in the main menu bar or context menu for selected project and
+ then <emphasis>
+ <property moreinfo="none">JBoss Tools > Project Examples</property>
+ </emphasis> in the New dialog:</para>
+
+ <figure float="0">
+ <title>Select a wizard - Project Examples</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/05_esb_project_example.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Clicking <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> brings you to the wizard page where you can select a ESB project example from the example list.
+ Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Here is a list of ready examples available:</diffmk:wrapper></para>
+
+ <itemizedlist diffmk:change="added">
+
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB HelloWorld Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates the minimal files necessary to make a basic ESB component execute as well as to prove that the ESB os properly configured.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB HelloWorld Action Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates the use of multiple action invocations from a single configuration. You can use a single Action class and make multiple method calls or use multiple Action classes. </diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB HelloWorld File Action Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates using the File gateway feature of the JBoss ESB. Files that are found in a particular directory with a particular extension are sent to a JMS queue with actions for processing.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Web Service consumer1 Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates how to consume a 181 Web Service in an ESB action.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Web Service producer Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates how to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcessor action.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Smooks CSV -> XML Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates how to transform a comma separated value (CSV) file to an XML.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Smooks XML -> POJO Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates the use of Smooks performing a simple transformation by converting an XML file into Java POJOs.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Smooks XML -> XML date-manipulation Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - demonstrates how to manually define and apply a Message Transformation within JBoss ESB.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB Smooks XML -> XML Example</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> - a very basic example of how to manually define and apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console. </diffmk:wrapper></para></listitem>
+
+ </itemizedlist>
+
+
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We will take as our example </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss ESB HelloWorld Example</diffmk:wrapper></property> </emphasis><diffmk:wrapper diffmk:change="added"> ESB and Client project:</diffmk:wrapper></para>
+
+
+ <figure diffmk:change="added" float="0">
+ <title>JBoss Tools ESB Project Examples</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/06_esb_project_example.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para><diffmk:wrapper diffmk:change="changed">Choose them using the Ctrl button and then click
+ </diffmk:wrapper><emphasis><property moreinfo="none">Finish</property></emphasis><diffmk:wrapper diffmk:change="changed">. As a result you will get two projects created:</diffmk:wrapper></para>
+ <figure float="0">
+ <title>JBoss ESB Project Examples: helloworld and helloworld_testclient</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/07_esb_project_example.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Deploy the HelloWorld ESB project and run a test class in the client Java project to see the test result in the Console view.</para>
+ </section>
+
+ <section>
+ <title>Deploying a ESB Project</title>
+ <para><diffmk:wrapper diffmk:change="changed">In this chapter you will see how to deploy a ESB project using the WTP deployment framework.</diffmk:wrapper></para>
+
+ <para>Before deploying the project, open the JBoss Server View by selecting <emphasis><property moreinfo="none">Window > Show View > Other >
+ Server > JBoss Server View</property></emphasis>,
+ create a JBoss Server in the Server view and start it, and then right click the created JBoss server,
+ select <emphasis><property moreinfo="none"> </property> Add and Remove Projects</emphasis>,
+ and add the ESB projects you want to deploy from the left side to the right side in the opened dialog. </para>
+
+ <figure float="0">
+ <title>Add and Remove Projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/08_esb_project_deploy.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Click <emphasis><property moreinfo="none">Finish</property> </emphasis> to add the project to the server.
+ You also can drag the ESB project from the Project View to the server.</para>
+
+ <figure float="0">
+ <title>JBoss Server View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/09_esb_runtime_new.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Thus, you have just added the ESB project to the JBoss server module list. Right click the JBoss Server and select <emphasis><property moreinfo="none">Publish</property></emphasis><diffmk:wrapper diffmk:change="added"> to publish the project on the server.
+ You can check the deploying result in the Console view.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Run</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Debug</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> options work on ESB projects causing a (re)deploy for a user designated server.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can also use the "Finger touch" for a quick restart of the project without restarting the server:</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Finger Touch button</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/esb_project/23_finger_touch.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR) and now it is also available for jboss-esb.xml in ESB projects.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can also deploy your ESB project as an .esb archive. Right-click on the project, choose </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Export</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">:</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Export of ESB project</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/esb_project/24_export_button.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Choose </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> > </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB File</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">:</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0"><title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Choosing ESB File</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/esb_project/25_esb_file.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">And finally export the ESB project to the file system: choose the destination, choose the target runtime if need a specific one and make the appropriate settings for the archive. Then click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0"><title diffmk:change="added"><diffmk:wrapper diffmk:change="added">ESB Export</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/esb_project/26_esb_export.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Your project is deployed as an .esb archive.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">An ESB archive can be created for ESB projects only. It is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB installed.</diffmk:wrapper></para>
+
+
+ </section>
+
+ <section>
+ <title>Creating a ESB File</title>
+ <para>In this chapter we suggest a step-by-step walk-through of creating your own
+ simple file. Let's try to organize a new ESB file.</para>
+
+ <para>We will show you how to use the Creation wizard for creating a new ESB file.</para>
+
+ <para>At first you should open any project. Select <emphasis>
+ <property moreinfo="none">File >New > Other...</property>
+ </emphasis> in the main menu bar or context menu for selected project and
+ then <emphasis>
+ <property moreinfo="none">ESB > ESB File</property>
+ </emphasis> in the New dialog:</para>
+
+ <figure float="0">
+ <title>Select a wizard - ESB File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_support/01_create_esb.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Clicking <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> brings you to the wizard page where a folder, a name and a version for the file should be specified. Choose, for example, <emphasis>
+ <property moreinfo="none">jboss-esb.xml</property>
+ </emphasis> as the name and accept the selected projects folder and the default
+ version.</para>
+ <figure float="0">
+ <title>Folder, Name and Version for ESB file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_support/02_create_esb.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Thus, your file will be created in the selected projects folder by default. If
+ you want to change the folder for your future file click <emphasis>
+ <property moreinfo="none">Browse...</property>
+ </emphasis> button to set needed folder or simply type it.</para>
+
+ <para>Clicking on <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> results in the file being generated. The wizard creates one xml
+ file.</para>
+
+ </section>
+
+ <section role="updated">
+ <title>Configuring ESB Runtime in Preferences</title>
+ <para>In this chapter you will know how to predefine a JBoss ESB runtime on the Preferences page.</para>
+
+ <para>You may already know, there are two ways to set JBoss ESB runtime when creating a ESB project,
+ one is to use the project target JBoss runtime, and another is to select a JBoss ESB runtime predefined in JBoss Tools preferences.
+ Let's configure it.</para>
+
+ <para>Select <emphasis>
+ <property moreinfo="none">Window >Preferences > JBoss Tools > JBoss ESB Runtime</property>
+ </emphasis>, to open the JBoss ESB Runtime Preferences page where you can add, remove and Edit a JBoss ESB runtime.</para>
+
+ <figure float="0">
+ <title>JBoss ESB Runtimes</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/10_esb_runtime.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Select <emphasis><property moreinfo="none">Add</property></emphasis> to open a dialog where you can specify the JBoss ESB runtime location, name and version number.
+ You also can customize the libraries of the runtime by checking the <emphasis><property moreinfo="none">Customize JBoss ESB Runtime jars</property> </emphasis> checkbox. </para>
+
+ <figure float="0">
+ <title>Configure new JBoss ESB Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/11_esb_runtime_new.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The new JBoss ESB Runtime will be configured. Click <emphasis> <property moreinfo="none">OK</property> </emphasis> to finish and save the preferences.
+ You can use the configuration when creating a JBoss ESB project. </para>
+ <para>When a ESB runtime is configured for your ESB project you are able to change it to any other using the classpath container page for ESB runtime. To do that, turn to the Package Explorer view and right-click the "JBoss ESB Runtime" library. Select <emphasis><property moreinfo="none">Properties</property></emphasis> and a table listing all available JBoss ESB runtimes will appear:</para>
+
+ <figure float="0">
+ <title>Classpath Container Page to change ESB runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/20_classpath_container.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+
+ <para>Choose one of them to set to the ESB project and click <emphasis><property moreinfo="none">Ok</property></emphasis>.</para>
+ <para>ESB container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file, select <emphasis><property moreinfo="none">Properties</property></emphasis>. Choose <emphasis><property moreinfo="none">Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para>
+
+ <figure float="0">
+ <title>Classpath Container: Java Source Attachment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/21_source.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para>
+ <para>To change Javadoc Location choose <emphasis><property moreinfo="none">Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property moreinfo="none">package-list</property></emphasis>:</para>
+
+ <figure float="0">
+ <title>Classpath Container: Javadoc Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/22_Javadoc.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para>
+
+ </section>
+
+
+ <section id="using_SOA">
+ <title>Using and Configuring SOA Platform</title>
+
+ <para>In this chapter you will know what is JBoss Enterprise SOA Platform and how you can configure it to use for your ESB projects. </para>
+
+ <para>JBoss Enterprise SOA Platform delivers a flexible, standards-based platform to integrate applications, SOA services, business events and automate business processes. The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para>
+ <para>Having configured JBoss Enterprise SOA Platform for your ESB project you don't need to install and configure ESB server and runtime as they are already included.</para>
+
+ <para>Check here to find more details on the platform: <ulink url="http://www.jboss.com/products/platforms/soa">JBoss Enterprise SOA Platform</ulink> and <ulink url="http://www.jboss.com/products/platforms/soa/components">JBoss Enterprise SOA Platform Component Details</ulink>.</para>
+ <para>You can find out what is SOA here: <ulink url="http://www.jboss.org/jbossesb/resources/SOABasics.html">Basics of SOA</ulink> and <ulink url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and EOA</ulink>.</para>
+
+ <para>To configure the JBoss Enterprise SOA platform select <emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Preferences > Server > Runtime Environments</diffmk:wrapper></property></emphasis>, that will open the Server Runtime Environments Preferences page where you can add, remove and edit a Server Runtime Environment.</para>
+
+ <figure float="0">
+ <title>Configure new Server Runtime Environment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/13NewServerRuntimeEnv.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Select <emphasis><property moreinfo="none">Add</property></emphasis>, choose <emphasis><property moreinfo="none">JBoss 4.2 Runtime</property></emphasis> as a type of runtime environment, check the <emphasis><property moreinfo="none">Create a new local server</property></emphasis> checkbox and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para>
+ <figure float="0">
+ <title>Type of Server Runtime Environment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/14typeOfRuntime.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">On the next step you can specify a name of the server runtime environment and browse to its location. Click </diffmk:wrapper><emphasis><property moreinfo="none">Finish</property></emphasis> to add the server runtime environment.</para>
+
+
+ <figure float="0">
+ <title>New Server Runtime Environment Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/15AddNew.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Now you have your SOA platform configured. To check the configuration create a ESB Project using instructions described <xref linkend="ESB_project_wizard"></xref>. As a result you will have two projects created:</para>
+
+ <figure float="0">
+ <title>Helloworld Projects Created</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/16HelloworldProjects.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Then you will need to add JBoss ESB libraries to your projects to configure the SOA server runtime exactly for your projects. Right-click on your project, select <emphasis><property moreinfo="none">Build Path > Add Libraries</property></emphasis>:</para>
+
+ <figure float="0">
+ <title>Add Libraries</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/17_Add_new_libraries.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Choose <emphasis><property moreinfo="none">JBoss ESB Libraries</property></emphasis> and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para>
+
+ <figure float="0">
+ <title>ESB Libraries</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/18_select_libraries.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Select the necessary runtime to add to the project classpath:</para>
+
+
+ <figure float="0">
+ <title>Select a ESB runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_project/19_select_runtime.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click <emphasis><property moreinfo="none">Finish</property></emphasis>.</para>
+ <para>Now you can deploy your Helloworld project to the server and run a test class in the client Java project to see the test result in the Console view.</para>
+
+
+
+</section>
+
+
+
+
+
+
+
+
+
+
+</chapter>
+
+
+<chapter id="esb_editor" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml" xreflabel="esb_editor">
+ <?dbhtml filename="esbEditor.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss ESB</keyword>
+ <keyword>Editor</keyword>
+ <keyword>ESB</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>ESB Editor</title>
+
+ <para> ESB editor has lots of useful features, they are described in details in this chapter. In
+ addition you'll get to know with how <property moreinfo="none">ESB Editor</property> uses combined
+ visual and source editing of esb files.</para>
+
+ <section id="esb_file" role="updated">
+
+ <title>ESB File Editor</title>
+ <para><property moreinfo="none">ESB File Editor</property> is a powerful and customizable tool. ESB File
+ Editor allows developing an application using ESB technology.</para>
+
+ <para>ESB file editor has two tabs: Tree and Source.</para>
+
+ <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a
+ tree format. By selecting any node you can see and edit its properties which will appear
+ in the right-hand area. For example, a Provider:</para>
+ <figure float="0">
+ <title>Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/01_esb_tree_view.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of
+ the editor and work in <property moreinfo="none">Source view</property>.</para>
+
+ <figure float="0" id="sourceView">
+ <title>Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/02_esb_source_view.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Source view for the editor displays a text content of the ESB file. It is always
+ synchronized with <property moreinfo="none">Tree view</property>, so any changes made in one of the
+ views will immediately appear in the other.</para>
+
+ <para>No matter what view you select, you get full integration with <property moreinfo="none">Outline
+ view</property>. For example, you can work in the Source view with the help of the
+ Outline view. The Outline view shows a tree structure of the ESB file. Simply select any
+ element in the <property moreinfo="none">Outline view</property> and it will jump to the same place in
+ the Source editor, so you can navigate through the source code with Outline view.</para>
+ <figure float="0">
+ <title>Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/03_esb_outline_view.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Adding, editing or deleting of some artifacts operations are available right in the
+ <property moreinfo="none">Tree view</property> . Right-click any node and select one of the
+ available actions in the context menu. For example, you can easily add a new Provider:</para>
+ <para></para>
+ <figure float="0">
+ <title>Adding New Provider</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/04_esb_add_provider.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Then you can add Channels and Properties for the Providers the same way or using the forms with </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Edit</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and
+ </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Remove</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> buttons to the right.</diffmk:wrapper></para>
+
+ <para>You can easily add a new Service too:</para>
+ <figure float="0">
+ <title>Adding New Service</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/05_esb_add_service.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The same way you can create a listener for service and other elements of ESB:</para>
+ <figure float="0">
+ <title>Adding New Listener for Service</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/06_esb_add_listener.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The same actions can be done in the right part of <property moreinfo="none">Tree view</property> tab
+ (Form editor) using <property moreinfo="none">Add</property>, <property moreinfo="none">Edit</property> and
+ <property moreinfo="none">Remove</property> buttons.</para>
+
+
+ <para>In order to add a new generic Action to your ESB XML file you should select the
+ Actions node under the Services, then right-click and choose <emphasis>
+ <property moreinfo="none">New > Generic Action</property>. </emphasis></para>
+
+ <figure float="0">
+ <title>Adding New Action in the Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/11_esb_editor.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Or instead make use of <emphasis>
+ <property moreinfo="none">Add...</property>
+ </emphasis> button in the <property moreinfo="none">Form editor</property> on the left.</para>
+ <figure float="0">
+ <title>Adding New Action in the Form Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/12_esb_editor.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As you can see on the bath figures above, the context menu will also prompt you to
+ insert one of the Actions that are supplied out-of-the-box with <property moreinfo="none">JBoss
+ ESB</property>. After choosing one an appeared <property moreinfo="none">New Action wizard</property>
+ will ask you to fill out a name field and other fields specific for each Action
+ property. For example, for <emphasis>
+ <property moreinfo="none">Content Based Router</property>
+ </emphasis> Action the wizard looks as follows:</para>
+
+ <figure float="0">
+ <title>New Action Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/13_esb_editor.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After confirming creating the Action you can see it in the Tree under the <emphasis>
+ <property moreinfo="none">Actions</property>
+ </emphasis> node and preview as well as edit its settings in the <property moreinfo="none">Form
+ editor</property> on the left.</para>
+
+ <figure float="0">
+ <title>Form Editor for Content Based Router</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/14_esb_editor.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><property moreinfo="none">ESB editor</property> can recognize some specific objects. On the figure you
+ can see <emphasis>org.jboss.soa.esb.actions.ContentBasedRouter</emphasis> in the <emphasis>
+ <property moreinfo="none">Class</property>
+ </emphasis> section.</para>
+
+ </section>
+
+ <section id="esb_editors_features">
+
+ <title>ESB Editors Features</title>
+ <para>JBoss ESB tooling has powerful editor features that help you easily make use of
+ content and code assist.</para>
+ <para>This last chapter covers capabilities on how you can use ESB editor.</para>
+
+ <section id="ESBsyntaxvalidation84">
+
+ <title>ESB syntax validation</title>
+ <para>When working in <property moreinfo="none">JBoss ESB editor</property> you are constantly provided
+ with feedback and contextual error checking as you type. In the Source viewer, if at
+ any point a tag is incorrect or incomplete, an error will be indicated next to the
+ line and also in the <property moreinfo="none">Problems view</property> below.</para>
+ </section>
+
+ <section id="ESBSupportXMLSchema">
+ <title>Support for XML Schema</title>
+
+ <para>JBoss ESB Framework fully <link linkend="sourceView">supports XML files based on
+ schemas as well as DTDs</link>.</para>
+ <note><title>Note:</title>
+ <para>The schema used behind ESB editor now uses the latest version available (from SOA-P 4.3). This removes the errors/warnings some users have reported seeing when using SOA-P specific esb.xml files.</para> </note>
+
+ </section>
+
+ <!--<section id="OpenOnSelection">
+
+ <title>OpenOn</title>
+
+ <para><property>OpenOn</property> let's you easily navigate through your
+ project without using the Package Explorer view (project tree). With OpenOn, you can
+ simply click on a reference to another file and that file will be opened.</para>
+
+ <para>OpenOn is available for the XML files </para>
+
+ <para>Press and hold down the Ctrl key. As you move the mouse cursor over different
+ file references in the file, they display an underline. When you have the mouse
+ cursor over the name of the file you want to open, click and the file will open
+ in its own editor. In this example the managed bean NameBean will open.</para>
+
+ </section>
+ -->
+
+ <section id="ESBContentAssist">
+
+ <title>Content Assist for ESB XML file</title>
+
+ <para>When you work with any ESB XML file <property moreinfo="none">Content Assist</property> is
+ available to help you. It provides pop-up tip to help you complete your code
+ statements. It allows you to write your code faster and with more accuracy. Content
+ assist is always available in the Source mode. Simply type <emphasis>
+ <property moreinfo="none">Ctrl-Space</property>
+ </emphasis> to see what is available.</para>
+
+ <para>Content Assist for ESB XML file:</para>
+ <figure float="0">
+ <title>Content Assist for ESB XML file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/08_esb_features.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Content Assist for attributes:</para>
+ <figure float="0">
+ <title>Content Assist for attributes:</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/09_esb_features.png" scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <!-- </section>
+
+ <section id="ContentAssistWithinTreeEditor">
+
+ <title>Content Assist within Tree ESB Editor</title>
+
+ <para>JBoss Developer Studio also provides Content Assist when working within the Tree ESB editor.
+ Just click <emphasis><property>Ctrl-Space</property>.</emphasis></para>
+ <figure>
+ <title>Content Assist in Tree ESB Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/esb_file/09_editors_features.png" scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section> -->
+ </section>
+
+ <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing">
+
+ <title>Synchronized Source and Visual Editing</title>
+
+ <para>ESB file can be edited in either source or extra visual modes at the same time.</para>
+
+ <para>JBoss Tools provide you two different editors to speed your development: a
+ graphical view (<property moreinfo="none">Tree</property>) and source (<property moreinfo="none">Source</property>).
+ At the same time, you always have full control over esb source file. Any changes you
+ make in the source view will immediately appear in the tree view. Both views are
+ synchronized, you can edit the file in any view.</para>
+
+ <figure float="0">
+ <title>Two Views are Synchronized</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/esb_editor/10_esb_features.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">In summary, this reference supplies you with all necessary information on the
+ functionality that JBoss ESB Editor provides for work with JBoss ESB.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We hope, this guide helped you to get started with the JBoss ESB Tools. Besides, for additional information you are welcome on </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201"><diffmk:wrapper diffmk:change="added">JBoss forum</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+
+ </section>
+ </section>
+</chapter>
+
+
+</book>
15 years, 2 months
- 1
- 0
JBoss Tools SVN: r15186 - branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:19:04 -0400 (Mon, 11 May 2009)
New Revision: 15186
Added:
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/23_finger_touch.png
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/24_export_button.png
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/25_esb_file.png
branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/26_esb_export.png
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Copied: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/23_finger_touch.png (from rev 15128, trunk/esb/docs/esb_ref_guide/en/images/esb_project/23_finger_touch.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/24_export_button.png (from rev 15128, trunk/esb/docs/esb_ref_guide/en/images/esb_project/24_export_button.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/25_esb_file.png (from rev 15128, trunk/esb/docs/esb_ref_guide/en/images/esb_project/25_esb_file.png)
===================================================================
(Binary files differ)
Copied: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/images/esb_project/26_esb_export.png (from rev 15128, trunk/esb/docs/esb_ref_guide/en/images/esb_project/26_esb_export.png)
===================================================================
(Binary files differ)
15 years, 2 months
- 1
- 0
JBoss Tools SVN: r15185 - in branches/jbosstools-3.0.x/drools/docs/reference: en and 1 other directories.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2009-05-11 12:12:42 -0400 (Mon, 11 May 2009)
New Revision: 15185
Modified:
branches/jbosstools-3.0.x/drools/docs/reference/en/master.xml
branches/jbosstools-3.0.x/drools/docs/reference/en/modules/create_new_project.xml
branches/jbosstools-3.0.x/drools/docs/reference/en/modules/editors.xml
branches/jbosstools-3.0.x/drools/docs/reference/en/modules/introduction.xml
branches/jbosstools-3.0.x/drools/docs/reference/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch
Modified: branches/jbosstools-3.0.x/drools/docs/reference/en/master.xml
===================================================================
--- branches/jbosstools-3.0.x/drools/docs/reference/en/master.xml 2009-05-11 16:12:27 UTC (rev 15184)
+++ branches/jbosstools-3.0.x/drools/docs/reference/en/master.xml 2009-05-11 16:12:42 UTC (rev 15185)
@@ -37,7 +37,7 @@
<holder>JBoss, a division of Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 5.0.0.M5
+ Version: 5.0.0.CR1
</releaseinfo>
<abstract>
<title/>
Modified: branches/jbosstools-3.0.x/drools/docs/reference/en/modules/create_new_project.xml
===================================================================
--- branches/jbosstools-3.0.x/drools/docs/reference/en/modules/create_new_project.xml 2009-05-11 16:12:27 UTC (rev 15184)
+++ branches/jbosstools-3.0.x/drools/docs/reference/en/modules/create_new_project.xml 2009-05-11 16:12:42 UTC (rev 15185)
@@ -64,7 +64,7 @@
</mediaobject>
</figure>
- <para>You should see the <property>Prefernces window</property> where you can configure the
+ <para>You should see the <property>Preferences window</property> where you can configure the
workspace settings for Drools runtimes. To create a new runtime, press the <emphasis>
<property>Add</property>
</emphasis> button. The appeared dialog prompts you to enter a
Modified: branches/jbosstools-3.0.x/drools/docs/reference/en/modules/editors.xml
===================================================================
--- branches/jbosstools-3.0.x/drools/docs/reference/en/modules/editors.xml 2009-05-11 16:12:27 UTC (rev 15184)
+++ branches/jbosstools-3.0.x/drools/docs/reference/en/modules/editors.xml 2009-05-11 16:12:42 UTC (rev 15185)
@@ -185,28 +185,10 @@
<para>The <property>Rete Tree view</property> works only in Drools Rule Projects,
where the Drools Builder is set in the project properties.</para>
</note>
-
+ <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. Besides, for additional information you are welcome on <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
</section>
- </section>
- <!--
- <section id="guided_editor">
- <title>The Guided Editor</title>
-
- <para>The <property>Guided editor</property> allows you to build rules in a GUI driven
- fashion, based on your object model. </para>
</section>
-
- <section id="dsl_editor">
- <title>The Domain Specific Language Editor</title>
-
- <para/>
- </section>
-
- <section id="ruleflow_editor">
- <title>The Rule Flow Graphical Editor</title>
-
- <para/>
- </section>
- -->
+
</chapter>
Modified: branches/jbosstools-3.0.x/drools/docs/reference/en/modules/introduction.xml
===================================================================
--- branches/jbosstools-3.0.x/drools/docs/reference/en/modules/introduction.xml 2009-05-11 16:12:27 UTC (rev 15184)
+++ branches/jbosstools-3.0.x/drools/docs/reference/en/modules/introduction.xml 2009-05-11 16:12:42 UTC (rev 15185)
@@ -9,9 +9,9 @@
chaining inference based rules engine, more correctly known as a production rule system,
using an enhanced implementation of the Rete algorithm.</para>
- <para> In this guide we are going to get you familiar with Drools Eclipse plugin which provides
- development tools for creating, executing and debugging Drools processes and rules from
- within Eclipse.</para>
+ <para> In this guide we are going to get you familiar with Drools Eclipse plugin which
+ provides development tools for creating, executing and debugging Drools processes and
+ rules from within Eclipse.</para>
<note>
<title>Note:</title>
@@ -22,14 +22,15 @@
</note>
<para><property>Drools Tools</property> come bundled with <property>JBoss Tools</property>
- set of Eclipse plugins. How to install <property>JBoss Tools</property> you can find in the
- <ulink url="&gsglink;#JBossToolsInstall">Getting Started Guide</ulink>.</para>
+ set of Eclipse plugins. How to install <property>JBoss Tools</property> you can find in
+ the <ulink url="&gsglink;#JBossToolsInstall">Getting Started Guide</ulink>.</para>
</section>
<section id="drools_key_features">
<title>Drools Tools Key Features</title>
- <para>The following table lists all valuable features of the <property>Drools Tools</property>.</para>
+ <para>The following table lists all valuable features of the <property>Drools
+ Tools</property>.</para>
<table>
<title>Key Functionality of Drools Tools</title>
<tgroup cols="3">
@@ -160,10 +161,9 @@
</listitem>
<listitem>
- <para>
- <ulink url="http://www.jboss.com/products/devstudio/docs">Stable JBossTools/JBDS
- documentation</ulink> (supplied with the latest JBDS release, 1.1.0 GA
- currently) </para>
+ <para>All <property>JBoss Tools/JBDS</property> documentation you can find on the
+ <ulink url="http://docs.jboss.org/tools/">documentation release
+ page</ulink>.</para>
</listitem>
</itemizedlist>
Modified: branches/jbosstools-3.0.x/drools/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/drools/docs/reference/pom.xml 2009-05-11 16:12:27 UTC (rev 15184)
+++ branches/jbosstools-3.0.x/drools/docs/reference/pom.xml 2009-05-11 16:12:42 UTC (rev 15185)
@@ -86,6 +86,11 @@
<version>1.1.0</version>
<type>jdocbook-style</type>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
</dependencies>
<configuration>
15 years, 2 months
- 1
- 0