Author: smukhina Date: 2010-03-18 13:23:19 -0400 (Thu, 18 Mar 2010) New Revision: 20909 Modified: trunk/drools/docs/reference/en-US/editors.xml trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png Log: https://jira.jboss.org/jira/browse/JBDS-1162 Documentation issues in Drools Tools Reference Guide - fixed Modified: trunk/drools/docs/reference/en-US/editors.xml =================================================================== --- trunk/drools/docs/reference/en-US/editors.xml 2010-03-18 17:22:34 UTC (rev 20908) +++ trunk/drools/docs/reference/en-US/editors.xml 2010-03-18 17:23:19 UTC (rev 20909) @@ -1,537 +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> +<?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 list 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 easily 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> \ No newline at end of file Modified: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png =================================================================== (Binary files differ)