Drools Tools Reference Guide

From jbosstools-commits at lists.jboss.org Thu Mar 4 06:43:12 2010 Content-Type: multipart/mixed; boundary="===============9088277725347513747==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r20644 - in branches/jbosstools-3.1.x/drools/docs/reference: en and 1 other directory. Date: Thu, 04 Mar 2010 06:43:11 -0500 Message-ID: <201003041143.o24BhBsP031859@svn01.web.mwc.hst.phx2.redhat.com> --===============9088277725347513747== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: ochikvina Date: 2010-03-04 06:43:11 -0500 (Thu, 04 Mar 2010) New Revision: 20644 Modified: branches/jbosstools-3.1.x/drools/docs/reference/en/master_output.xml branches/jbosstools-3.1.x/drools/docs/reference/pom.xml Log:

https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files = here with the ones for JBDS 3.0.0 GA release.

Modified: branches/jbosstools-3.1.x/drools/docs/reference/en/master_output.= 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 --- branches/jbosstools-3.1.x/drools/docs/reference/en/master_output.xml 20= 10-03-04 11:32:52 UTC (rev 20643) +++ branches/jbosstools-3.1.x/drools/docs/reference/en/master_output.xml 20= 10-03-04 11:43:11 UTC (rev 20644) @@ -21,761 +21,1107 @@ = = -]> - = - - Drools Tools Reference Guide - - - - - = - - - = - = - - OlgaChikvina= = - = - April 2008 - - 2007 - 2009 - JBoss by Red Hat - - - Version: 5.1.0.trunk - - - - - PDF version - - - - - = - = - = - = - - Introduction - -

- What is Drools? - - Drools is a business = rule management system (BRMS) with a forward - chaining inference based rules engine, more correctly known as= a production rule system, - using an enhanced implementation of the Rete algorithm. - - In this guide we are going to get you familiar with Drools = Eclipse plugin which - provides development tools for creating, executing and debuggi= ng Drools processes and - rules from within Eclipse. - - - Note: - It is assumed that you has some familiarity with rule en= gines and Drools in - particular. If no, we suggest that you look carefully thro= ugh the Drools Documentation. - - - Drools Tools come bun= dled with JBoss Tools - set of Eclipse plugins. How to install JBoss Tools you can find in - the Getting Started Guide. -

- -

- Drools Tools Key Features - - The following table lists all valuable features of the Drools - Tools. - - Key Functionality of Drools Tools - - - - - - - - - Feature - Benefit - Chapter - - - - - - - - Wizard for creating a new Drools Project= - - - The wizard allows to create a sample pro= ject to easy get started - with Drools - - - Creati= ng a Sample Drools - Project - - - - - - Wizards for creation new Drools resource= s - - - A set of wizards are provided with the D= rools Eclipse tools to - quickly create a new Rule resource, a new = Domain Specific language, - Decision Table and Business rule - - - Creating a New= Rule - - - - - - - The Rule editor - - - An editor that is aware of DRL syntax an= d provides content - assistance and synchronizing with the Outl= ine view - - - The Rule= Editor - - - - - - The Domain Specific Language editor - - - The editor allows to create and manage m= appings from users - language to the rule language - - - - - - - - - The Guided editor - - - This guided editor for rules allows you = to build rules in a GUI - driven fashion based on your object model<= /para> - - - - - - - - - The Rule Flow graphical editor - - - The editor is meant for editing visual g= raphs which represent a - process (a rule flow) - - - - - - - - -

- -

- Other relevant resources on the topic - - - - Drools on JBoss.org - - - - - JBoss Tools= Home Page - - - - - - The latest - JBossTools/JBDS documentation builds - - - - - All JBoss Tools/JBDS documentation you can find on the - docume= ntation release - page. - - - -

- - - = - - - - JBoss Tools - Drools Tools - - - - Creating a New Drools Project - - In this chapter we are going to show you how to setup an executa= ble sample Drools project - to start using rules immediately. - - - -

- Creating a Sample Drools Project - - First, we suggest that you use D= rools perspective which is aimed - at work with Drools specific resources. - - To create a new Drools project follow to - File > New > Drools Proj= ect. This will open - New Drools Project wizard like on the figure below. - - On the first page type the project name and click - Next. - -

- Creating a New Drools Project - - - - - - - - Next you have a choice to add some default artifacts to it l= ike sample rules, decision - tables or ruleflows and Java classes for them. Let's select fi= rst two check - boxes and press - Next. - -

- Selecting Drools Project Elements - - - - - - - - Next page asks you to specify a Drools runtime. If you have = not yet set it up, you - should do this now by clicking the - Configure Workspace Settings - link. - -

- Configuring Drools Runtime - - - - - - - - You should see the Preferences w= indow where you can configure the - workspace settings for Drools runtimes. To create a new runtim= e, press the - Add - button. The appeared dialog prompts you to enter a - name for a new runtime and a path to the Drools runtime on you= r file system. - - - Note: - A Drools runtime is a collection of jars on your file sy= stem that represent one - specific release of the Drools project jars. While creatin= g a new runtime, you must - either point to the release of your choice, or you can sim= ply create a new runtime - on your file system from the jars included in the Drools E= clipse plugin. - - -

- Adding a New Drools Runtime - - - - - - - = - Let's simply create a new Drools 5 runtime from the jars emb= edded in the - Drools Eclipse plugin. Thus, you should press - Create a new Drools 5 runtime<= /property> - button and select the folder where you want this r= untime to be created and - hit - OK. - - You will see the newly created runtime show up in your list = of Drools runtimes. Check - it and press - OK. - -

- Selecting a Drools Runtime - - - - - - - - Now press - Finish - to complete the project creation. - -

- Completing the Drools Project Creation - - - - - - - - This will setup a basic structure, classpath and sample rule= s and test case to get you - started. -

- - -

- Drools Project Structure Overview - - Now let's look at the structure of the organized project. In= the - Package Explorer yo= u should see the following: - -

- Drools Project in the Package Explorer - - - - - - - - The newly created project contains an example rule file - Sample.drl - in the - src/main/rules - directory and an example java file - DroolsTest.java - that can be used to execute the rules in a Drools = engine in the folder - src/main/java - , in the - com.sample - package. All the others jar's that are necessary d= uring execution - are also added to the classpath in a custom classpath containe= r called Drools - Library. - - - Tip: - Rules do not have to be kept in Java projects at all, th= is is just a convenience - for people who are already using eclipse as their Java IDE= . - - -

- -

- Creating a New Rule - - Now we are going to add a new Rule resource to the project.<= /para> - - You can either create an empty text - .drl - file or make use of the special New Rule Resource - wizard to do it. - - To open the wizard follow to - File > New > Rule Resour= ce - or use the menu with the JBoss Drools icon on the = toolbar. - -

- Opening the New Rule Resource Wizard - - - - - - - - On the wizard page first select - /rules - as a top level directory to store your rules and t= ype the rule name. Next - it's mandatory to specify the rule package name. It defines a = namespace that - groups rules together. - -

- New Rule Resource Wizard - - - - - - - - As a result the wizard generates a rule skeleton to get you = started. - -

- New Rule - - - - - - - -

- - - - = - - - - JBoss Tools - Drools Tools - - - - Debugging rules - = - This chapter describes how to debug rules during the execution of y= our Drools application. - -

- Creating Breakpoints - = - At first, we'll focus on how to add - breakpoints in the consequences of your rules. - = - Whenever such a breakpoint is uncounted - during the execution of the rules, the execution is halted. It's possib= le then inspect the - variables known at that point and use any of the default debugging acti= ons to decide what - should happen next (step over, continue, etc). To inspect - the content of the working memory and agenda the Debug views can be use= d. - - You can add/remove rule breakpoints in - .drl - files in two ways, similar to adding breakpoints to Java fi= les: - - - - Double-click the ruler in the Rule e= ditor at the line - where you want to add a breakpoint. - - Tip: - Note that rule breakpoints can only be created in the consequen= ce of a - rule. Double-clicking on a line where no breakpoint is allowed will = do - nothing. - - A breakpoint can be removed by double-clicking the ruler once mo= re. - - - - Right-click the ruler. Select - Toggle Breakpoint - action in the appeared popup menu. Clicking the action wi= ll add a - breakpoint at the selected line or remove it if there is one already.= - - - -

- Adding Breakpoints - - - - - - - - The Debug perspective conta= ins a Breakpoints - view which can be used to see all defined breakpoints, get = their - properties, enable/disable or remove them, etc. You can switch to it by= navigating to - Window > Perspective > Others > D= ebug. -

- -

- Debugging - - Drools breakpoints are only enabled if you debug your application = as a Drools - Application. To do this you should perform one of the actions: - - - - Select the main class of your application. Right click it and se= lect - Debug As > Drools Application. - - -

- Debugging Drools Application - - - - - - - - - - Alternatively, you can also go to - Debug As > Debug Configuration - to open a new dialog for creating, managing and running d= ebug - configurations. - - Select the - Drools Application - item in the left tree and click the - New launch configuration - button (leftmost icon in the toolbar above the tree). Thi= s will - create a new configuration and already fill in some of the properties= (like the - Project and Main class) based on main class you selected in the begin= ning. All - properties shown here are the same as any standard Java program. - - - -

- New Debug Configuration - - - - - - - - - Tip: - Remember to change the name of your debug configuration to someth= ing meaningful. - - = - Next - click the - Debug - button on the bottom to start debugging your application. <= /para> - - After enabling the debugging, the application starts executing and= will halt if - any breakpoint is encountered. This can be a Drools rule breakpoint, or= any other - standard Java breakpoint. Whenever a Drools rule breakpoint is encounte= red, the - corresponding - .drl file is opened = and the active line is highlighted. The Variables view - also contains all rule parameters and their value. You can then use the= default Java - debug actions to decide what to do next (resume, terminate, step over, = etc.). The debug - views can also be used to determine the contents of the working memory = and agenda at - that time as well (you don't have to select a working memory now, the c= urrent executing - working memory is automatically shown). - = - = -

- - - = - - - - JBoss Tools - Drools Tools - - - - Editors - -

- The Rule Editor - - The Rule editor works= on files that have a - .drl - (or - .rule - in the case of spreading rules across multiple rul= e files) extension. - -

- New Rule - - - - - - - - The editor follows the pattern of a normal text editor in ec= lipse, with all the normal - features of a text editor: - - - - - Content = Assist - - - - - - Code Foldi= ng - - - - - - - - Synch= ronization with Outline - View - - - - -

- Content Assist - - While working in the Rule ed= itor you can get a content - assistance the usual way by pressing - Ctrl + Space. - - Content Assist shows all possible keywords for the curre= nt cursor position. - -

- Content Assist Demonstration - - - - - - - - Content Assist inside of the - Message - suggests all available fields. - -

- Content Assist Demonstration - - - - - - - -

- -

- Code Folding - - Code folding is also available in the Rule editor. To - hide/show sections of the file use the icons with minus/pl= us on the left vertical - line of the editor. - -

- Code Folding - - - - - - - -

- - - -

- Synchronization with Outline View - - The Rule editor w= orks in synchronization with the - Outline view wh= ich shows the structure of the rules, - imports in the file and also globals and functions if the = file has them. - -

- Synchronization with Outline View - - - - - - - - The view is updated on save. It provides a quick way of = navigating around rules by - names in a file which may have hundreds of rules. The item= s are sorted - alphabetically by default. -

- -

- The Rete Tree View - - The Rete Tree view shows you the current Rete Network for - your - .drl - file. Just click on the - Rete Tree tab - at the bottom of the Rule editor. - -

- Rete Tree - - - - - - - - Afterwards you can generate the current Rete Network vis= ualization. You can push - and pull the nodes to arrange your optimal network overvie= w. - If you got hundreds of nodes, select some of them with a= frame. Then you can pull - groups of them. - -

- Selecting the nodes in the Rete Tree with Frame</ti= tle> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/editors/editors7.png"= ></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>You can zoom in and out the Rete tree in case not all no= des are shown in the - current view. For this use the combo box or "+" and "-" ic= ons on the toolbar.</para> - - <figure float=3D"0"> - <title>Rete Tree Zooming - - - - - - - - - Note: - - The Rete Tree view works only in Drools Rule Projects, - where the Drools Builder is set in the project propert= ies. - - We hope, this guide helped you to get started with the J= Boss BPMN Convert module. Besides, for additional information you are welco= me on JBoss forum. -

- = -

- = - - - = - = - +]> + = + + Drools Tools Reference Guide + + + + + = + + + = + = + + OlgaChikvina= = + = + + 2007 + 2008 + 2009 + 2010 + JBoss by Red Hat + + + Version: 5.1.0.trunk + + + + + PDF version + + + + + = + = + = + = + + Introduction + +

+ What is Drools? + + Drools is a business = rule management system (BRMS) with a forward + chaining inference based rules engine, more correctly known as= a production rule system, + using an enhanced implementation of the Rete algorithm. + + In this guide we are going to get you familiar with Drools = Eclipse plugin which + provides development tools for creating, executing and debuggi= ng Drools processes and + rules from within Eclipse. + + + Note: + It is assumed that you has some familiarity with rule en= gines and Drools in + particular. If no, we suggest that you look carefully thro= ugh the Drools Documentation. + + + Drools Tools come bun= dled with JBoss Tools + set of Eclipse plugins. How to install JBoss Tools you can find in + the Getting Started Guide. +

+ +

+ Drools Tools Key Features + + The following table lists all valuable features of the Drools + Tools. + + Key Functionality of Drools Tools + + + + + + + + + Feature + Benefit + Chapter + + + + + + + + Wizard for creating a new Drools Project= + + + The wizard allows to create a sample pro= ject to easy get started + with Drools + + + Creati= ng a Sample Drools + Project + + + + + + Wizards for creation new Drools resource= s + + + A set of wizards are provided with the D= rools Eclipse tools to + quickly create a new Rule resource, a new = Domain Specific language, + Decision Table and Business rule + + + Creating a New= Rule + + + + + + + The Rule editor + + + An editor that is aware of DRL syntax an= d provides content + assistance and synchronizing with the Outl= ine view + + + The Rule= Editor + + + + + + The Domain Specific Language editor + + + The editor allows to create and manage m= appings from users + language to the rule language + + + The Domain Specif= ic Language Editor + + + + + + The Guided editor + + + This guided editor for rules allows you = to build rules in a GUI + driven fashion based on your object model<= /para> + + + + + + + + + The Rule Flow graphical editor + + + The editor is meant for editing visual g= raphs which represent a + process (a rule flow) + + + The Rule Flo= w Graphical Editor + + + + + +

+ +

+ Other relevant resources on the topic + + + + Drools on JBoss.org + + + + + JBoss Tools= Home Page + + + + + + The latest + JBossTools/JBDS documentation builds + + + + + All JBoss Tools/JBDS documentation you can find on the + docume= ntation release + page. + + + +

+ + + = + + + + JBoss Tools + Drools Tools + + + + Creating a New Drools Project + + In this chapter we are going to show you how to setup an executa= ble sample Drools project + to start using rules immediately. + + + +

+ Creating a Sample Drools Project + + First, we suggest that you use D= rools perspective which is aimed + at work with Drools specific resources. + + To create a new Drools project follow to + File > New > Drools Proj= ect. This will open + New Drools Project wizard like on the figure below. + + On the first page type the project name and click + Next. + +

+ Creating a New Drools Project + + + + + + + + Next you have a choice to add some default artifacts to it l= ike sample rules, decision + tables or ruleflows and Java classes for them. Let's select fi= rst two check + boxes and press + Next. + +

+ Selecting Drools Project Elements + + + + + + + + Next page asks you to specify a Drools runtime. If you have = not yet set it up, you + should do this now by clicking the + Configure Workspace Settings + link. + +

+ Configuring Drools Runtime + + + + + + + + You should see the Preferences w= indow where you can configure the + workspace settings for Drools runtimes. To create a new runtim= e, press the + Add + button. The appeared dialog prompts you to enter a + name for a new runtime and a path to the Drools runtime on you= r file system. + + + Note: + A Drools runtime is a collection of jars on your file sy= stem that represent one + specific release of the Drools project jars. While creatin= g a new runtime, you must + either point to the release of your choice, or you can sim= ply create a new runtime + on your file system from the jars included in the Drools E= clipse plugin. + + +

+ Adding a New Drools Runtime + + + + + + + = + Let's simply create a new Drools 5 runtime from the jars emb= edded in the + Drools Eclipse plugin. Thus, you should press + Create a new Drools 5 runtime<= /property> + button and select the folder where you want this r= untime to be created and + hit + OK. + + You will see the newly created runtime show up in your list = of Drools runtimes. Check + it and press + OK. + +

+ Selecting a Drools Runtime + + + + + + + + Now press + Finish + to complete the project creation. + +

+ Completing the Drools Project Creation + + + + + + + + This will setup a basic structure, classpath and sample rule= s and test case to get you + started. +

+ + +

+ Drools Project Structure Overview + + Now let's look at the structure of the organized project. In= the + Package Explorer yo= u should see the following: + +

+ Drools Project in the Package Explorer + + + + + + + + The newly created project contains an example rule file + Sample.drl + in the + src/main/rules + directory and an example java file + DroolsTest.java + that can be used to execute the rules in a Drools = engine in the folder + src/main/java + , in the + com.sample + package. All the others jar's that are necessary d= uring execution + are also added to the classpath in a custom classpath containe= r called Drools + Library. + + + Tip: + Rules do not have to be kept in Java projects at all, th= is is just a convenience + for people who are already using eclipse as their Java IDE= . + + +

+ +

+ Creating a New Rule + + Now we are going to add a new Rule resource to the project.<= /para> + + You can either create an empty text + .drl + file or make use of the special New Rule Resource + wizard to do it. + + To open the wizard follow to + File > New > Rule Resour= ce + or use the menu with the JBoss Drools icon on the = toolbar. + +

+ Opening the New Rule Resource Wizard + + + + + + + + On the wizard page first select + /rules + as a top level directory to store your rules and t= ype the rule name. Next + it's mandatory to specify the rule package name. It defines a = namespace that + groups rules together. + +

+ New Rule Resource Wizard + + + + + + + + As a result the wizard generates a rule skeleton to get you = started. + +

+ New Rule + + + + + + + +

+ + + + = + + + + JBoss Tools + Drools Tools + + + + Debugging rules + = + This chapter describes how to debug rules during the execution of y= our Drools application. + +

+ Creating Breakpoints + = + At first, we'll focus on how to add + breakpoints in the consequences of your rules. + = + Whenever such a breakpoint is uncounted + during the execution of the rules, the execution is halted. It's possib= le then inspect the + variables known at that point and use any of the default debugging acti= ons to decide what + should happen next (step over, continue, etc). To inspect + the content of the working memory and agenda the Debug views can be use= d. + + You can add/remove rule breakpoints in + .drl + files in two ways, similar to adding breakpoints to Java fi= les: + + + + Double-click the ruler in the Rule e= ditor at the line + where you want to add a breakpoint. + + Tip: + Note that rule breakpoints can only be created in the consequen= ce of a + rule. Double-clicking on a line where no breakpoint is allowed will = do + nothing. + + A breakpoint can be removed by double-clicking the ruler once mo= re. + + + + Right-click the ruler. Select + Toggle Breakpoint + action in the appeared popup menu. Clicking the action wi= ll add a + breakpoint at the selected line or remove it if there is one already.= + + + +

+ Adding Breakpoints + + + + + + + + The Debug perspective conta= ins a Breakpoints + view which can be used to see all defined breakpoints, get = their + properties, enable/disable or remove them, etc. You can switch to it by= navigating to + Window > Perspective > Others > D= ebug. +

+ +

+ Debugging + + Drools breakpoints are only enabled if you debug your application = as a Drools + Application. To do this you should perform one of the actions: + + + + Select the main class of your application. Right click it and se= lect + Debug As > Drools Application. + + +

+ Debugging Drools Application + + + + + + + + + + Alternatively, you can also go to + Debug As > Debug Configuration + to open a new dialog for creating, managing and running d= ebug + configurations. + + Select the + Drools Application + item in the left tree and click the + New launch configuration + button (leftmost icon in the toolbar above the tree). Thi= s will + create a new configuration and already fill in some of the properties= (like the + Project and Main class) based on main class you selected in the begin= ning. All + properties shown here are the same as any standard Java program. + + + +

+ New Debug Configuration + + + + + + + + + Tip: + Remember to change the name of your debug configuration to someth= ing meaningful. + + = + Next + click the + Debug + button on the bottom to start debugging your application. <= /para> + + After enabling the debugging, the application starts executing and= will halt if + any breakpoint is encountered. This can be a Drools rule breakpoint, or= any other + standard Java breakpoint. Whenever a Drools rule breakpoint is encounte= red, the + corresponding + .drl file is opened = and the active line is highlighted. The Variables view + also contains all rule parameters and their value. You can then use the= default Java + debug actions to decide what to do next (resume, terminate, step over, = etc.). The debug + views can also be used to determine the contents of the working memory = and agenda at + that time as well (you don't have to select a working memory now, the c= urrent executing + working memory is automatically shown). + = + = +

+ + + = + + + + JBoss Tools + Drools Tools + + + + Editors +

+ DSL Editor + A domain-specific language is a set of custom rules, + that is created specifically to solve problems in a particular= domain = + and is not intended to be able to solve problems outside it. + A DSL's configuration is stored in plain text. = + + In Drools this configuration is presented by .dsl + files that can be created by right click on the proj= ect->New->Other->Drools->Domain Specific Language. + DSL Editor is a default editor for .dsl files: +

+ DSL Editor + + + + + + + In the table below all the components of the DSL Editor page= are described: + + DSL Editor Components. = + + + + = + + + Components = + Description + + + + + Description + User's comments on a certain language messa= ge mapping + = + + Table of language message mappings + The table is divided into 4 rows: + + Language Expression<= /emphasis> :expression you want to use as a rule + Rule Language Mappin= g :the implementation of the rules.This means that to this langu= age expression the rule will be compiled = + by the rule engine compiler. + Object :n= ame of the object + Scope :in= dicates where the expression is + targeted: is it for the "condition" part o= f the rule ,"consequence" part, etc. + + By clicking on some row's header you can sort the= lines in the table according to the clicked row. + By double clicking on the line Edit language mapping Wizard will be open. = + + = + + Expression + Shows the language expression of the select= ed table line(language message mapping). + = + = + + Mapping + Shows the rule of language mapping for the = selected table line(language message mapping). + = + + Object + Shows the object for the selected table lin= e(language message mapping) + = + + + Sort By + Using this option you can change the type o= f lines sorting = + in the table of language message mappings.To d= o this select from the drop down lins the method + of sorting you want and click Sort button. + + + Buttons + + Edit :by = clicking the button users can edit + selected in the table of language message = mappings lines.For more information look + Edit langua= ge mapping Wizardsection. + Remove :i= f you click the button the selected mapping line will be deleted. + Add :with= this button you can add new mapping lines to the table.For more informatio= n look = + Add language= mapping Wizardsection. + Sort : pl= ease, for more information go here + Copy :wit= h this button you can add new mapping lines to the table + in which all the information will be copie= d from the selected mapping line. + + + = + + +

+ Edit language mapping Wizard + This wizard can be opened by double clicking some line = + in the table of language message mappings or by clicking t= he Editbutton. + On the picture below you can see all the options,Edit la= nguage mapping Wizard allow to change. + Their names as well as the meaning of the options are co= rrespond to the rows of the table. +

+ Edit language mapping Wizard + + + + + + + To change the mapping a user should edit the otions he w= ant and finally click Ok. +

+ Add language mapping Wizard + This wizard is equal to Ed= it language mapping Wizard. + It can be opened by clicking the Add butt= on. + + The only difference is that instead of editing the infor= mation you should enter new one. +

+ Add language mapping Wizard + + + + + + +

= +

+ Flow Editor + Drools tools also provide some functionality to define the o= rder in = + which rules should be executed.Ruleflow file allows you to spe= cify = + the order in which rule sets should be evaluated using a flow = chart. + So you can define which rule sets should be evaluated in seque= nce or in parallel as well as + specify conditions under which rule sets should be evaluated.<= /para> + Ruleflows can be set only by using the graphical flow editor= which is part of the Drools plugin for Eclipse. + Once you have set up a Drools project,you can start adding rul= eflows. + Add a ruleflow file(.rf) by clicking on the project and select= ing "New -> Other...->Flow File": = +

+ RuleFlow file creation + + + + + + + By default these ruleflow files (.rf) are opened in the grap= hical Flow editor. + You can see it on the picture below. +

+ Flow Editor + + + + + + + The Flow editor consists of a palette, = a canvas + and an outline view. To add new elements = to the canvas, select the = + element you would like to create in the palette and then add i= t to the canvas by clicking on the preferred location. + +

+ Adding an element to the canvas + + + + + + + Clicking on the Select option in the palette and + then on the element in your ruleflow allows you to = + view and set the properties of that element in the properies v= iew. +

+ Properties view + + + + + + + Outline View is useful for big complex schemata where not al= l nodes are seen at one time. + So using your Outline view you can easly navigate between parts of= a schema. +

+ Outline view usage + + + + + + +

+ Different types of control elements in Flow Palette</ti= tle> + <para>Flow editor supports three types of control elements. + They are:</para> + <table> <title>Flow Palette Components.Part 1 = + + <= /colspec> + <= /colspec> + <= /colspec> + = + + + Component Picture + Component Name = + Description + + + + + + + + + Select + Select a node on the canvas + + + + + + + Marquee + Is used for selecting a group of elemen= ts + + + + + + + Sequence Flow + Use this element to join two elements o= n the canvas + + + = + + +

+ = +

+ Different types of nodes in Flow Palette + = + Currently, ruleflow supports seven types of nodes. + In the table below you can find information about them: + Flow Palette Components.Part 2. = + + <= /colspec> + <= /colspec> + <= /colspec> + = + + + Component Picture + Component Name = + Description + + = + + + + + + + + Start Event + The start of the ruleflow. A ruleflow s= hould have exactly = + one start node. The Start Event can not have incoming + connections and should have one outgoing c= onnection. Whenever the ruleflow process is started, = + the executing is started here and is autom= atically proceeded to the first node = + linked to this Start Event + + + + + + + End Event + A ruleflow file can have one or more <= property moreinfo=3D"none">End Events. + The End Event<= /property> node should have one incoming connection + and can not have outgoing connections. Whe= n an end node is reached in the ruleflow, + the ruleflow is terminated (including othe= r remaining active nodes when parallelism + is used). + = + + = + + + + Rule Task + represents a set of rules. A = Rule Task node should have one + incoming connection and one outgoing conne= ction. = + The RuleFlowGr= oup property which is used to specify the name of the + ruleflow-group that represents the set of = rules of this Rule Task node. + When a Rule Task node= is reached in the ruleflow, the engine will start + executing rules that are a part of the cor= responding ruleflow-group. + Execution automatically continues to the n= ext node when there are no + more active rules in this ruleflow-group. = + + + + = + + + + Gateway[diverge] + allows you to create branches in your r= uleflow. + A Gateway[dive= rge] node should have one incoming connection and two or more + outgoing connections. + + + = + + + + Gateway[converge] + allows you to synchronize multiple bran= ches. + A Gateway[dive= rge]node should have two or more incoming connections and one + outgoing connection. + = + + = + + + + Reusable Sup-Process + represents the invocation of another ru= leflow from this ruleflow. + A subflow node should have one incoming co= nnection and one outgoing connection. = + It contains the property "processId" which= specifies the id of the process that should be executed. = + When a Reusabl= e Sup-Process node is reached in the ruleflow, the engine will s= tart the process with the given id. + The subflow node will only continue if tha= t subflow process has terminated its execution. + Note that the subflow process is started a= s an independent process, = + which means that the subflow process will = not be terminated if this process reaches an end node. + + + = + + + + Script Task + represents an action that should be exe= cuted in this ruleflow. + An Script Task= node should have one incoming connection and one outgoing + connection. It contains the property "acti= on" which specifies the action that should be executed. + When a Script = Task node is reached in the ruleflow, it will execute the action= and = + continue with the next node. An action sho= uld be specified as a piece of (valid) + MVEL code. + + + + +

+ = +

+ The Rule Editor + + The Rule editor works= on files that have a + .drl + (or + .rule + in the case of spreading rules across multiple rul= e files) extension. + +

+ New Rule + + + + + + + + The editor follows the pattern of a normal text editor in ec= lipse, with all the normal + features of a text editor: + + + + + Content = Assist + + + + + + Code Foldi= ng + + + + + + + + Synch= ronization with Outline + View + + + + +

+ Content Assist + + While working in the Rule ed= itor you can get a content + assistance the usual way by pressing + Ctrl + Space. + + Content Assist shows all possible keywords for the curre= nt cursor position. + +

+ Content Assist Demonstration + + + + + + + + Content Assist inside of the + Message + suggests all available fields. + +

+ Content Assist Demonstration + + + + + + + +

+ +

+ Code Folding + + Code folding is also available in the Rule editor. To + hide/show sections of the file use the icons with minus/pl= us on the left vertical + line of the editor. + +

+ Code Folding + + + + + + + +

+ + + +

+ Synchronization with Outline View + + The Rule editor w= orks in synchronization with the + Outline view wh= ich shows the structure of the rules, + imports in the file and also globals and functions if the = file has them. + +

+ Synchronization with Outline View + + + + + + + + The view is updated on save. It provides a quick way of = navigating around rules by + names in a file which may have hundreds of rules. The item= s are sorted + alphabetically by default. +

+ +

+ The Rete Tree View + + The Rete Tree view shows you the current Rete Network for + your + .drl + file. Just click on the + Rete Tree tab + at the bottom of the Rule editor. + +

+ Rete Tree + + + + + + + + Afterwards you can generate the current Rete Network vis= ualization. You can push + and pull the nodes to arrange your optimal network overvie= w. + If you got hundreds of nodes, select some of them with a= frame. Then you can pull + groups of them. + +

+ Selecting the nodes in the Rete Tree with Frame</ti= tle> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/editors/editors7.png"= ></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can zoom in and out the Rete tree in case not all no= des are shown in the + current view. For this use the combo box or "+" and "-" ic= ons on the toolbar.</para> + + <figure float=3D"0"> + <title>Rete Tree Zooming + + + + + + + + + Note: + + The Rete Tree view works only in Drools Rule Projects, + where the Drools Builder is set in the project propert= ies. + + We hope, this guide helped you to get started with the J= Boss BPMN = + Convert module. Besides, for additional information you ar= e welcome on = + JBoss forum. +

+ = +

+ = + + + = + = + Modified: branches/jbosstools-3.1.x/drools/docs/reference/pom.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 --- branches/jbosstools-3.1.x/drools/docs/reference/pom.xml 2010-03-04 11:3= 2:52 UTC (rev 20643) +++ branches/jbosstools-3.1.x/drools/docs/reference/pom.xml 2010-03-04 11:4= 3:11 UTC (rev 20644) @@ -11,45 +11,35 @@ Drools_Tools_Reference_Guide = - - release - - master_output.xml - classpath:/xslt/org/jboss/tools/xhtml-single-r= elease.xsl - classpath:/xslt/org/jboss/tools/xhtml-release= .xsl - classpath:/xslt/org/jboss/tools/pdf.xsl - - - - releaseTest - - master_output.xml - classpath:/xslt/org/jboss/tools/xhtml-single-r= elease-nomarker.xsl - classpath:/xslt/org/jboss/tools/xhtml-release= -nomarker.xsl - classpath:/xslt/org/jboss/tools/pdf.xsl - - - - releaseJBDS - - master_output.xml - classpath:/xslt/com/jboss/tools/xhtml-single-r= elease.xsl - classpath:/xslt/com/jboss/tools/xhtml-release= .xsl - classpath:/xslt/com/jboss/tools/pdf.xsl - ../../../documentation/jbosstools-jdocbook-style/s= rc/main/com/css/ - - - - diffmk - - master_output.xml - classpath:/xslt/org/jboss/tools/xhtml-single-d= iff.xsl - classpath:/xslt/org/jboss/tools/xhtml-diff.xs= l - classpath:/xslt/org/jboss/tools/pdf-diff.xsl - - - - = + + release + + master_output.xml + classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl + classpath:/xslt/org/jboss/tools/xhtml-release.xsl + classpath:/xslt/org/jboss/tools/pdf.xsl + + + + releaseJBDS + + master.xml + classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl + classpath:/xslt/com/jboss/tools/xhtml-release.xsl + classpath:/xslt/com/jboss/tools/pdf.xsl + ../../../documentation/jbosstools-jdocbook-style/src/main/com/= css/ + + + + diffmk + + master_output.xml + classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl + classpath:/xslt/org/jboss/tools/xhtml-diff.xsl + classpath:/xslt/org/jboss/tools/pdf-diff.xsl + + + --===============9088277725347513747==--