From jbosstools-commits at lists.jboss.org Mon May 31 11:33:33 2010 Content-Type: multipart/mixed; boundary="===============6605050664716494012==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r22442 - trunk/jbpm/docs/reference/en-US. Date: Mon, 31 May 2010 11:33:32 -0400 Message-ID: <201005311533.o4VFXWPe001274@svn01.web.mwc.hst.phx2.redhat.com> --===============6605050664716494012== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: ochikvina Date: 2010-05-31 11:33:32 -0400 (Mon, 31 May 2010) New Revision: 22442 Removed: trunk/jbpm/docs/reference/en-US/Test_Drive_Proc.xml trunk/jbpm/docs/reference/en-US/The_JBoss_jBPM_Int_Mech.xml trunk/jbpm/docs/reference/en-US/guided_tour_jboss_jbpmgpd.xml trunk/jbpm/docs/reference/en-US/jboss_jbpm_runtime_installation.xml Modified: trunk/jbpm/docs/reference/en-US/Introduction.xml Log: https://jira.jboss.org/browse/TOOLSDOC-23- = Finished the guide restructuring. Modified: trunk/jbpm/docs/reference/en-US/Introduction.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/jbpm/docs/reference/en-US/Introduction.xml 2010-05-31 14:19:48 UT= C (rev 22441) +++ trunk/jbpm/docs/reference/en-US/Introduction.xml 2010-05-31 15:33:32 UT= C (rev 22442) @@ -43,7 +43,7 @@ Write an example process test case - If you have questions, please feel free to contact If you have any questions, please feel free to contact Koen Aers or To= m Baeyens for more information. @@ -70,7 +70,7 @@ jPDL support Enables managing workflow processes as well as human tasks an= d interactions between - them. jPDL combines the best both Java and declarative process tech= niques. + them. jPDL combines the best techniques both in Java and in declara= tive process. = Deleted: trunk/jbpm/docs/reference/en-US/Test_Drive_Proc.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/jbpm/docs/reference/en-US/Test_Drive_Proc.xml 2010-05-31 14:19:48= UTC (rev 22441) +++ trunk/jbpm/docs/reference/en-US/Test_Drive_Proc.xml 2010-05-31 15:33:32= UTC (rev 22442) @@ -1,173 +0,0 @@ - - - - - - jBPM - - - - - - - Test Driven Process Development - - One of the most important advantages of JBoss jBPM's light= weight approach to BPM - and workflow management is that developers can easily leverage the= ir usual programming - skills and techniques. One of these well-known techniques is Unit = Testing and Test Driven - Development. - In this chapter we will show how developers, making use of the J= Boss jBPM GPD, can use a - technique we have baptized Test Driven Process Developme= nt to create - process definitions and test their correctness. - - When creating the - HellojBPM - project the Project Creation wizard has already put in= place all the library - requirements we need to start writing the jBPM unit tests. They ar= e contained in the jBPM - Library container and the most important of them is the - .jar - file containing the core jBPM classes. While working o= n the project you could - find them all in the Package Explorer. - -
- The jBPM Libraries - - - - - - -
- - It must be noted that it is possible to change the location of t= he core jBPM installation - by changing the preference settings. More on this see - later in this book. - - With that extra knowledge on the project settings, you can crea= te your first test. To do - this, we create the - com.jbay - package in the - test/java - source folder. Then we bring up the context menu on th= is package and select - New > Other... - - -
- Call the JUnit Test Case Creation wizard - - - - - - -
- - And then - Java > JUnit > JUnit Test Case - to call the specialized JUnite Test case creation wiza= rd. -
- Call the JUnit Test Case Creation wizard - - - - - - -
- - The wizard looks as follows: - -
- Create Test Dialog - - - - - - -
- - By default JUnit 3 version of testing framework is selected. Of = course, you can choose - new advanced JUnit 4 version. In this case you'll be prompted= to add new JUnit - Library to your build path. To add it automatically just click on = the appropriate link. In - the - Class under test - section you can specify the class to test. - In this guide we will use JUnit 3 version. -
- A First Test Scenario - - - - - - -
- - Then, we call the test class - HelloTest - and press - Finish - button to complete. - - Next, we should write a simple test scenario as shown on the ne= xt figure. Let's - study the code of this test case. - -
- A First Test Scenario - - - - - - -
- - In the first line of the method, a jBPM process archive object i= s created. We use a - constructor accepting the filename of the archive. In our case it = is the - hello - file we created earlier and which lives in the - src/main/jpdl - folder of our project. After asserting that this objec= t 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 th= is 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 w= ill be in the - auction - state. Finally another signal will end the process. - - - After writing this test we can check whether it works as expect= ed by running it . - -
- Running the Process Test - - - - - - -
- All went well as we have a green light: - -
- Successful Test Run - - - - - - -
- - Of course, this simple scenario was not very interesting, but t= he purpose of it was to - show how you can reuse your development skills in a very straightf= orward way when doing - process development. To see how more interesting processes and pro= cess test - scenario's can be developed, we suggest you to read the JBoss jBPM Us= er Guide and to - study the API reference. You can find it in the jBPM download fold= er. (To get started we - downloaded jbpm-jpdl-3.2.2 in the second - chapter. You should just remember where you extracted i= t.) All we've mentioned are in the 'javadoc- *' subfolders o= f the 'doc' folder. - Moreover, some more examples will be given later in this book. - - Deleted: trunk/jbpm/docs/reference/en-US/The_JBoss_jBPM_Int_Mech.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/jbpm/docs/reference/en-US/The_JBoss_jBPM_Int_Mech.xml 2010-05-31 = 14:19:48 UTC (rev 22441) +++ trunk/jbpm/docs/reference/en-US/The_JBoss_jBPM_Int_Mech.xml 2010-05-31 = 15:33:32 UTC (rev 22442) @@ -1,241 +0,0 @@ - - - - - - jBPM - - - - - - - Actions : The JBoss jBPM Integration Mechanism - - In this chapter we will show how to do software integration wit= h JBoss - jBPM. The standard mechanism to implement this is to wr= ap the functionality you - want to integrate in a class that implements the - ActionHandler - interface. In order to demonstrate it let's specify He= llo World action for our - process. - -
- Creating a Hello World Action - - 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 differe= nt points in the process - definition. To do this we have to specify an action handler, r= epresented by an - implementation of the - ActionHandler - interface, and attach this piece of code to a part= icular event. These events - are amongst others, going over a transition, leaving or enteri= ng nodes, after and before - signalling. - - To make things a little bit more concrete, let's creat= e a new class called - HelloActionHandler. - For that firstly we'll create a new package <= emphasis> - com.jbay.action - in the - src/java/main - folder of our project. Then, we should call New Cl= ass Creation wizard as - usual by right-clicking and navigating - New > Class. - - -
- Creating HelloActionHendler Class - - - - - - -
- - Notice that two first gaps have been filled automatically. H= ere, instead of - Package - option - Enclose type - option can be selected where a type in which to en= close a new class should - be specified. - - In our case, we leave everything as it is, just type - HelloActionHandler - as a name of new class and add - org.jbpm.graph.ActionHendler - interface as it's shown in the picture above.= - - Thus, our - HelloActionHandler - implements the - ActionHandler - interface including the - execute - method as shown in the next figure. Here, we add a= variable named - greeting - to the collection of process variables and put = a message in it : - "Hello from ActionHandler".= - -
- A Simple Hello Action - - - - - - -
- - Now, as we have - HelloActionHandler - class defined, let's explore how we can handl= e it. -
- -
- Integrating the Hello World Action - - 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 correc= tness of our actions as - well. - - As good Testcity citizens we will first create a Unit Test = that proves the behaviour - we want to achieve by adding the - ActionHandler - to the process. So we implement another test. - = - At first, let's return to the - code we already saw in the pre= vious chapter and add new test method - testActionHendler to it= . - = -
- Create the Hello Action Test - = - - - - - -
- = - We assert - that no variable called - greeting - exist. Then we give the process a signal to move i= t to the auction state. We - want to associate the execution of the action with the event o= f 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. Bu= t moreover, the - greeting - variable should exist and contain the string "Hello from - ActionHandler". That's what we assert in = the last lines of the test - method. - - = - - Running the tests now results in a failure. The point is th= at we did not associate - the action with any particular event in the process definition= , so the process variable - did not get set. - -
- Test Results Before Integration - - - - - - -
- - Let's do something about it and add an action to the f= irst 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 act= ion 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 a= vailable under the action - icon in the right upper corner of the Properties View. - -
- Adding an Action to a Transition - - - - - - -
- - After adding the action a tabbed view with three pages will = appear. - -
- Configuration Dialog for an Action - - - - - - -
- - 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 i= s asynchronous. The - Details page is the most important. It allows to choose and co= nfigure the actual action - handler implementation. - -
- The Details page of an Action Configuration Dialog</tit= le> - - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/The_JBoss_jBPM_Int_Mech/j= boss_jbpm_int_mech_7.png" scale=3D"80"/> - </imageobject> - </mediaobject> - </figure> - - - <para>Clicking on the <emphasis> - <property>Search...</property> - </emphasis> button brings us to a Choose Class dialog.</para> - - - <figure> - <title>The Choose Action Handler Dialog - - - - - - -
- - - We choose our previously created 'HelloActionHandler&a= pos; class and - push the OK button. After the selection o= f the action handler for - the action, we can run the test and observe it gives us a gree= n light. - -
- Test Results - - - - - - -
- - There we are. The above objective has been achieved. -
- -
- Integration Points - - The different integration points in a process definition ar= e thoroughly documented in - the JBoss jBP= M User Guide. 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 navi= gate to this view by - selecting the added Action in the outline view. - -
- - Deleted: trunk/jbpm/docs/reference/en-US/guided_tour_jboss_jbpmgpd.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/jbpm/docs/reference/en-US/guided_tour_jboss_jbpmgpd.xml 2010-05-3= 1 14:19:48 UTC (rev 22441) +++ trunk/jbpm/docs/reference/en-US/guided_tour_jboss_jbpmgpd.xml 2010-05-3= 1 15:33:32 UTC (rev 22442) @@ -1,225 +0,0 @@ - - - - - - jBPM - JBoss - Process - Definition - - - A Guided Tour of JBoss jBPM GPD - 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. - 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 adva= nced artifacts that - we will ignore for this section. In the future we will elaborate this wi= zard and offer the - possibility to create an empty jBPM project as well as projects based on= templates taken - from the jBPM tutorial. -
- - Creating a jBPM Project - This section will show you how to use the Creation wizard for crea= ting a new jBPM - project with already included source folders. - At first you should select - File >New Project... - and then - JBoss jBPM > Process Project - in the New Project dialog: -
- New Project Dialog - - - - - -
- Clicking - Next - brings us to the wizard page where it's necessary to s= pecify the - name and location for the project. We choose, for example, - HellojBPM - as the name and accept the default location. -
- Process Name and Location - - - - - -
- 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 - Use default location - and click - Browse... - button to set needed location or simply type it. - On the next screen you'll be prompted to select the core jBPM= location that - we have defined in the previous chapter. -
- Core jBPM Location Specifying - - - - - -
- Clicking on - Finish - results in the project being generated. The wizard creates = four source - folders: one for the processes ( - src/main/jpdl - ), one for the java sources ( - src/main/java - ), one for the unit tests ( - src/test/java - ) and one for the resources such as the jbpm.properties and = the - hibernate.properties files ( - src/main/config - ). In addition a classpath container with all the core jBPM = libraries is - added to the project -
- Layout of the Process Project - - - - - -
- Looking inside the different source folders will reveal a number o= f 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 defin= ition. -
-
- - Creating an Empty Process Definition - Now when the project is set up, we can use a Creation wizard to cr= eate an empty - process definition. Bring up the - New - wizard by clicking the - File > New > Other... - menu item. The wizard opens on the - Select Wizard - page. -
- The Select Wizard Page - - - - - -
- Selecting the - JBoss jBPM - category, then the - Process Definition - item and clicking on the - Next - button brings us to the - Create Process Definition - page. -
- The Create New Process Defining Page - - - - - -
- We choose - hello - as the name of the process archive file. Click on the - Finish - button to end the wizard and open the process definition ed= itor. -
- The Process Definition Editor - - - - - -
- - - You can see in the Package Explorer that creating a process defini= tion involves - creating a folder with the name of the process definition and populatin= g this folder - with two .xml files : - gpd.xml - , - processdefinition.xml and a .jpg file= : - processimage.jpg. - The - gpd.xml - contains the graphical information used by the process defi= nition editor. - The - processdefinition.xml - file contains the actual process definition info. - The graphical view of the process is automatically saved in - processimage.jpg = - file. - At present, the GPD assumes that these three files are siblings. More - sophisticated configuration will be supported later. - -
- - A Minimal Process Definition - Now we are ready to create a very simple process definition consi= sting of a begin - state, an intermediate state and an end state. - To make the configuration of actions much easier it's better= to use the - >"jBPM jPDL 3" perspective. = It provides the tabbed Properties Editor which allows to configure - all the relevant properties of the current selected item. - -
- - Adding the Nodes - At first select respectively - Start, - - State - and - End - on the tools palette and click on the canvas to add these= nodes to - the process definition. The result should look similar to this: -
- A Simple Process With Three Nodes - - - - - -
-
-
- - Adding Transitions - Then, we will connect the nodes with transitions. To do that sel= ect the - Transition - tool in the tools palette and click on the - Start - node, then move to the - State - node and click again to see the transition being drawn. P= erform the - same steps to create a transition from the - State - node to the - End - node. The result will look like: -
- A Simple Process With Transitions - - - - - -
- Now, when you've got background knowledge of simple project= creation, - let's move to more advanced tools. -
-
-
- - Deleted: trunk/jbpm/docs/reference/en-US/jboss_jbpm_runtime_installation.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/jbpm/docs/reference/en-US/jboss_jbpm_runtime_installation.xml 201= 0-05-31 14:19:48 UTC (rev 22441) +++ trunk/jbpm/docs/reference/en-US/jboss_jbpm_runtime_installation.xml 201= 0-05-31 15:33:32 UTC (rev 22442) @@ -1,49 +0,0 @@ - - - - - - jBPM - designer - process - JBoss Developer Studio - jBPM runtime - - - JBoss jBPM Runtime Installation - The main purpose of this chapter is to let you know how to launch t= he JBoss - jBPM (business process management). - The jBPM plugin (jBPM Designer) is already included in the JBoss Tools. - To make it work, you should only download the jBPM runtime (jbpm-jpdl-3.2.3 currently) and specify the directory where you= extracted the runtime - either when you create a jBPM project or by using the jBPM preference pa= ges. - - - Note: - Try to avoid using spaces in the names of installation folders. It= can provoke problems in - some situations with Sun-based VMs. - - - Navigate to - Window > Preferences > JBoss jBPM > Runtime Location= s. - Here you can add, edit and remove JBoss jBPM installation lo= cations. Click - Add - 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> - OK - then click - OK - again. - -
- Adding jBPM Location - - - - - -
- Now, when you have a runtime installed, we are going to demonstrate= some powerful features of - the jBPM. - --===============6605050664716494012==--