Author: irooskov(a)redhat.com Date: 2010-03-11 19:08:45 -0500 (Thu, 11 Mar 2010) New Revision: 20775 Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Author_Group.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/Preface.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/Revision_History.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new_project.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/debugging_rules.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/editors.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project10.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project2.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project3.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project4.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project5.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project6.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project7.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project9.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules2.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules3.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1a.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1b.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1c.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1d.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1e.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1f.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1g.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors2.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors3.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors4.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors5.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors6.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors7.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors8.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors9.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon2.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon3.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon4.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon5.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon6.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon7.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon8.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon9.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/jbosstools_logo.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/views/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/views/views1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/introduction.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/master.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/master_output.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/views.xml branches/jbosstools-3.1.x/drools/docs/reference/publican.cfg Removed: branches/jbosstools-3.1.x/drools/docs/reference/en/ Modified: branches/jbosstools-3.1.x/drools/docs/reference/pom.xml Log: updated to use publican Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Author_Group.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author><firstname>Olga</firstname><surname>Chikvina</surname></author></authorgroup> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Book_Info.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>Drools Tools Reference Guide</title><subtitle>Provides information relating to the Drools Tools set.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The Drools Tools Reference Guide explains how to use the Drools Tools for creating, executing and debugging Drools processes and rules.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "Drools_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,14 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="create_new_project.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<!--<xi:include href="create_new.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... +<xi:include href="debugging_rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<!--<xi:include href="views.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... +<xi:include href="editors.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Preface.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Revision_History.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov@redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="create_new" xreflabel="create_new"> + + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Drools Perspective</title> + + <section id="creating_dsl"> + <title>Creating a New DSL</title> + + <para>Domain Specific Languages (DSL) allows to read your rules like natural + language.</para> + + <para>There is a wizard for creating a sample DSL file which is called from <emphasis> + <property>File > New > Domain Specific Language</property> + </emphasis> or using the menu with the JBoss Drools icon on the toolbar.</para> + + <figure> + <title>Calling New DSL Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the wizard page select the parent folder and give a proper name to your <emphasis> + <property>.dsl</property> + </emphasis> file. Then hit <emphasis> + <property>Finish</property> + </emphasis> to create a file and open it in the <link linkend="dsl_editor">DSL + editor</link>.</para> + + <figure> + <title>New DSL Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project8.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="creating_decision_table"> + <title>Creating a New Decision Table</title> + <para/> + </section> + + <section id="creating_business_rule"> + <title>Creating a New Business Rule</title> + + <para>To create a rule this way, use the wizard menu. It will create an instance of a <emphasis> + <property>.brl</property> + </emphasis> file and open it in the <link linkend="guided_editor">Guided editor</link>. + The <property>Guided editor</property> works based on a <emphasis> + <property>.package</property> + </emphasis> file in the same directory as the <emphasis> + <property>.brl</property> + </emphasis> file. In this <emphasis> + <property>.package</property> + </emphasis> file you have the package name and import statements, just like you would in + the top of a normal DRL file. So the first time you create a brl rule, you will need to + populate the package file with the fact classes you are interested in.</para> + </section> +</chapter> \ No newline at end of file Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new_project.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new_project.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new_project.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,216 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="create_new_project" xreflabel="create_new_project"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a New Drools Project</title> + + <para>In this chapter we are going to show you how to setup an executable sample Drools project + to start using rules immediately.</para> + + + + <section id="sample_drools_project"> + <title>Creating a Sample Drools Project</title> + + <para>First, we suggest that you use <property>Drools perspective</property> which is aimed + at work with Drools specific resources.</para> + + <para>To create a new Drools project follow to <emphasis> + <property>File > New > Drools Project</property>. </emphasis> This will open + <property>New Drools Project wizard</property> like on the figure below.</para> + + <para>On the first page type the project name and click + <emphasis><property>Next</property>.</emphasis></para> + + <figure> + <title>Creating a New Drools Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next you have a choice to add some default artifacts to it like sample rules, decision + tables or ruleflows and Java classes for them. Let&apos;s select first two check + boxes and press <emphasis> + <property>Next</property>. </emphasis></para> + + <figure> + <title>Selecting Drools Project Elements</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>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 <emphasis> + <property>Configure Workspace Settings</property> + </emphasis> link.</para> + + <figure> + <title>Configuring Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project3.png"/> + </imageobject> + </mediaobject> + </figure> + + <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 + name for a new runtime and a path to the Drools runtime on your file system.</para> + + <note> + <title>Note:</title> + <para>A Drools runtime is a collection of jars on your file system that represent one + specific release of the Drools project jars. While creating a new runtime, you must + either point to the release of your choice, or you can simply create a new runtime + on your file system from the jars included in the Drools Eclipse plugin.</para> + </note> + + <figure> + <title>Adding a New Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Let&apos;s simply create a new Drools 5 runtime from the jars embedded in the + Drools Eclipse plugin. Thus, you should press <emphasis> + <property>Create a new Drools 5 runtime</property> + </emphasis> button and select the folder where you want this runtime to be created and + hit <emphasis> + <property>OK</property>.</emphasis></para> + + <para>You will see the newly created runtime show up in your list of Drools runtimes. Check + it and press <emphasis> + <property>OK</property>.</emphasis></para> + + <figure> + <title>Selecting a Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now press <emphasis> + <property>Finish</property> + </emphasis> to complete the project creation.</para> + + <figure> + <title>Completing the Drools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>This will setup a basic structure, classpath and sample rules and test case to get you + started.</para> + </section> + + + <section id="structure_overview"> + <title>Drools Project Structure Overview</title> + + <para>Now let&apos;s look at the structure of the organized project. In the + <property>Package Explorer</property> you should see the following:</para> + + <figure> + <title>Drools Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The newly created project contains an example rule file <emphasis> + <property>Sample.drl</property> + </emphasis> in the <emphasis> + <property>src/main/rules</property> + </emphasis> directory and an example java file <emphasis> + <property>DroolsTest.java</property> + </emphasis> that can be used to execute the rules in a Drools engine in the folder <emphasis> + <property>src/main/java</property> + </emphasis>, in the <emphasis> + <property>com.sample</property> + </emphasis> package. All the others jar&apos;s that are necessary during execution + are also added to the classpath in a custom classpath container called <property>Drools + Library</property>.</para> + + <tip> + <title>Tip:</title> + <para>Rules do not have to be kept in Java projects at all, this is just a convenience + for people who are already using eclipse as their Java IDE.</para> + </tip> + + </section> + + <section id="creating_rule"> + <title>Creating a New Rule</title> + + <para>Now we are going to add a new Rule resource to the project.</para> + + <para>You can either create an empty text <emphasis> + <property>.drl</property> + </emphasis> file or make use of the special <property>New Rule Resource + wizard</property> to do it.</para> + + <para>To open the wizard follow to <emphasis> + <property>File > New > Rule Resource</property> + </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> + + <figure> + <title>Opening the New Rule Resource Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the wizard page first select <emphasis> + <property>/rules</property> + </emphasis> as a top level directory to store your rules and type the rule name. Next + it&apos;s mandatory to specify the rule package name. It defines a namespace that + groups rules together.</para> + + <figure> + <title>New Rule Resource Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As a result the wizard generates a rule skeleton to get you started.</para> + + <figure> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project10.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + +</chapter> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/debugging_rules.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/debugging_rules.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/debugging_rules.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="debugging_rules" xreflabel="debugging_rules"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Debugging rules</title> + + <para>This chapter describes how to debug rules during the execution of your Drools application.</para> + + <section id="creating_breakpoints"> + <title>Creating Breakpoints</title> + + <para>At first, we&apos;ll focus on how to add + breakpoints in the consequences of your rules.</para> + + <para>Whenever such a breakpoint is uncounted + during the execution of the rules, the execution is halted. It&apos;s possible then inspect the + variables known at that point and use any of the default debugging actions 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 used.</para> + + <para>You can add/remove rule breakpoints in <emphasis> + <property>.drl</property> + </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> + + <itemizedlist> + <listitem> + <para>Double-click the ruler in the <property>Rule editor</property> at the line + where you want to add a breakpoint.</para> + <tip> + <title>Tip:</title> + <para>Note that rule breakpoints can only be created in the consequence of a + rule. Double-clicking on a line where no breakpoint is allowed will do + nothing.</para> + </tip> + <para>A breakpoint can be removed by double-clicking the ruler once more. </para> + </listitem> + + <listitem> + <para>Right-click the ruler. Select <emphasis> + <property>Toggle Breakpoint</property> + </emphasis> action in the appeared popup menu. Clicking the action will add a + breakpoint at the selected line or remove it if there is one already.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Adding Breakpoints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Debug perspective</property> contains a <property>Breakpoints + view</property> 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 <emphasis> + <property>Window > Perspective > Others > Debug</property>.</emphasis></para> + </section> + + <section id="debugging"> + <title>Debugging</title> + + <para>Drools breakpoints are only enabled if you debug your application as a Drools + Application. To do this you should perform one of the actions:</para> + + <itemizedlist> + <listitem> + <para>Select the main class of your application. Right click it and select <emphasis> + <property>Debug As > Drools Application</property>.</emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Debugging Drools Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules2.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Alternatively, you can also go to <emphasis> + <property>Debug As > Debug Configuration</property> + </emphasis> to open a new dialog for creating, managing and running debug + configurations.</para> + + <para>Select the <emphasis> + <property>Drools Application</property> + </emphasis> item in the left tree and click the <emphasis> + <property>New launch configuration</property> + </emphasis> button (leftmost icon in the toolbar above the tree). This 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 beginning. All + properties shown here are the same as any standard Java program.</para> + </listitem> + </itemizedlist> + + <figure> + <title>New Debug Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules3.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Remember to change the name of your debug configuration to something meaningful.</para> + </tip> + + <para>Next + click the <emphasis> + <property>Debug</property> + </emphasis> button on the bottom to start debugging your application. </para> + + <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 encountered, the + corresponding <emphasis> + <property>.drl</property></emphasis> 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 current executing + working memory is automatically shown).</para> + + + </section> +</chapter> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/editors.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/editors.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/editors.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,537 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="editors" xreflabel="editors"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Editors</title> + <section id="dsl_editor"> + <title>DSL Editor</title> + <para>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. + </para> + <para>In Drools this configuration is presented by <property>.dsl</property> + files that can be created by <emphasis>right click on the project->New->Other->Drools->Domain Specific Language</emphasis>.</para> + <para>DSL Editor is a default editor for <property>.dsl</property> files:</para> + <figure> + <title>DSL Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the table below all the components of the DSL Editor page are described:</para> + <table> + <title>DSL Editor Components.</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Components</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Description</entry> + <entry>User's comments on a certain language message mapping</entry> + </row> + <row> + <entry>Table of language message mappings</entry> + <entry>The table is divided into 4 rows: + <itemizedlist id="rows"> + <listitem><para><emphasis>Language Expression</emphasis> :expression you want to use as a rule</para></listitem> + <listitem><para><emphasis>Rule Language Mapping</emphasis> :the implementation of the rules.This means that to this language expression the rule will be compiled + by the rule engine compiler.</para></listitem> + <listitem><para><emphasis>Object</emphasis> :name of the object</para></listitem> + <listitem><para><emphasis>Scope</emphasis> :indicates where the expression is + targeted: is it for the "condition" part of the rule ,"consequence" part, etc.</para></listitem> + </itemizedlist> + 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 <link linkend="edit_wizard">Edit language mapping Wizard</link> will be open. + </entry> + </row> + <row> + <entry>Expression</entry> + <entry>Shows the language expression of the selected table line(language message mapping).</entry> + </row> + + <row> + <entry>Mapping</entry> + <entry>Shows the rule of language mapping for the selected table line(language message mapping).</entry> + </row> + <row> + <entry>Object</entry> + <entry>Shows the object for the selected table line(language message mapping)</entry> + </row> + + <row> + <entry id="sort">Sort By</entry> + <entry>Using this option you can change the type of lines sorting + in the table of language message mappings.To do this select from the drop down lins the method + of sorting you want and click <emphasis>Sort</emphasis> button.</entry> + </row> + <row> + <entry>Buttons</entry> + <entry><itemizedlist> + <listitem><para><emphasis>Edit</emphasis> :by clicking the button users can edit + selected in the table of language message mappings lines.For more information look + <link linkend="edit_wizard">Edit language mapping Wizard</link>section.</para></listitem> + <listitem><para><emphasis>Remove</emphasis> :if you click the button the selected mapping line will be deleted. </para></listitem> + <listitem><para><emphasis>Add</emphasis> :with this button you can add new mapping lines to the table.For more information look + <link linkend="add_wizard">Add language mapping Wizard</link>section. </para></listitem> + <listitem><para><emphasis>Sort</emphasis> : please, for more information go <link linkend="sort">here</link></para></listitem> + <listitem><para><emphasis>Copy</emphasis> :with this button you can add new mapping lines to the table + in which all the information will be copied from the selected mapping line.</para></listitem> + </itemizedlist> + </entry> + </row> + </tbody> + </tgroup> + </table> + <section id="edit_wizard"> + <title>Edit language mapping Wizard</title> + <para>This wizard can be opened by double clicking some line + in the table of language message mappings or by clicking the <emphasis>Edit</emphasis>button.</para> + <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> + <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> + <figure> + <title>Edit language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1c.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To change the mapping a user should edit the otions he want and finally click <emphasis>Ok</emphasis>.</para> + </section> + <section id="add_wizard"> + <title>Add language mapping Wizard</title> + <para>This wizard is equal to <link linkend="edit_wizard">Edit language mapping Wizard</link>. + It can be opened by clicking the <emphasis>Add</emphasis> button. + </para> + <para>The only difference is that instead of editing the information you should enter new one.</para> + <figure> + <title>Add language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="ruleflow_editor"> + <title>Flow Editor</title> + <para>Drools tools also provide some functionality to define the order in + which rules should be executed.Ruleflow file allows you to specify + the order in which rule sets should be evaluated using a flow chart. + So you can define which rule sets should be evaluated in sequence or in parallel as well as + specify conditions under which rule sets should be evaluated.</para> + <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 ruleflows. + Add a ruleflow file(.rf) by clicking on the project and selecting "<emphasis>New -> Other...->Flow File</emphasis>":</para> + <figure> + <title>RuleFlow file creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1f.png"/> + </imageobject> + </mediaobject> + </figure> + <para>By default these ruleflow files (.rf) are opened in the graphical Flow editor. + You can see it on the picture below.</para> + <figure> + <title>Flow Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1g.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The Flow editor consists of a <emphasis>palette</emphasis>, a <emphasis>canvas</emphasis> + and an <emphasis>outline</emphasis> view. To add new elements to the canvas, select the + element you would like to create in the palette and then add it to the canvas by clicking on the preferred location. + </para> + <figure> + <title>Adding an element to the canvas</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1e.png"/> + </imageobject> + </mediaobject> + </figure> + <para>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 view.</para> + <figure> + <title>Properties view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1d.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. + So using your Outline view you can easly navigate between parts of a schema. </para> + <figure> + <title>Outline view usage</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors9.png"/> + </imageobject> + </mediaobject> + </figure> + <section> + <title>Different types of control elements in Flow Palette</title> + <para>Flow editor supports three types of control elements. + They are:</para> + <table> <title>Flow Palette Components.Part 1</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon7.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Select</entry> + <entry>Select a node on the canvas</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon8.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Marquee</entry> + <entry>Is used for selecting a group of elements</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon9.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Sequence Flow</entry> + <entry>Use this element to join two elements on the canvas</entry> + </row> + </tbody> + + </tgroup> + </table> + </section> + + <section> + <title>Different types of nodes in Flow Palette</title> + + <para>Currently, ruleflow supports seven types of nodes. + In the table below you can find information about them:</para> + <table> <title>Flow Palette Components.Part 2.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon1.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Start Event</entry> + <entry>The start of the ruleflow. A ruleflow should have exactly + one start node. The <property>Start Event</property> can not have incoming + connections and should have one outgoing connection. Whenever the ruleflow process is started, + the executing is started here and is automatically proceeded to the first node + linked to this <property>Start Event</property></entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon2.png"/> + </imageobject></inlinemediaobject></entry> + <entry>End Event</entry> + <entry>A ruleflow file can have one or more <property>End Events</property>. + The <property>End Event</property> node should have one incoming connection + and can not have outgoing connections. When an end node is reached in the ruleflow, + the ruleflow is terminated (including other remaining active nodes when parallelism + is used).</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon3.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Rule Task</entry> + <entry>represents a set of rules. A <emphasis>Rule Task</emphasis> node should have one + incoming connection and one outgoing connection. + The <property>RuleFlowGroup</property> property which is used to specify the name of the + ruleflow-group that represents the set of rules of this <emphasis>Rule Task</emphasis> node. + When a <emphasis>Rule Task</emphasis> node is reached in the ruleflow, the engine will start + executing rules that are a part of the corresponding ruleflow-group. + Execution automatically continues to the next node when there are no + more active rules in this ruleflow-group. + </entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[diverge]</entry> + <entry>allows you to create branches in your ruleflow. + A <property>Gateway[diverge]</property> node should have one incoming connection and two or more + outgoing connections.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[converge]</entry> + <entry>allows you to synchronize multiple branches. + A <property>Gateway[diverge]</property>node should have two or more incoming connections and one + outgoing connection.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon5.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Reusable Sup-Process</entry> + <entry>represents the invocation of another ruleflow from this ruleflow. + A subflow node should have one incoming connection and one outgoing connection. + It contains the property "processId" which specifies the id of the process that should be executed. + When a <property>Reusable Sup-Process</property> node is reached in the ruleflow, the engine will start the process with the given id. + The subflow node will only continue if that subflow process has terminated its execution. + Note that the subflow process is started as an independent process, + which means that the subflow process will not be terminated if this process reaches an end node.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon6.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Script Task</entry> + <entry>represents an action that should be executed in this ruleflow. + An <property>Script Task</property> node should have one incoming connection and one outgoing + connection. It contains the property "action" which specifies the action that should be executed. + When a <property>Script Task</property> node is reached in the ruleflow, it will execute the action and + continue with the next node. An action should be specified as a piece of (valid) + MVEL code. </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + </section> + + <section id="textual_rule_editor"> + <title>The Rule Editor</title> + + <para>The <property>Rule editor</property> works on files that have a <emphasis> + <property>.drl</property> + </emphasis> (or <emphasis> + <property>.rule</property> + </emphasis> in the case of spreading rules across multiple rule files) extension.</para> + + <figure> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The editor follows the pattern of a normal text editor in eclipse, with all the normal + features of a text editor:</para> + + <itemizedlist> + <listitem> + <para> + <link linkend="rules_editor_content_assist">Content Assist</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="rules_editor_code_folding">Code Folding</link> + </para> + </listitem> + + <!-- <listitem> + <para> + <link linkend="rules_editor_error_reporting">Error Reporting</link> + </para> + </listitem>--> + + <listitem> + <para> + <link linkend="rules_editor_sync_with_outline">Synchronization with Outline + View</link> + </para> + </listitem> + </itemizedlist> + + <section id="rules_editor_content_assist"> + <title>Content Assist</title> + + <para>While working in the <property>Rule editor</property> you can get a content + assistance the usual way by pressing <emphasis> + <property>Ctrl + Space</property>.</emphasis></para> + + <para>Content Assist shows all possible keywords for the current cursor position.</para> + + <figure> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist inside of the <emphasis> + <property>Message</property> + </emphasis> suggests all available fields.</para> + + <figure> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors3.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="rules_editor_code_folding"> + <title>Code Folding</title> + + <para>Code folding is also available in the <property>Rule editor</property>. To + hide/show sections of the file use the icons with minus/plus on the left vertical + line of the editor.</para> + + <figure> + <title>Code Folding</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors4.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <!--section id="rules_editor_error_reporting"> + <title>Error Reporting</title> + + </section--> + + <section id="rules_editor_sync_with_outline"> + <title>Synchronization with Outline View</title> + + <para>The <property>Rule editor</property> works in synchronization with the + <property>Outline view</property> which shows the structure of the rules, + imports in the file and also globals and functions if the file has them.</para> + + <figure> + <title>Synchronization with Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>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 items are sorted + alphabetically by default.</para> + </section> + + <section id="rete_view"> + <title>The Rete Tree View</title> + + <para>The <property>Rete Tree view</property> shows you the current Rete Network for + your <emphasis> + <property>.drl</property> + </emphasis> file. Just click on the <emphasis> + <property>Rete Tree tab</property> + </emphasis> at the bottom of the <property>Rule editor</property>.</para> + + <figure> + <title>Rete Tree</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Afterwards you can generate the current Rete Network visualization. You can push + and pull the nodes to arrange your optimal network overview.</para> + <para>If you got hundreds of nodes, select some of them with a frame. Then you can pull + groups of them.</para> + + <figure> + <title>Selecting the nodes in the Rete Tree with Frame</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can zoom in and out the Rete tree in case not all nodes are shown in the + current view. For this use the combo box or "+" and "-" icons on the toolbar.</para> + + <figure> + <title>Rete Tree Zooming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors8.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <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&amp;op=viewforum&... forum</ulink>.</para> + </section> + + </section> + +</chapter> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project10.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1c.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1d.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1d.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1e.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1e.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1f.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1f.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1g.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1g.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/views/views1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/views/views1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/introduction.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/introduction.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/introduction.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,171 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction" xreflabel="introduction"> + <title>Introduction</title> + + <section id="whatisDrools"> + <title>What is Drools?</title> + + <para><property>Drools</property> 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.</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> + <para>It is assumed that you has some familiarity with rule engines and Drools in + particular. If no, we suggest that you look carefully through the <ulink + url="http://downloads.jboss.com/drools/docs/4.0.7.19894.GA/html_sing... + >Drools Documentation</ulink>.</para> + </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 Getting Started Guide.</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> + <table> + <title>Key Functionality of Drools Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="5*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Wizard for creating a new Drools Project</para> + </entry> + <entry> + <para>The wizard allows to create a sample project to easy get started + with Drools</para> + </entry> + <entry> + <link linkend="sample_drools_project">Creating a Sample Drools + Project</link> + </entry> + </row> + + <row> + <entry> + <para>Wizards for creation new Drools resources</para> + </entry> + <entry> + <para>A set of wizards are provided with the Drools Eclipse tools to + quickly create a new Rule resource, a new Domain Specific language, + Decision Table and Business rule</para> + </entry> + <entry> + <link linkend="creating_rule">Creating a New Rule</link> + <!--link linkend="creating_dsl">Creating a New DSL</link> + <link linkend="creating_decision_table">Creating a New Decision + Table</link> + <link linkend="creating_business_rule">Creating a New Business + Rule</link--> + </entry> + </row> + + <row> + <entry> + <para>The Rule editor</para> + </entry> + <entry> + <para>An editor that is aware of DRL syntax and provides content + assistance and synchronizing with the Outline view</para> + </entry> + <entry> + <link linkend="textual_rule_editor">The Rule Editor</link> + </entry> + </row> + + <row> + <entry> + <para>The Domain Specific Language editor</para> + </entry> + <entry> + <para>The editor allows to create and manage mappings from users + language to the rule language</para> + </entry> + <entry> + <link linkend="dsl_editor">The Domain Specific Language Editor</link> + </entry> + </row> + + <row> + <entry> + <para>The Guided editor</para> + </entry> + <entry> + <para>This guided editor for rules allows you to build rules in a GUI + driven fashion based on your object model</para> + </entry> + <entry> + <!--link linkend="guided_editor">The Guided Editor</link--> + </entry> + </row> + + <row> + <entry> + <para>The Rule Flow graphical editor</para> + </entry> + <entry> + <para>The editor is meant for editing visual graphs which represent a + process (a rule flow)</para> + </entry> + <entry> + <link linkend="ruleflow_editor">The Rule Flow Graphical Editor</link> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <itemizedlist> + <listitem> + <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink>&l... + </listitem> + + <listitem> + <para> + <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest + JBossTools/JBDS documentation builds</ulink> + </para> + </listitem> + + <listitem> + <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> + + </section> +</chapter> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/master.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,69 @@ +<?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 "introduction.xml"> +<!ENTITY create_new_project SYSTEM "create_new_project.xml"> +<!ENTITY create_new SYSTEM "create_new.xml"> +<!ENTITY debugging_rules SYSTEM "debugging_rules.xml"> +<!ENTITY views SYSTEM "views.xml"> +<!ENTITY editors SYSTEM "editors.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> + + <bookinfo> + <title>Drools Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 5.1.0.trunk + </releaseinfo> +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_... version</ulink> + </para> +</abstract> + + </bookinfo> + + + <toc/> + &introduction; + &create_new_project; + &debugging_rules; + &editors; + + +</book> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/master_output.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,1127 @@ +<?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 create_new_project SYSTEM "modules/create_new_project.xml"> +<!ENTITY create_new SYSTEM "modules/create_new.xml"> +<!ENTITY debugging_rules SYSTEM "modules/debugging_rules.xml"> +<!ENTITY views SYSTEM "modules/views.xml"> +<!ENTITY editors SYSTEM "modules/editors.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>Drools Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 5.1.0.trunk + </releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_... version</ulink> + </para> +</abstract> + + </bookinfo> + + + <toc></toc> + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/introduction.xml" xreflabel="introduction"> + <title>Introduction</title> + + <section id="whatisDrools"> + <title>What is Drools?</title> + + <para><property moreinfo="none">Drools</property> 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.</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> + <para>It is assumed that you has some familiarity with rule engines and Drools in + particular. If no, we suggest that you look carefully through the <ulink url="http://downloads.jboss.com/drools/docs/4.0.7.19894.GA/html_sing... Documentation</ulink>.</para> + </note> + + <para><property moreinfo="none">Drools Tools</property> come bundled with <property moreinfo="none">JBoss Tools</property> + set of Eclipse plugins. How to install <property moreinfo="none">JBoss Tools</property> you can find in + the <ulink url="../../GettingStartedGuide/html_single/index.html#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 moreinfo="none">Drools + Tools</property>.</para> + <table> + <title>Key Functionality of Drools Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="5*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Wizard for creating a new Drools Project</para> + </entry> + <entry> + <para>The wizard allows to create a sample project to easy get started + with Drools</para> + </entry> + <entry> + <link linkend="sample_drools_project">Creating a Sample Drools + Project</link> + </entry> + </row> + + <row> + <entry> + <para>Wizards for creation new Drools resources</para> + </entry> + <entry> + <para>A set of wizards are provided with the Drools Eclipse tools to + quickly create a new Rule resource, a new Domain Specific language, + Decision Table and Business rule</para> + </entry> + <entry> + <link linkend="creating_rule">Creating a New Rule</link> + <!--link linkend="creating_dsl">Creating a New DSL</link> + <link linkend="creating_decision_table">Creating a New Decision + Table</link> + <link linkend="creating_business_rule">Creating a New Business + Rule</link--> + </entry> + </row> + + <row> + <entry> + <para>The Rule editor</para> + </entry> + <entry> + <para>An editor that is aware of DRL syntax and provides content + assistance and synchronizing with the Outline view</para> + </entry> + <entry> + <link linkend="textual_rule_editor">The Rule Editor</link> + </entry> + </row> + + <row> + <entry> + <para>The Domain Specific Language editor</para> + </entry> + <entry> + <para>The editor allows to create and manage mappings from users + language to the rule language</para> + </entry> + <entry> + <link linkend="dsl_editor">The Domain Specific Language Editor</link> + </entry> + </row> + + <row> + <entry> + <para>The Guided editor</para> + </entry> + <entry> + <para>This guided editor for rules allows you to build rules in a GUI + driven fashion based on your object model</para> + </entry> + <entry> + <!--link linkend="guided_editor">The Guided Editor</link--> + </entry> + </row> + + <row> + <entry> + <para>The Rule Flow graphical editor</para> + </entry> + <entry> + <para>The editor is meant for editing visual graphs which represent a + process (a rule flow)</para> + </entry> + <entry> + <link linkend="ruleflow_editor">The Rule Flow Graphical Editor</link> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <itemizedlist> + <listitem> + <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink>&l... + </listitem> + + <listitem> + <para> + <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest + JBossTools/JBDS documentation builds</ulink> + </para> + </listitem> + + <listitem> + <para>All <property moreinfo="none">JBoss Tools/JBDS</property> documentation you can find on the + <ulink url="http://docs.jboss.org/tools/">documentation release + page</ulink>.</para> + </listitem> + </itemizedlist> + + </section> +</chapter> + + +<chapter id="create_new_project" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/create_new_project.xml" xreflabel="create_new_project"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a New Drools Project</title> + + <para>In this chapter we are going to show you how to setup an executable sample Drools project + to start using rules immediately.</para> + + + + <section id="sample_drools_project"> + <title>Creating a Sample Drools Project</title> + + <para>First, we suggest that you use <property moreinfo="none">Drools perspective</property> which is aimed + at work with Drools specific resources.</para> + + <para>To create a new Drools project follow to <emphasis> + <property moreinfo="none">File &gt; New &gt; Drools Project</property>. </emphasis> This will open + <property moreinfo="none">New Drools Project wizard</property> like on the figure below.</para> + + <para>On the first page type the project name and click + <emphasis><property moreinfo="none">Next</property>.</emphasis></para> + + <figure float="0"> + <title>Creating a New Drools Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Next you have a choice to add some default artifacts to it like sample rules, decision + tables or ruleflows and Java classes for them. Let's select first two check + boxes and press <emphasis> + <property moreinfo="none">Next</property>. </emphasis></para> + + <figure float="0"> + <title>Selecting Drools Project Elements</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>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 <emphasis> + <property moreinfo="none">Configure Workspace Settings</property> + </emphasis> link.</para> + + <figure float="0"> + <title>Configuring Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You should see the <property moreinfo="none">Preferences window</property> where you can configure the + workspace settings for Drools runtimes. To create a new runtime, press the <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button. The appeared dialog prompts you to enter a + name for a new runtime and a path to the Drools runtime on your file system.</para> + + <note> + <title>Note:</title> + <para>A Drools runtime is a collection of jars on your file system that represent one + specific release of the Drools project jars. While creating a new runtime, you must + either point to the release of your choice, or you can simply create a new runtime + on your file system from the jars included in the Drools Eclipse plugin.</para> + </note> + + <figure float="0"> + <title>Adding a New Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Let's simply create a new Drools 5 runtime from the jars embedded in the + Drools Eclipse plugin. Thus, you should press <emphasis> + <property moreinfo="none">Create a new Drools 5 runtime</property> + </emphasis> button and select the folder where you want this runtime to be created and + hit <emphasis> + <property moreinfo="none">OK</property>.</emphasis></para> + + <para>You will see the newly created runtime show up in your list of Drools runtimes. Check + it and press <emphasis> + <property moreinfo="none">OK</property>.</emphasis></para> + + <figure float="0"> + <title>Selecting a Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to complete the project creation.</para> + + <figure float="0"> + <title>Completing the Drools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>This will setup a basic structure, classpath and sample rules and test case to get you + started.</para> + </section> + + + <section id="structure_overview"> + <title>Drools Project Structure Overview</title> + + <para>Now let's look at the structure of the organized project. In the + <property moreinfo="none">Package Explorer</property> you should see the following:</para> + + <figure float="0"> + <title>Drools Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The newly created project contains an example rule file <emphasis> + <property moreinfo="none">Sample.drl</property> + </emphasis> in the <emphasis> + <property moreinfo="none">src/main/rules</property> + </emphasis> directory and an example java file <emphasis> + <property moreinfo="none">DroolsTest.java</property> + </emphasis> that can be used to execute the rules in a Drools engine in the folder <emphasis> + <property moreinfo="none">src/main/java</property> + </emphasis>, in the <emphasis> + <property moreinfo="none">com.sample</property> + </emphasis> package. All the others jar's that are necessary during execution + are also added to the classpath in a custom classpath container called <property moreinfo="none">Drools + Library</property>.</para> + + <tip> + <title>Tip:</title> + <para>Rules do not have to be kept in Java projects at all, this is just a convenience + for people who are already using eclipse as their Java IDE.</para> + </tip> + + </section> + + <section id="creating_rule"> + <title>Creating a New Rule</title> + + <para>Now we are going to add a new Rule resource to the project.</para> + + <para>You can either create an empty text <emphasis> + <property moreinfo="none">.drl</property> + </emphasis> file or make use of the special <property moreinfo="none">New Rule Resource + wizard</property> to do it.</para> + + <para>To open the wizard follow to <emphasis> + <property moreinfo="none">File &gt; New &gt; Rule Resource</property> + </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> + + <figure float="0"> + <title>Opening the New Rule Resource Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the wizard page first select <emphasis> + <property moreinfo="none">/rules</property> + </emphasis> as a top level directory to store your rules and type the rule name. Next + it's mandatory to specify the rule package name. It defines a namespace that + groups rules together.</para> + + <figure float="0"> + <title>New Rule Resource Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As a result the wizard generates a rule skeleton to get you started.</para> + + <figure float="0"> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + +</chapter> + + +<chapter id="debugging_rules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/debugging_rules.xml" xreflabel="debugging_rules"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Debugging rules</title> + + <para>This chapter describes how to debug rules during the execution of your Drools application.</para> + + <section id="creating_breakpoints"> + <title>Creating Breakpoints</title> + + <para>At first, we'll focus on how to add + breakpoints in the consequences of your rules.</para> + + <para>Whenever such a breakpoint is uncounted + during the execution of the rules, the execution is halted. It's possible then inspect the + variables known at that point and use any of the default debugging actions 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 used.</para> + + <para>You can add/remove rule breakpoints in <emphasis> + <property moreinfo="none">.drl</property> + </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> + + <itemizedlist> + <listitem> + <para>Double-click the ruler in the <property moreinfo="none">Rule editor</property> at the line + where you want to add a breakpoint.</para> + <tip> + <title>Tip:</title> + <para>Note that rule breakpoints can only be created in the consequence of a + rule. Double-clicking on a line where no breakpoint is allowed will do + nothing.</para> + </tip> + <para>A breakpoint can be removed by double-clicking the ruler once more. </para> + </listitem> + + <listitem> + <para>Right-click the ruler. Select <emphasis> + <property moreinfo="none">Toggle Breakpoint</property> + </emphasis> action in the appeared popup menu. Clicking the action will add a + breakpoint at the selected line or remove it if there is one already.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Adding Breakpoints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">Debug perspective</property> contains a <property moreinfo="none">Breakpoints + view</property> 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 <emphasis> + <property moreinfo="none">Window &gt; Perspective &gt; Others &gt; Debug</property>.</emphasis></para> + </section> + + <section id="debugging"> + <title>Debugging</title> + + <para>Drools breakpoints are only enabled if you debug your application as a Drools + Application. To do this you should perform one of the actions:</para> + + <itemizedlist> + <listitem> + <para>Select the main class of your application. Right click it and select <emphasis> + <property moreinfo="none">Debug As &gt; Drools Application</property>.</emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Debugging Drools Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Alternatively, you can also go to <emphasis> + <property moreinfo="none">Debug As &gt; Debug Configuration</property> + </emphasis> to open a new dialog for creating, managing and running debug + configurations.</para> + + <para>Select the <emphasis> + <property moreinfo="none">Drools Application</property> + </emphasis> item in the left tree and click the <emphasis> + <property moreinfo="none">New launch configuration</property> + </emphasis> button (leftmost icon in the toolbar above the tree). This 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 beginning. All + properties shown here are the same as any standard Java program.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>New Debug Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Remember to change the name of your debug configuration to something meaningful.</para> + </tip> + + <para>Next + click the <emphasis> + <property moreinfo="none">Debug</property> + </emphasis> button on the bottom to start debugging your application. </para> + + <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 encountered, the + corresponding <emphasis> + <property moreinfo="none">.drl</property></emphasis> 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 current executing + working memory is automatically shown).</para> + + + </section> +</chapter> + + +<chapter id="editors" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/editors.xml" xreflabel="editors"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Editors</title> + <section id="dsl_editor"> + <title>DSL Editor</title> + <para>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. + </para> + <para>In Drools this configuration is presented by <property moreinfo="none">.dsl</property> + files that can be created by <emphasis>right click on the project-&gt;New-&gt;Other-&gt;Drools-&gt;Domain Specific Language</emphasis>.</para> + <para>DSL Editor is a default editor for <property moreinfo="none">.dsl</property> files:</para> + <figure float="0"> + <title>DSL Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>In the table below all the components of the DSL Editor page are described:</para> + <table> + <title>DSL Editor Components.</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry>Components</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Description</entry> + <entry>User's comments on a certain language message mapping</entry> + </row> + <row> + <entry>Table of language message mappings</entry> + <entry>The table is divided into 4 rows: + <itemizedlist id="rows"> + <listitem><para><emphasis>Language Expression</emphasis> :expression you want to use as a rule</para></listitem> + <listitem><para><emphasis>Rule Language Mapping</emphasis> :the implementation of the rules.This means that to this language expression the rule will be compiled + by the rule engine compiler.</para></listitem> + <listitem><para><emphasis>Object</emphasis> :name of the object</para></listitem> + <listitem><para><emphasis>Scope</emphasis> :indicates where the expression is + targeted: is it for the "condition" part of the rule ,"consequence" part, etc.</para></listitem> + </itemizedlist> + 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 <link linkend="edit_wizard">Edit language mapping Wizard</link> will be open. + </entry> + </row> + <row> + <entry>Expression</entry> + <entry>Shows the language expression of the selected table line(language message mapping).</entry> + </row> + + <row> + <entry>Mapping</entry> + <entry>Shows the rule of language mapping for the selected table line(language message mapping).</entry> + </row> + <row> + <entry>Object</entry> + <entry>Shows the object for the selected table line(language message mapping)</entry> + </row> + + <row> + <entry id="sort">Sort By</entry> + <entry>Using this option you can change the type of lines sorting + in the table of language message mappings.To do this select from the drop down lins the method + of sorting you want and click <emphasis>Sort</emphasis> button.</entry> + </row> + <row> + <entry>Buttons</entry> + <entry><itemizedlist> + <listitem><para><emphasis>Edit</emphasis> :by clicking the button users can edit + selected in the table of language message mappings lines.For more information look + <link linkend="edit_wizard">Edit language mapping Wizard</link>section.</para></listitem> + <listitem><para><emphasis>Remove</emphasis> :if you click the button the selected mapping line will be deleted. </para></listitem> + <listitem><para><emphasis>Add</emphasis> :with this button you can add new mapping lines to the table.For more information look + <link linkend="add_wizard">Add language mapping Wizard</link>section. </para></listitem> + <listitem><para><emphasis>Sort</emphasis> : please, for more information go <link linkend="sort">here</link></para></listitem> + <listitem><para><emphasis>Copy</emphasis> :with this button you can add new mapping lines to the table + in which all the information will be copied from the selected mapping line.</para></listitem> + </itemizedlist> + </entry> + </row> + </tbody> + </tgroup> + </table> + <section id="edit_wizard"> + <title>Edit language mapping Wizard</title> + <para>This wizard can be opened by double clicking some line + in the table of language message mappings or by clicking the <emphasis>Edit</emphasis>button.</para> + <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> + <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> + <figure float="0"> + <title>Edit language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>To change the mapping a user should edit the otions he want and finally click <emphasis>Ok</emphasis>.</para> + </section> + <section id="add_wizard"> + <title>Add language mapping Wizard</title> + <para>This wizard is equal to <link linkend="edit_wizard">Edit language mapping Wizard</link>. + It can be opened by clicking the <emphasis>Add</emphasis> button. + </para> + <para>The only difference is that instead of editing the information you should enter new one.</para> + <figure float="0"> + <title>Add language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="ruleflow_editor"> + <title>Flow Editor</title> + <para>Drools tools also provide some functionality to define the order in + which rules should be executed.Ruleflow file allows you to specify + the order in which rule sets should be evaluated using a flow chart. + So you can define which rule sets should be evaluated in sequence or in parallel as well as + specify conditions under which rule sets should be evaluated.</para> + <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 ruleflows. + Add a ruleflow file(.rf) by clicking on the project and selecting "<emphasis>New -&gt; Other...-&gt;Flow File</emphasis>":</para> + <figure float="0"> + <title>RuleFlow file creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1f.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>By default these ruleflow files (.rf) are opened in the graphical Flow editor. + You can see it on the picture below.</para> + <figure float="0"> + <title>Flow Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1g.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The Flow editor consists of a <emphasis>palette</emphasis>, a <emphasis>canvas</emphasis> + and an <emphasis>outline</emphasis> view. To add new elements to the canvas, select the + element you would like to create in the palette and then add it to the canvas by clicking on the preferred location. + </para> + <figure float="0"> + <title>Adding an element to the canvas</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1e.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>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 view.</para> + <figure float="0"> + <title>Properties view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1d.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. + So using your Outline view you can easly navigate between parts of a schema. </para> + <figure float="0"> + <title>Outline view usage</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <section> + <title>Different types of control elements in Flow Palette</title> + <para>Flow editor supports three types of control elements. + They are:</para> + <table> <title>Flow Palette Components.Part 1</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="1*"></colspec> + <colspec align="left" colnum="3" colwidth="3*"></colspec> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon7.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Select</entry> + <entry>Select a node on the canvas</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon8.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Marquee</entry> + <entry>Is used for selecting a group of elements</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon9.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Sequence Flow</entry> + <entry>Use this element to join two elements on the canvas</entry> + </row> + </tbody> + + </tgroup> + </table> + </section> + + <section> + <title>Different types of nodes in Flow Palette</title> + + <para>Currently, ruleflow supports seven types of nodes. + In the table below you can find information about them:</para> + <table> <title>Flow Palette Components.Part 2.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="1*"></colspec> + <colspec align="left" colnum="3" colwidth="3*"></colspec> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon1.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Start Event</entry> + <entry>The start of the ruleflow. A ruleflow should have exactly + one start node. The <property moreinfo="none">Start Event</property> can not have incoming + connections and should have one outgoing connection. Whenever the ruleflow process is started, + the executing is started here and is automatically proceeded to the first node + linked to this <property moreinfo="none">Start Event</property></entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon2.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>End Event</entry> + <entry>A ruleflow file can have one or more <property moreinfo="none">End Events</property>. + The <property moreinfo="none">End Event</property> node should have one incoming connection + and can not have outgoing connections. When an end node is reached in the ruleflow, + the ruleflow is terminated (including other remaining active nodes when parallelism + is used).</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon3.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Rule Task</entry> + <entry>represents a set of rules. A <emphasis>Rule Task</emphasis> node should have one + incoming connection and one outgoing connection. + The <property moreinfo="none">RuleFlowGroup</property> property which is used to specify the name of the + ruleflow-group that represents the set of rules of this <emphasis>Rule Task</emphasis> node. + When a <emphasis>Rule Task</emphasis> node is reached in the ruleflow, the engine will start + executing rules that are a part of the corresponding ruleflow-group. + Execution automatically continues to the next node when there are no + more active rules in this ruleflow-group. + </entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[diverge]</entry> + <entry>allows you to create branches in your ruleflow. + A <property moreinfo="none">Gateway[diverge]</property> node should have one incoming connection and two or more + outgoing connections.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[converge]</entry> + <entry>allows you to synchronize multiple branches. + A <property moreinfo="none">Gateway[diverge]</property>node should have two or more incoming connections and one + outgoing connection.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon5.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Reusable Sup-Process</entry> + <entry>represents the invocation of another ruleflow from this ruleflow. + A subflow node should have one incoming connection and one outgoing connection. + It contains the property "processId" which specifies the id of the process that should be executed. + When a <property moreinfo="none">Reusable Sup-Process</property> node is reached in the ruleflow, the engine will start the process with the given id. + The subflow node will only continue if that subflow process has terminated its execution. + Note that the subflow process is started as an independent process, + which means that the subflow process will not be terminated if this process reaches an end node.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon6.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Script Task</entry> + <entry>represents an action that should be executed in this ruleflow. + An <property moreinfo="none">Script Task</property> node should have one incoming connection and one outgoing + connection. It contains the property "action" which specifies the action that should be executed. + When a <property moreinfo="none">Script Task</property> node is reached in the ruleflow, it will execute the action and + continue with the next node. An action should be specified as a piece of (valid) + MVEL code. </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + </section> + + <section id="textual_rule_editor"> + <title>The Rule Editor</title> + + <para>The <property moreinfo="none">Rule editor</property> works on files that have a <emphasis> + <property moreinfo="none">.drl</property> + </emphasis> (or <emphasis> + <property moreinfo="none">.rule</property> + </emphasis> in the case of spreading rules across multiple rule files) extension.</para> + + <figure float="0"> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The editor follows the pattern of a normal text editor in eclipse, with all the normal + features of a text editor:</para> + + <itemizedlist> + <listitem> + <para> + <link linkend="rules_editor_content_assist">Content Assist</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="rules_editor_code_folding">Code Folding</link> + </para> + </listitem> + + <!-- <listitem> + <para> + <link linkend="rules_editor_error_reporting">Error Reporting</link> + </para> + </listitem>--> + + <listitem> + <para> + <link linkend="rules_editor_sync_with_outline">Synchronization with Outline + View</link> + </para> + </listitem> + </itemizedlist> + + <section id="rules_editor_content_assist"> + <title>Content Assist</title> + + <para>While working in the <property moreinfo="none">Rule editor</property> you can get a content + assistance the usual way by pressing <emphasis> + <property moreinfo="none">Ctrl + Space</property>.</emphasis></para> + + <para>Content Assist shows all possible keywords for the current cursor position.</para> + + <figure float="0"> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist inside of the <emphasis> + <property moreinfo="none">Message</property> + </emphasis> suggests all available fields.</para> + + <figure float="0"> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="rules_editor_code_folding"> + <title>Code Folding</title> + + <para>Code folding is also available in the <property moreinfo="none">Rule editor</property>. To + hide/show sections of the file use the icons with minus/plus on the left vertical + line of the editor.</para> + + <figure float="0"> + <title>Code Folding</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <!--section id="rules_editor_error_reporting"> + <title>Error Reporting</title> + + </section--> + + <section id="rules_editor_sync_with_outline"> + <title>Synchronization with Outline View</title> + + <para>The <property moreinfo="none">Rule editor</property> works in synchronization with the + <property moreinfo="none">Outline view</property> which shows the structure of the rules, + imports in the file and also globals and functions if the file has them.</para> + + <figure float="0"> + <title>Synchronization with Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>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 items are sorted + alphabetically by default.</para> + </section> + + <section id="rete_view"> + <title>The Rete Tree View</title> + + <para>The <property moreinfo="none">Rete Tree view</property> shows you the current Rete Network for + your <emphasis> + <property moreinfo="none">.drl</property> + </emphasis> file. Just click on the <emphasis> + <property moreinfo="none">Rete Tree tab</property> + </emphasis> at the bottom of the <property moreinfo="none">Rule editor</property>.</para> + + <figure float="0"> + <title>Rete Tree</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Afterwards you can generate the current Rete Network visualization. You can push + and pull the nodes to arrange your optimal network overview.</para> + <para>If you got hundreds of nodes, select some of them with a frame. Then you can pull + groups of them.</para> + + <figure float="0"> + <title>Selecting the nodes in the Rete Tree with Frame</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can zoom in and out the Rete tree in case not all nodes are shown in the + current view. For this use the combo box or "+" and "-" icons on the toolbar.</para> + + <figure float="0"> + <title>Rete Tree Zooming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>The <property moreinfo="none">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&amp;op=viewforum&... forum</ulink>.</para> + </section> + + </section> + +</chapter> + + + +</book> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/views.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/views.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/views.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="views" xreflabel="views"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Views</title> + + <section id="working_memory_view"> + <title>The Working Memory View</title> + </section> + + <section id="agenta_view"> + <title>The Agenda View</title> + </section> + + <section id="global_data_view"> + <title>The Global Data View</title> + </section> + + <section id="audit_view"> + <title>The Audit View</title> + </section> + + <section id="rules_view"> + <title>The Rules View</title> + </section> + + <section id="process_instance_view"> + <title>The Process Instance View</title> + </section> +</chapter> Modified: branches/jbosstools-3.1.x/drools/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/pom.xml 2010-03-12 00:02:01 UTC (rev 20774) +++ branches/jbosstools-3.1.x/drools/docs/reference/pom.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -11,35 +11,45 @@ <name>Drools_Tools_Reference_Guide</name> <profiles> - <profile> - <id>release</id> - <properties> - <master>master_output.xml</master> - <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> - <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> - <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> - </properties> - </profile> - <profile> - <id>releaseJBDS</id> - <properties> - <master>master.xml</master> - <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> - <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> - <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> - <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/com/css/</cssdir> - </properties> - </profile> - <profile> - <id>diffmk</id> - <properties> - <master>master_output.xml</master> - <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single> - <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked> - <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf> - </properties> - </profile> - </profiles> + <profile> + <id>release</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseTest</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseJBDS</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/com/css/</cssdir> + </properties> + </profile> + <profile> + <id>diffmk</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf> + </properties> + </profile> + </profiles> + <build> <plugins> <plugin> @@ -85,9 +95,9 @@ <configuration> <sourceDocumentName>master.xml</sourceDocumentName> - <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <sourceDirectory>${pom.basedir}/en-US</sourceDirectory> <imageResource> - <directory>${pom.basedir}/en</directory> + <directory>${pom.basedir}/en-US</directory> <includes> <include>images/**/*</include> </includes> Added: branches/jbosstools-3.1.x/drools/docs/reference/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/publican.cfg 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +