JBoss Tools SVN: r28423 - trunk/build.
by jbosstools-commits@lists.jboss.org
Author: nickboldt
Date: 2011-01-19 23:19:02 -0500 (Wed, 19 Jan 2011)
New Revision: 28423
Modified:
trunk/build/publish.sh
Log:
use more restrictive xpath query when selecting modules + revisions
Modified: trunk/build/publish.sh
===================================================================
--- trunk/build/publish.sh 2011-01-20 04:02:26 UTC (rev 28422)
+++ trunk/build/publish.sh 2011-01-20 04:19:02 UTC (rev 28423)
@@ -55,9 +55,8 @@
# JBDS-1361 - fetch XML and then sed it into plain text
rl=${STAGINGDIR}/logs/SVN_REVISION
rm -f ${rl}.txt ${rl}.xml
-wget -q --no-clobber -O ${rl}.xml "http://hudson.qa.jboss.com/hudson/job/${JOB_NAME}/api/xml?depth=1&xpath=/..."
-sed -e "s#<module>\(http[^<>]\+\)</module><revision>\([0-9]\+\)</revision>#\1\@\2\n#g" ${rl}.xml | \
- sed -e "s#<kind>\([^<>]\+\)</kind>#\1\n#g" | sed -e "s#<[^<>]\+>##g" > ${rl}.txt
+wget -q --no-clobber -O ${rl}.xml "http://hudson.qa.jboss.com/hudson/job/${JOB_NAME}/api/xml?wrapper=changeS..."
+sed -e "s#<module>\(http[^<>]\+\)</module><revision>\([0-9]\+\)</revision>#\1\@\2\n#g" ${rl}.xml | sed -e "s#<[^<>]\+>##g" > ${rl}.txt
METAFILE="${BUILD_ID}-H${BUILD_NUMBER}.txt"
if [[ ${SVN_REVISION} ]]; then
15 years, 2 months
JBoss Tools SVN: r28422 - trunk/drools/docs/guvnor_ref/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-19 23:02:26 -0500 (Wed, 19 Jan 2011)
New Revision: 28422
Modified:
trunk/drools/docs/guvnor_ref/en-US/introduction.xml
Log:
General Updates
Modified: trunk/drools/docs/guvnor_ref/en-US/introduction.xml
===================================================================
--- trunk/drools/docs/guvnor_ref/en-US/introduction.xml 2011-01-20 03:46:55 UTC (rev 28421)
+++ trunk/drools/docs/guvnor_ref/en-US/introduction.xml 2011-01-20 04:02:26 UTC (rev 28422)
@@ -1,167 +1,156 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="introduction">
- <title>Introduction</title>
+ <title>Introduction</title>
- <para>The purpose of this document is to describe briefly the functionality present in the
- <property>Eclipse Guvnor Tools</property> (EGT) for Drools 5. While not intended as a
- comprehensive reference, there should be enough detail included for early adopters using
- these tools.</para>
+ <para>
+ The purpose of this document is to describe briefly the functionality present in the <property>Eclipse Guvnor Tools</property> (EGT) for Drools 5. While not intended as a comprehensive reference, there should be enough detail included for early adopters using these tools.
+ </para>
- <para>First, have a look at the key features of <property>Guvnor Tools:</property></para>
+ <para>The table below lists the key features of <property>Guvnor Tools:</property>
+ </para>
- <section id="drools_key_features">
- <title>Guvnor Tools Key Features</title>
+ <section id="drools_key_features">
+ <title>Guvnor Tools Key Features</title>
- <para>The following table lists all valuable features of the <property>Guvnor
+ <para>The following table lists all valuable features of the <property>Guvnor
Tools</property>.</para>
- <table>
- <title>Key Functionality of Guvnor Tools</title>
- <tgroup cols="3">
+ <table>
+ <title>Key Functionality of Guvnor Tools</title>
+ <tgroup cols="3">
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" colwidth="5*"/>
- <colspec colnum="3" align="left" colwidth="1*"/>
+ <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>
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
- <tbody>
+ <tbody>
- <row>
- <entry>
- <para>Guvnor Repositories View</para>
- </entry>
- <entry>
- <para>The purpose of the view is to enable access to Guvnor repository
- resources in a standard tree format</para>
- </entry>
- <entry>
- <xref linkend="guvnor_repositories_view"/>
- </entry>
- </row>
+ <row>
+ <entry>
+ <para>Guvnor Repositories View</para>
+ </entry>
+ <entry>
+ <para>The purpose of the view is to enable access to Guvnor repository resources in a standard tree format</para>
+ </entry>
+ <entry>
+ <xref linkend="guvnor_repositories_view"/>
+ </entry>
+ </row>
- <row>
- <entry>
- <para>Guvnor Connection Wizard</para>
- </entry>
- <entry>
- <para>The wizard helps to create a connection to a Guvnor
- repository.</para>
- </entry>
- <entry>
- <xref linkend="connection_wizard"/>
- </entry>
- </row>
+ <row>
+ <entry>
+ <para>Guvnor Connection Wizard</para>
+ </entry>
+ <entry>
+ <para>The wizard helps to create a connection to a Guvnor repository.</para>
+ </entry>
+ <entry>
+ <xref linkend="connection_wizard"/>
+ </entry>
+ </row>
- <row>
- <entry>
- <para>Guvnor Resource History View</para>
- </entry>
- <entry>
- <para>This view shows revisions of specific resources available in the
- repository.</para>
- </entry>
- <entry>
- <xref linkend="guvnor_history_view"/>
- </entry>
- </row>
+ <row>
+ <entry>
+ <para>Guvnor Resource History View</para>
+ </entry>
+ <entry>
+ <para>This view shows revisions of specific resources available in the repository.</para>
+ </entry>
+ <entry>
+ <xref linkend="guvnor_history_view"/>
+ </entry>
+ </row>
- <row>
- <entry>
- <para>Resource from Guvnor wizard</para>
- </entry>
- <entry>
- <para>The wizard helps to get local copies of Guvnor repository
- resources.</para>
- </entry>
- <entry>
- <xref linkend="resources_from_guvnor"/>
- </entry>
- </row>
+ <row>
+ <entry>
+ <para>Resource from Guvnor wizard</para>
+ </entry>
+ <entry>
+ <para>The wizard helps to get local copies of Guvnor repository resources.</para>
+ </entry>
+ <entry>
+ <xref linkend="resources_from_guvnor"/>
+ </entry>
+ </row>
- <row>
- <entry>
- <para>A number of actions for working with files</para>
- </entry>
- <entry>
- <para>The Guvnor actions (available through the <emphasis>
- <property>Guvnor</property>
- </emphasis> context menu on files) are provided for working with
- files, both those associated with Guvnor repository master copies
- and those not associated.</para>
- </entry>
- <entry>
- <xref linkend="actions"/>
- </entry>
- </row>
+ <row>
+ <entry>
+ <para>A number of actions for working with files</para>
+ </entry>
+ <entry>
+ <para>
+ The Guvnor actions (available through the <guilabel>Guvnor</guilabel> context menu on files) are provided for working with files, both those associated with Guvnor repository master copies and those not associated.
+ </para>
+ </entry>
+ <entry>
+ <xref linkend="actions"/>
+ </entry>
+ </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- <section id="what_is_guvnor_tools">
- <title>What is Guvnor Tools?</title>
- <para>The <property>Guvnor repository</property> is not intended as a Source Code Management
- (SCM) solution, and the <property>EGT</property> is not intended to be Eclipse “team
- provider” extension or replacement. Rather, the Guvnor repository is a location where
- certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by
- policies defined by the deployment environment. The purpose of the <property>EGT</property>
- is then to enable access to resources held by the Guvnor repository, so
- they can be used in development. Thus, limited capabilities for reading, writing, adding,
- and removing Guvnor repository resources are provided in the
- <property>EGT</property>.</para>
- </section>
- <section id="how_to_start">
- <title>Requirements and Installation</title>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="what_is_guvnor_tools">
+ <title>What is Guvnor Tools?</title>
+ <para>
+ The <property>Guvnor repository</property> is not intended as a Source Code Management (SCM) solution, and the <property>EGT</property> is not intended to be an Eclipse “team provider” extension or replacement. Rather, the Guvnor repository is a location where certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by policies defined by the deployment environment. The purpose of the <property>EGT</property> is then to enable access to resources held by the Guvnor repository, so they can be used in development. Thus, limited capabilities for reading, writing, adding, and removing Guvnor repository resources are provided in the <property>EGT</property>.
+ </para>
+ </section>
+ <section id="how_to_start">
+ <title>Requirements and Installation</title>
- <para><property>Guvnor Tools</property> is a part of the <property>JBoss Tools</property>
- project. Thus to get started with Guvnor Tools, you should have the following:</para>
+ <para>
+ <property>Guvnor Tools</property> is a part of the <property>JBoss Tools</property> project. Thus to get started with Guvnor Tools, you should have the following:
+ </para>
- <itemizedlist>
- <listitem>
- <para>Eclipse 3.4.x with Jboss Tools bundle of Eclipse plugins installed. How to
- install JBoss Tools onto Eclipse you can find in the JBoss Tools Installation section.</para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Eclipse 3.4.x with Jboss Tools bundle of Eclipse plugins installed. How to install JBoss Tools onto Eclipse you can find in the JBoss Tools Installation section.
+ </para>
+ </listitem>
- <listitem>
- <para>JBoss Server 4.2 or higher with Guvnor repository deployed.</para>
- </listitem>
- </itemizedlist>
- <para>To have JBoss Server with Guvnor repository deployed, you should
- download <ulink url="http://www.jboss.org/drools/downloads.html">Drools Guvnor</ulink>.
- When downloading you may choose either web based Guvnor to deploy to your
- JBoss Server or Standalone Guvnor with JBoss AS.</para>
- <para>If you use a JBoss AS 5 and a <property>Guvnor Tools</property> doesn't work when deployed to the server,
- you should do the following to get Guvnor Tools running:</para>
- <orderedlist>
- <listitem>
- <para>Remove the JBoss Security libraries (authorization-spi-2.0.2.CR6.jar,
- identity-*, acl-spi-2.0.2.CR6.jar) from drools WAR file (not the app server itself).
- The JBoss Security libraries are provided in AS 5.</para>
- </listitem>
- <listitem>
- <para>Remove the JAXP libraries (xercesImpl-2.8.0.jar, xml-apis-2.*)</para>
- </listitem>
- <listitem>
- <para>Remove the EL libraries (el-*)</para>
- </listitem>
- </orderedlist>
- <para>After this, Guvnor should operate as normal.
- During deployment, you would see the following exception in the log which indicates that the experiemental
- JBoss Security based ACL integration has defined some EJB3/JPA stuff in guvnor that has not been configured.</para>
- <programlisting>ERROR [AbstractKernelController] Error installing to Start: name=persistence.unit:unitName=#ACL state=Create
+ <listitem>
+ <para>JBoss Server 4.2 or higher with Guvnor repository deployed.</para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ To deploy JBoss Server with the Guvnor repository, you should download <ulink url="http://www.jboss.org/drools/downloads.html">Drools Guvnor</ulink>. When downloading you may choose either web based Guvnor to deploy to your JBoss Server or Standalone Guvnor with JBoss AS.
+ </para>
+ <para>
+ If you use JBoss AS 5 and <property>Guvnor Tools</property> doesn't work when deployed to the server, you should do the following to get Guvnor Tools running:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Remove the JBoss Security libraries (authorization-spi-2.0.2.CR6.jar, identity-*, acl-spi-2.0.2.CR6.jar) from drools WAR file (not the app server itself). The JBoss Security libraries are provided in AS 5.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Remove the JAXP libraries (xercesImpl-2.8.0.jar, xml-apis-2.*)</para>
+ </listitem>
+ <listitem>
+ <para>Remove the EL libraries (el-*)</para>
+ </listitem>
+ </orderedlist>
+ <para>
+ After this, Guvnor should operate as normal. During deployment, you would see the following exception in the log which indicates that the experimental JBoss Security based ACL integration has defined some EJB3/JPA stuff in guvnor that has not been configured.
+ </para>
+ <programlisting>ERROR [AbstractKernelController] Error installing to Start: name=persistence.unit:unitName=#ACL state=Create
java.lang.RuntimeException: Specification violation [EJB3 JPA 6.2.1.2] - You have not defined a non-jta-data-source
for a RESOURCE_LOCAL enabled persistence context named: ACL
- </programlisting>
- <para>Now refer to the <xref linkend="functionality_overview"/>
- section to find out what you can do with Guvnor and
- Eclipse synchronisation tool.</para>
- </section>
+ </programlisting>
+ <para>
+ Now refer to the <xref linkend="functionality_overview"/> section to find out what you can do with Guvnor and Eclipse synchronization tool.</para>
+ </section>
</chapter>
15 years, 2 months
JBoss Tools SVN: r28421 - trunk/drools/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-19 22:46:55 -0500 (Wed, 19 Jan 2011)
New Revision: 28421
Modified:
trunk/drools/docs/reference/en-US/Revision_History.xml
trunk/drools/docs/reference/en-US/debugging_rules.xml
trunk/drools/docs/reference/en-US/editors.xml
Log:
General Updates
Modified: trunk/drools/docs/reference/en-US/Revision_History.xml
===================================================================
--- trunk/drools/docs/reference/en-US/Revision_History.xml 2011-01-20 03:17:51 UTC (rev 28420)
+++ trunk/drools/docs/reference/en-US/Revision_History.xml 2011-01-20 03:46:55 UTC (rev 28421)
@@ -2,31 +2,51 @@
<!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>1</revnumber><date>Wed Jun 09 2010</date>
- <author>
- <firstname>JBoss Tools</firstname><surname>Documentation Team</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>General updates</member>
- </simplelist>
- </revdescription>
- </revision>
- <revision>
- <revnumber>0</revnumber><date>Fri Nov 20 2009</date>
- <author>
- <firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>Initial creation of book by publican</member>
- </simplelist>
- </revdescription>
- </revision>
- </revhistory>
- </simpara>
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>2</revnumber>
+ <date>Thu Jan 20 2011</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email>mcaspers(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>1</revnumber>
+ <date>Wed Jun 09 2010</date>
+ <author>
+ <firstname>JBoss Tools</firstname>
+ <surname>Documentation Team</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>General updates</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Fri Nov 20 2009</date>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ <email>irooskov(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
</appendix>
Modified: trunk/drools/docs/reference/en-US/debugging_rules.xml
===================================================================
--- trunk/drools/docs/reference/en-US/debugging_rules.xml 2011-01-20 03:17:51 UTC (rev 28420)
+++ trunk/drools/docs/reference/en-US/debugging_rules.xml 2011-01-20 03:46:55 UTC (rev 28421)
@@ -71,7 +71,7 @@
<itemizedlist>
<listitem>
<para>
- Select the main class of your application. Right click it and select <menuchoice><guimenuitem>Debug As</guimenuitem><guimenuitem></guimenuitem>Drools Application</menuchoice>.
+ Select the main class of your application. Right click it and select <menuchoice><guimenuitem>Debug As</guimenuitem><guimenuitem>Drools Application</guimenuitem></menuchoice>.
</para>
</listitem>
</itemizedlist>
Modified: trunk/drools/docs/reference/en-US/editors.xml
===================================================================
--- trunk/drools/docs/reference/en-US/editors.xml 2011-01-20 03:17:51 UTC (rev 28420)
+++ trunk/drools/docs/reference/en-US/editors.xml 2011-01-20 03:46:55 UTC (rev 28421)
@@ -1,536 +1,564 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="editors">
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Drools Tools</keyword>
- </keywordset>
- </chapterinfo>
+ <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:
+ <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 <filename>.dsl</filename> files that can be created selecting <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Drools</guimenuitem><guimenuitem>Domain Specific Language</guimenuitem></menuchoice> from the projects context menu.
+ </para>
+ <para>DSL Editor is a default editor for <filename>.dsl</filename> 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 <xref linkend="edit_wizard"/> 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>
+ <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 the <xref linkend="edit_wizard"/> 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 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
- <xref linkend="edit_wizard"/> 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
- <xref linkend="add_wizard"/> section. </para></listitem>
- <listitem><para><emphasis>Sort</emphasis> : please, for more information see <xref linkend="sort"/></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 <xref linkend="rows"/> 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 <xref linkend="edit_wizard"/>.
- 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>
+ <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>
- </tbody>
- </tgroup>
- </table>
- </section>
- </section>
-
- <section id="textual_rule_editor">
- <title>The Rule Editor</title>
+ <row>
+ <entry id="sort">Sort By</entry>
+ <entry>
+ Using this option you can change the sorting order of the language message mappings. To do this select from the drop down list the method of sorting you want and click the <guibutton>Sort</guibutton> 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 at the <xref linkend="edit_wizard"/> 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 at the <xref linkend="add_wizard"/> section.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Sort</emphasis>: please, for more information see the <xref linkend="sort"/> section.
+ </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 <guibutton>Edit</guibutton> button.
+ </para>
+ <para>On the picture below you can see all the options the Edit Language Mapping Wizard will allow you to change.</para>
+ <para>Their names as well as the meaning of the options are correspond to the rows of the table (see <xref linkend="rows"/>).</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 appropriate options and finally click the <guibutton>OK</guibutton> button.</para>
+ </section>
+ <section id="add_wizard">
+ <title>Add language mapping Wizard</title>
+ <para>
+ This wizard is equal to the wizard described in <xref linkend="edit_wizard"/>. It can be opened by clicking the <guibutton>Add</guibutton> 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 provides the ability to define the order in which rules should be executed. The Ruleflow file allows you to specify the order in which rule sets should be evaluated using a flow chart. This allows you to define which rule sets should be evaluated in sequence or in parallel as well as specify the 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 <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other...</guimenuitem><guimenuitem>Flow File</guimenuitem></menuchoice>:
+ </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 this in 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 <guilabel>palette</guilabel>, a <guilabel>canvas</guilabel> and an <guilabel>outline</guilabel> 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 <guilabel>Properties</guilabel> view.
+ </para>
+ <figure>
+ <title>Properties view</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/editors/editors1d.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The <guilabel>Outline</guilabel> view is useful for big complex schemata where not all nodes are seen at one time. So using your <guilabel>Outline</guilabel> 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*"/>
- <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>
+ <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>
- <figure>
- <title>New Rule</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors/editors1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ </tgroup>
+ </table>
+ </section>
- <para>The editor follows the pattern of a normal text editor in eclipse, with all the normal
- features of a text editor:</para>
+ <section>
+ <title>Different types of nodes in Flow Palette</title>
- <itemizedlist>
- <listitem>
- <para>
- <xref linkend="rules_editor_content_assist"/>
- </para>
- </listitem>
+ <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*"/>
- <listitem>
- <para>
- <xref linkend="rules_editor_code_folding"/>
- </para>
- </listitem>
+ <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 execution 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 <property>processId</property> 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 <filename>.drl</filename> (or <filename>.rule</filename> 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>
+ <xref linkend="rules_editor_content_assist"/>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="rules_editor_code_folding"/>
+ </para>
+ </listitem>
+
<!-- <listitem>
<para>
<xref linkend="rules_editor_error_reporting"/>
</para>
</listitem>-->
- <listitem>
- <para>
- <xref linkend="rules_editor_sync_with_outline"/>
- </para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="rules_editor_sync_with_outline"/>
+ </para>
+ </listitem>
+ </itemizedlist>
- <section id="rules_editor_content_assist">
- <title>Content Assist</title>
+ <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>
+ While working in the <property>Rule editor</property> you can get a content assistance the usual way by pressing <keycombo><keycap>Ctrl</keycap><keycap>Space</keycap></keycombo>.
+ </para>
- <para>Content Assist shows all possible keywords for the current cursor position.</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>
+ <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>
+ <para>Content Assist inside of the <guilabel>Message</guilabel> suggests all available fields.</para>
- <figure>
- <title>Content Assist Demonstration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors/editors3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Content Assist Demonstration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/editors/editors3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- </section>
+ </section>
- <section id="rules_editor_code_folding">
- <title>Code Folding</title>
+ <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>
+ <para>
+ Code folding is also available in the <guilabel>Rule editor</guilabel>. To hide and show sections of the file use the icons with minus and 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>
+ <figure>
+ <title>Code Folding</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/editors/editors4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- </section>
+ </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>
+ <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>
+ <para>
+ The <guilabel>Rule editor</guilabel> works in synchronization with the <guilabel>Outline view</guilabel> 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>
+ <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>
+ <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>
+ <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>
+ <para>
+ The <property>Rete Tree view</property> shows you the current Rete Network for your <filename>.drl</filename> file. Just click on the <guilabel>Rete Tree tab</guilabel> at the bottom of the <guilabel>Rule editor</guilabel>.
+ </para>
- <figure>
- <title>Rete Tree</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors/editors6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <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>
+ <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 have a large number 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>
+ <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>
+ <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 <guibutton>+</guibutton> and <guibutton>-</guibutton> icons on the toolbar.
+ </para>
- <figure>
- <title>Rete Tree Zooming</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors/editors8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Rete Tree Zooming</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/editors/editors8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <note>
- <title>Note:</title>
+ <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&op=viewforum&f=201">JBoss forum</ulink>.</para>
- </section>
-
- </section>
-
+ <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. For additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.
+ </para>
+ </section>
+
+ </section>
+
</chapter>
\ No newline at end of file
15 years, 2 months
JBoss Tools SVN: r28420 - trunk/drools/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-19 22:17:51 -0500 (Wed, 19 Jan 2011)
New Revision: 28420
Modified:
trunk/drools/docs/reference/en-US/debugging_rules.xml
Log:
General Updates
Modified: trunk/drools/docs/reference/en-US/debugging_rules.xml
===================================================================
--- trunk/drools/docs/reference/en-US/debugging_rules.xml 2011-01-20 03:08:19 UTC (rev 28419)
+++ trunk/drools/docs/reference/en-US/debugging_rules.xml 2011-01-20 03:17:51 UTC (rev 28420)
@@ -6,52 +6,47 @@
<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>this section will 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>To create breakpoints in the Package Explorer view or Navigator view of the Drools perspective, double-click the selected
- <property>.drl</property> file to open it in the editor. In the example below we opened <property>Sample.drl</property> file.
+ <para>
+ Whenever such a breakpoint is encountered during the execution of the rules, the execution is halted. It is possible to 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 the <emphasis>
- <property>.drl</property>
- </emphasis> files in two ways, similar to adding breakpoints to Java files:</para>
-
+ <para>
+ To create breakpoints in the Package Explorer view or Navigator view of the Drools perspective, double-click the selected <filename>.drl</filename> file to open it in the editor. In the example below we opened <filename>Sample.drl</filename> file.
+ </para>
+
+ <para>
+ You can add and remove rule breakpoints in the <filename>.drl</filename> files in two ways, similar to the way breakpoints are added 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>
+ <para>Double-click the ruler in the <guilabel>Rule editor</guilabel> at the line where you want to add a breakpoint.</para>
<note>
<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>
+ <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>
</note>
<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>
+ <para>
+ Right-click the ruler. Select the <guimenuitem>Toggle Breakpoint</guimenuitem> action in the context 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>
@@ -60,23 +55,24 @@
</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>
+
+ <para>
+ The <guilabel>Debug perspective</guilabel> contains a <guilabel>Breakpoints view</guilabel> 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 <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Perspective</guimenuitem><guimenuitem>Others</guimenuitem><guimenuitem>Debug</guimenuitem></menuchoice>.
+ </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>
-
+
+ <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>
+ <para>
+ Select the main class of your application. Right click it and select <menuchoice><guimenuitem>Debug As</guimenuitem><guimenuitem></guimenuitem>Drools Application</menuchoice>.
+ </para>
</listitem>
</itemizedlist>
<figure>
@@ -87,25 +83,19 @@
</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>
+ <para>
+ Alternatively, you can also select <menuchoice><guimenuitem>Debug As</guimenuitem><guimenuitem>Debug Configuration</guimenuitem></menuchoice> to open a new dialog for creating, managing and running debug configurations.
+ </para>
+
+ <para>
+ Select the <guilabel>Drools Application</guilabel> item in the left tree and click the <guibutton>New launch configuration</guibutton> button (leftmost icon in the toolbar above the tree). This will create a new configuration with a number of the properties already filled in (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>
@@ -114,28 +104,18 @@
</imageobject>
</mediaobject>
</figure>
-
+
<note>
<title>Tip:</title>
<para>Remember to change the name of your debug configuration to something meaningful.</para>
</note>
- <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>
+ <para>Next click the <guibutton>Debug</guibutton> 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 <filename>.drl</filename> file is opened and the active line is highlighted. The <guilabel>Variables</guilabel> 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>
\ No newline at end of file
15 years, 2 months
JBoss Tools SVN: r28419 - trunk/drools/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-19 22:08:19 -0500 (Wed, 19 Jan 2011)
New Revision: 28419
Modified:
trunk/drools/docs/reference/en-US/create_new_project.xml
Log:
General Updates
Modified: trunk/drools/docs/reference/en-US/create_new_project.xml
===================================================================
--- trunk/drools/docs/reference/en-US/create_new_project.xml 2011-01-20 02:53:04 UTC (rev 28418)
+++ trunk/drools/docs/reference/en-US/create_new_project.xml 2011-01-20 03:08:19 UTC (rev 28419)
@@ -1,216 +1,185 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="create_new_project">
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Drools Tools</keyword>
- </keywordset>
- </chapterinfo>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Drools Tools</keyword>
+ </keywordset>
+ </chapterinfo>
- <title>Creating a New Drools Project</title>
+ <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>
+ <para>In this chapter will cover the steps required to setup an executable sample Drools project in which rules can be used.</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>
- <section id="sample_drools_project">
- <title>Creating a Sample Drools Project</title>
+ <para>
+ To create a new Drools project select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Drools Project</guimenuitem></menuchoice>. This will open the <guilabel>New Drools Project wizard</guilabel>, as shown in the figure below.
+ </para>
- <para>First, we suggest that you use <property>Drools perspective</property> which is aimed
- at work with Drools specific resources.</para>
+ <para>On the first page type the project name and click the <guibutton>Next</guibutton> button.</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>
+ <figure>
+ <title>Creating a New Drools Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_project/create_new_project1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>On the first page type the project name and click
- <emphasis><property>Next</property>.</emphasis></para>
+ <para>
+ Next you have the 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 click the <guibutton>Next</guibutton> button.
+ </para>
- <figure>
- <title>Creating a New Drools Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_project/create_new_project1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Selecting Drools Project Elements</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_project/create_new_project2.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's select first two check
- boxes and press <emphasis>
- <property>Next</property>. </emphasis></para>
+ <para>
+ The 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 <guibutton>Configure Workspace Settings</guibutton> link.
+ </para>
- <figure>
- <title>Selecting Drools Project Elements</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_project/create_new_project2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Configuring Drools Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_project/create_new_project3.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>
+ <para>
+ You should see the <property>Preferences window</property> where you can configure the workspace settings for Drools runtimes. To create a new runtime, click the <guibutton>Add</guibutton> 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>
- <figure>
- <title>Configuring Drools Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_project/create_new_project3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <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>
- <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>
+ <figure>
+ <title>Adding a New Drools Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_project/create_new_project4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <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>
+ <para>
+ Let's simply create a new Drools 5 runtime from the jars embedded in the Drools Eclipse plugin. Thus, you should click the <guibutton>Create a new Drools 5 runtime</guibutton> button, select the folder where you want this runtime to be created and click the <guibutton>OK</guibutton> button.
+ </para>
- <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'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 click the <guibutton>OK</guibutton> button.
+ </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>
- <figure>
- <title>Selecting a Drools Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_project/create_new_project5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>Now click the <guibutton>Finish</guibutton> to complete the project creation.</para>
- <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>
- <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, sample rules and test case to get you started.</para>
+ </section>
- <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>
- <section id="structure_overview">
- <title>Drools Project Structure Overview</title>
+ <para>Now let's look at the structure of the organized project. In the <guilabel>Package Explorer</guilabel> you should see the following:</para>
- <para>Now let'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>
- <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 <filename>Sample.drl</filename> in the <filename>src/main/rules</filename> directory and an example java file <filename>DroolsTest.java</filename> that can be used to execute the rules in a Drools engine in the folder <filename>src/main/java</filename>, in the <code>com.sample</code> package. All the others jar's that are necessary during execution are also added to the classpath in a custom classpath container called <guilabel>Drools Library</guilabel>.
+ </para>
- <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's that are necessary during execution
- are also added to the classpath in a custom classpath container called <property>Drools
- Library</property>.</para>
+ <note>
+ <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>
+ </note>
- <note>
- <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>
- </note>
+ </section>
- </section>
+ <section id="creating_rule">
+ <title>Creating a New Rule</title>
- <section id="creating_rule">
- <title>Creating a New Rule</title>
+ <para>Now we are going to add a new Rule package to the project.</para>
- <para>Now we are going to add a new Rule package to the project.</para>
+ <para>
+ You can either create an empty text <filename>.drl</filename> file or make use of the special <guilabel>New Rule Package...</guilabel> wizard to do it.
+ </para>
- <para>You can either create an empty text <emphasis>
- <property>.drl</property>
- </emphasis> file or make use of the special <property>New Rule Package...</property>
- wizard to do it.</para>
+ <para>
+ To open the wizard select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Rule Resource</guimenuitem></menuchoice> or use the menu with the JBoss Drools icon on the toolbar.
+ </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 Package Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_project/create_new_project8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Opening the New Rule Package Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_project/create_new_project8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>
+ On the wizard page first select <guilabel>/rules</guilabel> as a top level directory to store your rules and type the rule name. Next specify the mandatory rule package name. It defines a namespace that groups rules together.
+ </para>
- <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's mandatory to specify the rule package name. It defines a namespace that
- groups rules together.</para>
+ <figure>
+ <title>New Rule Package Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_project/create_new_project9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>New Rule Package 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>
- <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>
- <figure>
- <title>New Rule</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_project/create_new_project10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ </section>
- </section>
-
</chapter>
\ No newline at end of file
15 years, 2 months
JBoss Tools SVN: r28418 - trunk/drools/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-19 21:53:04 -0500 (Wed, 19 Jan 2011)
New Revision: 28418
Modified:
trunk/drools/docs/reference/en-US/introduction.xml
Log:
General Updates
Modified: trunk/drools/docs/reference/en-US/introduction.xml
===================================================================
--- trunk/drools/docs/reference/en-US/introduction.xml 2011-01-20 02:14:59 UTC (rev 28417)
+++ trunk/drools/docs/reference/en-US/introduction.xml 2011-01-20 02:53:04 UTC (rev 28418)
@@ -1,168 +1,161 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="introduction">
- <title>Introduction</title>
+ <title>Introduction</title>
- <section id="whatisDrools">
- <title>What is Drools?</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>
+ <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>
+ <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_single/index.html"
- >Drools Documentation</ulink>.</para>
- </note>
+ <note>
+ <title>Note:</title>
+ <para>
+ It is assumed that you has some familiarity with rule engines and Drools in particular. If not, we suggest that you look carefully through the <ulink url="http://downloads.jboss.com/drools/docs/4.0.7.19894.GA/html_single/index.html">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>
+ <para>
+ <property>Drools Tools</property> comes bundled with the <property>JBoss Tools</property> set of Eclipse plugins. You can find instructions on how to install <property>JBoss Tools</property> in the Getting Started Guide.
+ </para>
+ </section>
- <section id="drools_key_features">
- <title>Drools Tools Key Features</title>
+ <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">
+ <para>The following table lists the main features of <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*"/>
+ <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>
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
- <tbody>
+ <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>
- <xref linkend="sample_drools_project"/>
- </entry>
- </row>
+ <row>
+ <entry>
+ <para>Wizard for creating a new Drools Project</para>
+ </entry>
+ <entry>
+ <para>The wizard provides a way to create a sample project to easily get started with Drools</para>
+ </entry>
+ <entry>
+ <xref linkend="sample_drools_project"/>
+ </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>
- <xref linkend="creating_rule"/>
+ <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>
+ <xref linkend="creating_rule"/>
<!--xref linkend="creating_dsl"/>
<xref linkend="creating_decision_table"/>
<xref linkend="creating_business_rule"/-->
- </entry>
- </row>
+ </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>
- <xref linkend="textual_rule_editor"/>
- </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>
+ <xref linkend="textual_rule_editor"/>
+ </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>
- <xref linkend="dsl_editor"/>
- </entry>
- </row>
+ <row>
+ <entry>
+ <para>The Domain Specific Language editor</para>
+ </entry>
+ <entry>
+ <para>An editor that provides a way to create and manage mappings from users language to the rule language</para>
+ </entry>
+ <entry>
+ <xref linkend="dsl_editor"/>
+ </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 Guided editor</para>
+ </entry>
+ <entry>
+ <para>This 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>
- <xref linkend="ruleflow_editor"/>
- </entry>
- </row>
+ <row>
+ <entry>
+ <para>The Rule Flow graphical editor</para>
+ </entry>
+ <entry>
+ <para>The editor provides a way to edit the visual graphs which represent a process (a rule flow)</para>
+ </entry>
+ <entry>
+ <xref linkend="ruleflow_editor"/>
+ </entry>
+ </row>
- </tbody>
- </tgroup>
- </table>
- </section>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
- <section>
- <title>Other relevant resources on the topic</title>
+ <section>
+ <title>Other relevant resources on the topic</title>
- <itemizedlist>
- <listitem>
- <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink></para>
- </listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink>
- </para>
- </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
+ <listitem>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest
JBossTools/JBDS documentation builds</ulink>
- </para>
- </listitem>
+ </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>
+ <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>
+ </section>
</chapter>
15 years, 2 months
JBoss Tools SVN: r28417 - trunk/bpel/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-19 21:14:59 -0500 (Wed, 19 Jan 2011)
New Revision: 28417
Modified:
trunk/bpel/docs/reference/en-US/Book_Info.xml
Log:
General Updates
Modified: trunk/bpel/docs/reference/en-US/Book_Info.xml
===================================================================
--- trunk/bpel/docs/reference/en-US/Book_Info.xml 2011-01-20 00:40:31 UTC (rev 28416)
+++ trunk/bpel/docs/reference/en-US/Book_Info.xml 2011-01-20 02:14:59 UTC (rev 28417)
@@ -7,7 +7,7 @@
<productname>JBoss Developer Studio</productname>
<productnumber>4.0</productnumber>
<edition>4.0.0</edition>
- <pubsnumber>4</pubsnumber>
+ <pubsnumber>5</pubsnumber>
<abstract>
<para>The JBoss BPEL User Guide explains how to use the BPEL Tools to create BPEL files quickly and with precision.</para>
</abstract>
15 years, 2 months
JBoss Tools SVN: r28416 - trunk/jmx/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-19 19:40:31 -0500 (Wed, 19 Jan 2011)
New Revision: 28416
Modified:
trunk/jmx/docs/reference/en-US/summary.xml
Log:
General Updates
Modified: trunk/jmx/docs/reference/en-US/summary.xml
===================================================================
--- trunk/jmx/docs/reference/en-US/summary.xml 2011-01-20 00:35:09 UTC (rev 28415)
+++ trunk/jmx/docs/reference/en-US/summary.xml 2011-01-20 00:40:31 UTC (rev 28416)
@@ -1,32 +1,31 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter>
- <?dbhtml filename="summary.html"?>
- <title>Summary</title>
- <para>In conclusion, with this document you could easily start with JXM Tools.
- The chapters above walked you through the steps on how to do Tomcat,Eclipse Equinox or JBoss Instances managing and how to create new JMX connections.
- The document also includes the reference of JMX Tools features.
-
- If you have questions or suggestions concerned both the documentation and tools behavior,
- you are welcome to JBoss Tools Users forum.
- Please, use Jira to report bugs and requests on documentation.</para>
-
- <section>
- <title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at
- <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tools</ulink> in the corresponding release directory.
- </para>
- <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http://download.jboss.org/jbosstools/nightly-docs</ulink>. </para>
- <para>You can find a set of benefits and other extra information on:</para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink url="http://www.jboss.org/community/wiki/JBossMX">JBoss Wiki</ulink>
- </para>
- </listitem>
- <listitem><para>For more information about JMX technology please visit
- <ulink url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/">
- JMX Technology Home Page</ulink></para>
- </listitem>
- </itemizedlist>
- </section>
+ <?dbhtml filename="summary.html"?>
+ <title>Summary</title>
+ <para>
+ In conclusion, with this document you could easily start with JXM Tools. The chapters above walked you through the steps on how to do Tomcat,Eclipse Equinox or JBoss Instances managing and how to create new JMX connections. The document also includes the reference of JMX Tools features. If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome to JBoss Tools Users forum. Please, use Jira to report bugs and requests on documentation.
+ </para>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+ <para>
+ All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tools</ulink> in the corresponding release directory.
+ </para>
+ <para>
+ The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http://download.jboss.org/jbosstools/nightly-docs</ulink>.
+ </para>
+ <para>You can find a set of benefits and other extra information on:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.org/community/wiki/JBossMX">JBoss Wiki</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ For more information about JMX technology please visit <ulink url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/">JMX Technology Home Page</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
</chapter>
\ No newline at end of file
15 years, 2 months
JBoss Tools SVN: r28415 - trunk/jmx/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-19 19:35:09 -0500 (Wed, 19 Jan 2011)
New Revision: 28415
Modified:
trunk/jmx/docs/reference/en-US/references.xml
Log:
General Updates
Modified: trunk/jmx/docs/reference/en-US/references.xml
===================================================================
--- trunk/jmx/docs/reference/en-US/references.xml 2011-01-20 00:28:02 UTC (rev 28414)
+++ trunk/jmx/docs/reference/en-US/references.xml 2011-01-20 00:35:09 UTC (rev 28415)
@@ -1,170 +1,133 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="references">
- <?dbhtml filename="references.html"?>
- <title>References</title>
-
- <section id="mbean_explorer" xreflabel="mbean_explorer">
- <?dbhtml filename="mbean_explorer.html"?>
+ <?dbhtml filename="references.html"?>
+ <title>References</title>
+
+ <section id="mbean_explorer" xreflabel="mbean_explorer">
+ <?dbhtml filename="mbean_explorer.html"?>
+
+ <title>MBean Explorer</title>
+ <para>
+ The <guilabel>MBean Explorer</guilabel> displays the MBean features (both attributes and operations) in its hierarchy. Double-clicking on a feature will open a <property>MBean Editor</property>, displaying the page corresponding to the feature type and select the feature.
+ </para>
+
+ <figure>
+ <title>MBean Explorer Features</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-explorer-features.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Since it is possible to have many MBean Editors opened at the same time, the <guilabel>MBean Explorer</guilabel> has the Link With Editor button <inlinemediaobject> <imageobject> <imagedata fileref="images/link-with-editor_0.2.0.png"/></imageobject></inlinemediaobject> to synchronize selections between the active <guilabel>MBean Editor</guilabel> and the <guilabel>MBean Explorer</guilabel> (and vice versa).
+ </para>
+
+ <para>
+ The <guilabel>MBean Explorer</guilabel> has also a filter that can be used to filter the available MBeans to show those that interest you.
+ </para>
+
+ <para>
+ For example, if you are only interested by MBeans related to memory, typing "memo" will show any node (domain, mbean, attribute, or operation) that matches that text, as well as that node's parents and children. So if an MBean matches, all attributes and operations from that bean will show. If, however, an attribute or operation name (a leaf node) matches, only that node and its parents in the tree will show.
+ </para>
+
+ <figure>
+ <title>Query Filter</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-explorer-query.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <title>MBean Explorer</title>
- <para>The <property>MBean Explorer</property> displays the MBean features (both attributes and operations) in its
- hierarchy. Double-clicking on a feature will open a <property>MBean Editor</property>, display the page
- corresponding to the feature type and select the feature.</para>
-
- <figure>
- <title>MBean Explorer Features</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-explorer-features.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Since it's possible to have many MBean Editors opened at the same time, the <property>MBean Explorer</property>
- has the Link With Editor button
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/link-with-editor_0.2.0.png"/>
- </imageobject>
- </inlinemediaobject>
-
- to synchronize selections between the active <property>MBean Editor</property> and
- the <property>MBean Explorer</property> (and vice versa).</para>
-
- <para>The <property>MBean Explorer</property> has also a filter text that can be used to filter among all the MBeans
- the few ones, which interest you.</para>
-
- <para>For example, if you are only interested by MBeans related to memory, typing memo will show
- any node (domain, mbean, attribute, or operation) that matches that text, as well as
- that node's parents and children. So if an MBean matches, all attributes and operations from
- that bean will show. If, however, an attribute or operation name (a leaf node) matches,
- only that node and its parents in the tree will show.</para>
-
- <figure>
- <title>Query Filter</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-explorer-query.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>The <emphasis>
- <property>Collapse All</property></emphasis> button
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/collaps_all.png"/>
- </imageobject>
- </inlinemediaobject>
-
- on the <property>MBean Explorer</property> toolbar is used to collapse all the MBeans and
- display only the domains. It is also possible to double click on a node to expand/collapse it. </para>
-
- </section>
- <section id="mbean_editor" xreflabel="mbean_editor">
- <?dbhtml filename="mbean_editor.html"?>
-
- <title>MBean Editor</title>
-
- <figure>
- <title>MBean Editor Pages</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-editor_0.2.0.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The <property>MBean Editor</property> is composed of several pages:</para>
-
- <itemizedlist>
- <listitem>
- <para>the <emphasis>
- <property>Attributes</property></emphasis> page</para>
- </listitem>
- <listitem>
- <para>the <emphasis>
- <property>Operations</property></emphasis> page</para>
- </listitem>
- <listitem>
- <para>the <emphasis>
- <property>Notifications</property></emphasis> page </para>
- </listitem>
- <listitem>
- <para>the <emphasis>
- <property>Info</property></emphasis> page </para>
- </listitem>
- </itemizedlist>
-
- <para> The <emphasis>
- <property>Attributes</property>
- </emphasis> and <emphasis>
- <property>Operations</property>
- </emphasis> pages display a list for either the MBean attributes or operations as well as
- details for the selection.</para>
-
- <para> It is possible to toggle the layout between the list and the details either vertically
- (by default) or horizontally with the help of the special icons
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"/>
- </imageobject>
- </inlinemediaobject>
-
- in the right top corner of the editor.</para>
-
- <figure>
- <title>MBean Editor Horizontal Layout</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <figure id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor">
- <title>Visual Page Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444" />
- </imageobject>
- <textobject>
- <phrase>
- The Visual Page Editor, showing both the source and a visual preview simultaneously.
- </phrase>
- </textobject>
- </mediaobject>
- </figure>
- <section>
- <title>Notifications Page</title>
- <para>One more page in the <property>MBean Editor</property> is the <emphasis>
- <property>Notifications</property></emphasis> page, which gives the possibility to
- subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp.
- unchecking) the <emphasis>
- <property>Subscribe</property></emphasis> button in the right top corner. </para>
- <para>The list of notifications is refreshed every time a new notification is
- received:</para>
-
- <figure>
- <title>MBean Editor Notifications Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/notifications.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note</title>
- <para>It is only possible to subscribe to MBean, which emits notifications (they must be
- NotificationBroadcaster).</para>
- </note>
-
- </section>
-
- </section>
-
- </chapter>
+
+ <para>
+ The <guibutton>Collapse All</guibutton> button <inlinemediaobject><imageobject><imagedata fileref="images/collaps_all.png"/></imageobject></inlinemediaobject> on the <property>MBean Explorer</property> toolbar is used to collapse all the MBeans and display only the domains. It is also possible to double click on a node to expand or collapse it.
+ </para>
+
+ </section>
+ <section id="mbean_editor" xreflabel="mbean_editor">
+ <?dbhtml filename="mbean_editor.html"?>
+
+ <title>MBean Editor</title>
+
+ <figure>
+ <title>MBean Editor Pages</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-editor_0.2.0.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The <property>MBean Editor</property> is composed of several pages:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>the <guilabel>Attributes</guilabel> page</para>
+ </listitem>
+ <listitem>
+ <para>the <guilabel>Operations</guilabel> page</para>
+ </listitem>
+ <listitem>
+ <para>the <guilabel>Notifications</guilabel> page </para>
+ </listitem>
+ <listitem>
+ <para>the <guilabel>Info</guilabel> page </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The <guilabel>Attributes</guilabel> and <guilabel>Operations</guilabel> pages display a list for either the MBean attributes or operations as well as details for the selection.
+ </para>
+
+ <para>
+ It is possible to toggle the layout between the list and the details either vertically (by default) or horizontally with the help of the special icons <inlinemediaobject><imageobject><imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"/></imageobject></inlinemediaobject>in the right top corner of the editor.
+ </para>
+
+ <figure>
+ <title>MBean Editor Horizontal Layout</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor">
+ <title>Visual Page Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444" />
+ </imageobject>
+ <textobject>
+ <phrase>The Visual Page Editor, showing both the source and a visual preview simultaneously.</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <section>
+ <title>Notifications Page</title>
+ <para>
+ One more page in the <guilabel>MBean Editor</guilabel> is the <guilabel>Notifications</guilabel> page, which gives the possibility to subscribe or unsubscribe to an MBean to receive its notifications by checking or unchecking the <guibutton>Subscribe</guibutton> button in the right top corner.
+ </para>
+ <para>The list of notifications is refreshed every time a new notification is received:</para>
+
+ <figure>
+ <title>MBean Editor Notifications Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/notifications.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note</title>
+ <para>It is only possible to subscribe to MBean that emits notifications (i.e. they must be a NotificationBroadcaster).</para>
+ </note>
+
+ </section>
+
+ </section>
+
+</chapter>
15 years, 2 months
JBoss Tools SVN: r28414 - trunk/jmx/docs/reference/en-US.
by jbosstools-commits@lists.jboss.org
Author: mcaspers
Date: 2011-01-19 19:28:02 -0500 (Wed, 19 Jan 2011)
New Revision: 28414
Modified:
trunk/jmx/docs/reference/en-US/tasks.xml
Log:
General Updates
Modified: trunk/jmx/docs/reference/en-US/tasks.xml
===================================================================
--- trunk/jmx/docs/reference/en-US/tasks.xml 2011-01-19 23:39:41 UTC (rev 28413)
+++ trunk/jmx/docs/reference/en-US/tasks.xml 2011-01-20 00:28:02 UTC (rev 28414)
@@ -1,162 +1,184 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="tasks">
- <?dbhtml filename="tasks.html"?>
- <title>JMX Tools Tasks</title>
- <para>This chapter will give you answers on most popular questions asked by <property>JMX
- plugin</property> users.</para>
- <section>
- <title>Quick Start</title>
-
- <para>To start using the <property>JMX Tools</property> it's necessary to open
- <property>MBean Explorer</property>. Go to <emphasis><property>Window > Show View > Other</property></emphasis> and then select
- <property>MBean Explorer</property> and click <emphasis><property>OK</property>.</emphasis></para>
-
- <para>The <property>MBean Explorer</property> lists all the domains, mbeans, attributes, and operations inside a
- connection. When you double-click a MBean in the <emphasis><property>MBean Explorer</property>,</emphasis> it opens a multi-page
- editor to manage the MBean. The <property>MBean Editor</property> is composed of these pages:</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis><property>Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para>
- </listitem>
- <listitem>
- <para><emphasis><property>Operations page</property>,</emphasis> to invoke operations on the MBean</para>
- </listitem>
- <listitem>
- <para><emphasis><property>Notifications page</property>,</emphasis> to receive notifications from the MBean</para>
- </listitem>
- <listitem>
- <para><emphasis><property>Info page</property>,</emphasis> which displays general information about the MBean </para>
- </listitem>
- </itemizedlist>
-
- </section>
-
- <section>
- <title>Managing Application</title>
+ <?dbhtml filename="tasks.html"?>
+ <title>JMX Tools Tasks</title>
+ <para>This chapter will provide answers to common questions asked by <property>JMX plugin</property> users.</para>
+ <section>
+ <title>Quick Start</title>
+ <para>
+ To start using the <property>JMX Tools</property> it's necessary to open <property>MBean Explorer</property>. Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>, select <guimenuitem>MBean Explorer</guimenuitem> and click the <guibutton>OK</guibutton> button.
+ </para>
+ <para>
+ The <property>MBean Explorer</property> lists all the domains, mbeans, attributes, and operations inside a connection. When you double-click an MBean in the <emphasis><property>MBean Explorer</property>,</emphasis> it opens a multi-page editor to manage the MBean. The <property>MBean Editor</property> is composed of these pages:
+ </para>
-<para>As it's been said earlier in the guide the JMX technology allows to monitor and manage Java applications. In this section we will show you how to get connected to
-a sample Java application and run the <property>sayHello()</property> method remotely from inside of the <property>MBean Explorer</property>.</para>
-<orderedlist>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>
+ <property>Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>
+ <property>Operations page</property>,</emphasis> to invoke operations on the MBean</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>
+ <property>Notifications page</property>,</emphasis> to receive notifications from the MBean</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>
+ <property>Info page</property>,</emphasis> which displays general information about the MBean </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>Managing Application</title>
+
+ <para>
+ As it's been said earlier in the guide that the JMX technology allows you to monitor and manage Java applications. In this section we will show you how to get connected to a sample Java application and run the <code>sayHello()</code> method remotely from inside of the <property>MBean Explorer</property>.
+ </para>
+ <orderedlist>
+
<!-- http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip -->
-<listitem><para>Save the bundle of JMX API sample classes, <ulink url="http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip">jmx_examples.zip</ulink>, to your working directory</para></listitem>
-<listitem><para>Unzip the bundle of sample classes.</para></listitem>
-<listitem><para>Compile the example Java classes from within where you unpacked the files directory.</para>
+ <listitem>
+ <para>
+ Save the bundle of JMX API sample classes, <ulink url="http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip">jmx_examples.zip</ulink>, to your working directory
+ </para>
+ </listitem>
+ <listitem>
+ <para>Unzip the bundle of sample classes.</para>
+ </listitem>
+ <listitem>
+ <para>Compile the example Java classes from within where you unpacked the files directory.</para>
- <programlisting role="XML"><![CDATA[
- javac com/example/*.java
- ]]></programlisting>
+ <programlisting role="XML"><![CDATA[javac com/example/*.java]]></programlisting>
-</listitem>
-<listitem><para>Start the <property>Main</property> application, specifying the properties that expose Main for remote management:</para>
+ </listitem>
+ <listitem>
+ <para>Start the <code>Main</code> application, specifying the properties that expose Main for remote management:</para>
- <programlisting role="XML"><![CDATA[
+ <programlisting role="XML"><![CDATA[
java -Dcom.sun.management.jmxremote.port=9999 \
-Dcom.sun.management.jmxremote.authenticate=false \
-Dcom.sun.management.jmxremote.ssl=false \
com.example.Main
- ]]></programlisting>
+ ]]></programlisting>
+
+ <para>If everything was done correctly you will see the <screen>Waiting for incoming requests...</screen> message on the screen.</para>
-<para>If everything was done correctly you will see the "Waiting for incoming requests..." message on the screen.</para>
+ </listitem>
+ <listitem>
+ <para>
+ Now launch the Eclipse IDE, in Eclipse open the <guilabel>MBean Explorer</guilabel>. Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and then select <guimenuitem>MBean Explorer</guimenuitem> and click the <guibutton>OK</guibutton> button)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <property>MBean Explorer</property> menu bar.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In the <guilabel>Create JMX Connection</guilabel> dialog, click the <guibutton>Next</guibutton> button and then click the <property>Advanced</property> tab.
+ </para>
+ </listitem>
- </listitem>
- <listitem><para>Now launch the Eclipse IDE, in Eclipse open the <property>MBean Explorer</property>. Go to <emphasis><property>Window > Show View > Other</property></emphasis> and then select
- <property>MBean Explorer</property> and click <emphasis><property>OK</property></emphasis>)</para></listitem>
- <listitem>
- <para>Click the <emphasis>
- <property>New Connection</property></emphasis> icon
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/new_connection_icon.png"/>
- </imageobject>
- </inlinemediaobject>
-
- in the <property>MBean Explorer</property> menu
- bar.</para>
- </listitem>
-
- <listitem><para>In the <property>Create JMX Connection</property> dialog, hit <property>Next</property> and then click the <property>Advanced</property> tab. </para></listitem>
-
-
- <listitem><para>In the <property>JMX URL</property> input field enter the following URL:</para>
-
- <programlisting role="XML"><![CDATA[
- service:jmx:rmi:///jndi/rmi://:9999/jmxrmi
- ]]></programlisting>
-
- <figure>
- <title>JMX Connection</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbeans.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
-
- <listitem><para>Press <property>Finish</property> to esteblish the connection with the application.</para>
- </listitem>
-
- <listitem><para>Now expand the connection you have just created, then open the <property>com.example</property> package and click <property>sayHello()</property> method. </para>
- <para>Once the <property>sayHello()</property> method is clicked the <property>MBean Editor</property> is activated. </para>
-
- </listitem>
-
- <listitem><para>In the <property>MBean Editor</property> go to the <property>Operation Details</property> section and hit the <property>sayHello()</property> button.</para><para> You will get the "Operation inoked successfully" message. </para>
-
- <figure>
- <title>Ivoking Method via JMX</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/invokemethod.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
-
- <listitem><para>The final step is to make sure the application worked as it was expected. Open the terminal where you launched the application in step 3. Now you see the "hello, world" message on the screen. </para>
- </listitem>
-</orderedlist>
+ <listitem>
+ <para>In the <guilabel>JMX URL</guilabel> input field enter the following URL:</para>
+ <programlisting role="XML"><![CDATA[service:jmx:rmi:///jndi/rmi://:9999/jmxrmi]]></programlisting>
- </section>
- <section>
- <title>Tomcat Managing</title>
+ <figure>
+ <title>JMX Connection</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbeans.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>Click the <guibutton>Finish</guibutton> button to establish the connection with the application.</para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Now expand the connection you have just created, then open the <guilabel>com.example</guilabel> package and click the <code>sayHello()</code> method.
+ </para>
+ <para>Once the <code>sayHello()</code> method is clicked the <guilabel>MBean Editor</guilabel> is activated. </para>
+
+ </listitem>
+
+ <listitem>
+ <para>
+ In the <guilabel>MBean Editor</guilabel> go to the <guilabel>Operation Details</guilabel> section and click the <code>sayHello()</code> button.
+ </para>
+ <para> You will get the "Operation invoked successfully" message. </para>
+
+ <figure>
+ <title>Ivoking Method via JMX</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/invokemethod.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>
+ The final step is to make sure the application worked as it was expected. Open the terminal where you launched the application in step 3. Now you see the "hello, world" message on the screen.
+ </para>
+ </listitem>
+ </orderedlist>
+
+ </section>
+ <section>
+ <title>Tomcat Managing</title>
+
+ <para>It is possible to manage Tomcat using <property>JMX Tools</property>.</para>
+
+ <para>Currently, JMX Tooling is able to connect to Tomcat without authentication or with password-based authentication.</para>
+ <para>
+ Using SSL for authentication is not supported: you need to make sure that the System property <guilabel>com.sun.management.jmxremote.ssl</guilabel> is set to false.
+ </para>
+ <para>
+ More information to manage Tomcat can be found in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/">Tomcat management documentation</ulink>.
+ </para>
+ <para>
+ Instructions to manage remotely Tomcat are available in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html">Tomcat's monitoring documentation</ulink>.
+ </para>
- <para>It's possible to manage Tomcat using <property>JMX Tools</property>.</para>
-
- <para>Currently, JMX Tooling is able to connect to Tomcat without authentication or with
- password-based authentication.</para>
- <para>Using SSL for authentication is not supported: you need to make sure that the System
- property <emphasis>
- <property>com.sun.management.jmxremote.ssl</property>
- </emphasis> is set to false. </para>
- <para>More information to manage Tomcat can be found in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/">Tomcat management documentation</ulink>.</para>
- <para>Instructions to manage remotely Tomcat are available in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html">Tomcat's monitoring documentation</ulink>.</para>
-
-
- </section>
-
- <section>
- <title>Eclipse Equinox Managing</title>
-
- <para>You can manage Equinox through the Equinox monitoring framework.</para>
- <para>In this section we will show you how to connect to an Equinox server via JBoss JMX tools. First off, you need to make for example a simple servlet and run it on a server. This guide is not intended to teach you how to build application and run them on the server, you can read for example <ulink url="http://www.eclipse.org/equinox-portal/tutorials/server-side/"> this tutorial </ulink> to get a better idea of how to build server-based applications with Eclipse Equinox. </para>
- <para>Once you have run an application on the server you can connect to it using JBoss JMX tools.</para>
-
- <orderedlist>
- <listitem>
- <para>Go to <emphasis>
- <property>Window > Open Perspective > Other</property>
- </emphasis> and select the <property>JMX perspective.</property></para>
- </listitem>
+
+ </section>
+
+ <section>
+ <title>Eclipse Equinox Managing</title>
+
+ <para>You can manage Equinox through the Equinox monitoring framework.</para>
+ <para>
+ In this section we will show you how to connect to an Equinox server via JBoss JMX tools. First off, you need to create a simple servlet and run it on a server. This guide is not intended to teach you how to build application and run them on the server, <ulink url="http://www.eclipse.org/equinox-portal/tutorials/server-side/"> this tutorial </ulink> can be used to give you a better idea of how to build server-based applications with Eclipse Equinox.
+ </para>
+ <para>Once you have run an application on the server you can connect to it using JBoss JMX tools.</para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and select the <guimenuitem>JMX perspective</guimenuitem>.
+ </para>
+ </listitem>
<!--<listitem>
<para>Select <emphasis>
@@ -165,248 +187,187 @@
<property>OK</property>
</emphasis></para>
</listitem>-->
-
- <listitem>
- <para>Switch to the <property>MBean Explorer</property> by going to <emphasis>
- <property>Window > Show View > Other</property>
- </emphasis> and selecting the MBean Explorer.</para>
- </listitem>
-
- <listitem>
- <para>Click the <emphasis>
- <property>New Connection</property></emphasis> icon
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/new_connection_icon.png"/>
- </imageobject>
- </inlinemediaobject>
-
- in the <property>MBean Explorer</property> menu
- bar.</para>
- </listitem>
-
- <listitem>
- <para>Select the <emphasis>
- <property>Advanced tab</property></emphasis> and set the JMX URL to <emphasis>
- <property>service:jmx:rmi:///jndi/rmi://:8118/jmxserver.</property>
- </emphasis></para>
-
- <figure>
- <title>Using JMX Tools to Access Equinox Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/equinox.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </orderedlist>
-
- <para>You now have access to the MBeans exposed by Equinox.</para>
- </section>
+ <listitem>
+ <para>Switch to the <property>MBean Explorer</property> by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and selecting the <guimenuitem>MBean Explorer</guimenuitem>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <property>MBean Explorer</property> menu bar.</para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select the <guilabel>Advanced tab</guilabel> and set the JMX URL to <guilabel>service:jmx:rmi:///jndi/rmi://:8118/jmxserver.</guilabel>
+ </para>
+
+ <figure>
+ <title>Using JMX Tools to Access Equinox Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/equinox.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </listitem>
+ </orderedlist>
+
+ <para>You now have access to the MBeans exposed by Equinox.</para>
+ </section>
-
- <section>
- <title>Managing JBoss AS</title>
-
- <para>Managing JBoss instances is not supported with the <property>JMX Tools</property>
- alone. You must also download and install the <property>AS Tools</property> portion of
- the <property>JBoss Tools</property> distribution. Even after installing the proper
- tooling, you cannot create a JBoss JMX connection yourself or through the Connection
- Wizard. The first step is to create a JBoss Server. The full instructions for this can
- be found in the AS Tools section, however, the short summary is: </para>
- <orderedlist>
- <listitem>
- <para>Open the <property>Servers</property> view.</para>
- </listitem>
-
- <listitem>
- <para>Right-click in the view and select <emphasis>
- <property>New > Server</property>
- </emphasis>.</para>
- </listitem>
-
- <listitem>
- <para>In the <emphasis>
- <property>JBoss Enterprise Middleware</property>
- </emphasis> or in <emphasis>
- <property>JBoss Community</property>
- </emphasis> section, select a server version.</para>
- </listitem>
-
- <listitem>
- <para>If a runtime has not yet been created, you'll be prompted for the
- server's home directory, JDK, and configuration.</para>
- </listitem>
-
- <listitem>
- <para>Finish the wizard and note that you have a new entry in both the
- <property>Servers</property> view and the <property>MBean
- Explorer</property>.</para>
- </listitem>
-
- <listitem>
- <para>Start the server by right-clicking it and selecting <emphasis>
- <property>Start</property></emphasis>.</para>
- </listitem>
- <listitem>
- <para>Note that once the server is started, the JMX connection can be
- expanded.</para>
- </listitem>
- </orderedlist>
-
- <para>Now you can explore MBeans exposed by a JBoss instance.</para>
- </section>
+
+ <section>
+ <title>Managing JBoss AS</title>
+
+ <para>
+ Managing JBoss instances is not supported with the <property>JMX Tools</property> alone. You must also download and install the <property>AS Tools</property> portion of the <property>JBoss Tools</property> distribution. Even after installing the proper tooling, you cannot create a JBoss JMX connection yourself or through the Connection Wizard. The first step is to create a JBoss Server. The full instructions for this can be found in the AS Tools section, however, the short summary is:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>Open the <property>Servers</property> view.</para>
+ </listitem>
+
+ <listitem>
+ <para>Right-click in the view and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice>.</para>
+ </listitem>
+
+ <listitem>
+ <para>In the <guilabel>JBoss Enterprise Middleware</guilabel> or in <guilabel>JBoss Community</guilabel> section, select a server version.</para>
+ </listitem>
+
+ <listitem>
+ <para>If a runtime has not yet been created, you will be prompted for the server's home directory, JDK, and configuration.</para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Finish the wizard and note that you have a new entry in both the <guilabel>Servers</guilabel> view and the <guilabel>MBean Explorer</guilabel>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Start the server by right-clicking it and selecting <guimenuitem>Start</guimenuitem>.</para>
+ </listitem>
+ <listitem>
+ <para>Note that once the server is started, the JMX connection can be expanded.</para>
+ </listitem>
+ </orderedlist>
+
+ <para>Now you can explore MBeans exposed by a JBoss instance.</para>
+ </section>
- <section>
- <title>Managing JBoss AS Remotely</title>
-
- <para>JBoss JMX Tool allow you to easily get access and mangane JBoss AS server remotely.
- In order to get connected to the instance of JBoss AS remotely you need to run the server or make sure the server is lauched.
+ <section>
+ <title>Managing JBoss AS Remotely</title>
+
+ <para>
+ JBoss JMX Tool allow you to easily get access and manage a JBoss AS server remotely. In order to connect to the instance of JBoss AS remotely you need to run the server or make sure the server is launched.
</para>
- <orderedlist>
- <listitem>
- <para>Go to <emphasis>
- <property>Window > Open Perspective > Other</property>
- </emphasis> and select the <property>JMX perspective.</property></para>
- </listitem>
- <listitem>
- <para>Switch to the <property>MBean Explorer</property> by going to <emphasis>
- <property>Window > Show View > Other</property>
- </emphasis> and selecting the MBean Explorer.</para>
- </listitem>
-
- <listitem>
- <para>Click the <emphasis>
- <property>New Connection</property></emphasis> icon
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/new_connection_icon.png"/>
- </imageobject>
- </inlinemediaobject>
-
- in the <property>MBean Explorer</property> menu
- bar.</para>
- </listitem>
-
- <listitem>
- <para>Select the <emphasis>
- <property>Advanced tab</property></emphasis> and set the JMX URL to: </para>
- <programlisting role="XML"><![CDATA[
-service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector
- ]]></programlisting>
-
- <para>Please, note that in this example we connected to the local host. </para>
- </listitem>
- </orderedlist>
- </section>
- <section id="extensions" xreflabel="extensions">
- <title>Extension Task</title>
- <para>This section will outline how to contribute your own Server type with some default
- behavior.</para>
+ <orderedlist>
+ <listitem>
+ <para>Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and select the <guimenuitem>JMX perspective.</guimenuitem>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Switch to the <guilabel>MBean Explorer</guilabel> by going to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and selecting the <guimenuitem>MBean Explorer</guimenuitem>.</para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject>in the <guilabel>MBean Explorer</guilabel> menu bar.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Select the <guilabel>Advanced tab</guilabel> and set the JMX URL to:</para>
+ <programlisting role="XML"><![CDATA[service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector]]></programlisting>
+
+ <para>Please, note that in this example we connected to the local host. </para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="extensions" xreflabel="extensions">
+ <title>Extension Task</title>
+ <para>This section will outline how to contribute your own Server type with some default behavior.</para>
+
+ <section>
+ <title>Why we should do that?</title>
+
+ <para>
+ You might be asking yourself why you would need to extend this framework if JMX is a standard. Perhaps you want a connection to be automatically created after some specific action, or perhaps you want your connection wizard to do more than simply set a host and port. JBoss, for example, requires setting some credentials on the client machine, but uses JBoss classes to do it. This requires that the connection have access to JBoss jars.
+ </para>
+ </section>
+
+ <section>
+ <title>Core Extensions</title>
+
+ <para>
+ To create your own JMX Connection type, you must use the <code>org.jboss.tools.jmx.core.MBeanServerConnectionProvider</code> extension point. This point takes one child, a connectionProvider with a class that implements <code>org.jboss.tools.jmx.core.IConnectionProvider</code>.
+ </para>
+
+ <para>
+ An <code>IConnectionProvider</code> is responsible for creation and deletion of <code>IConnectionWrapper</code> objects. It must also keep a list of listeners that it is expected to inform when a connection is added or removed from its list.
+ </para>
+
+ <para>
+ Each <code>IConnectionWrapper</code> is expected to handle running arbitrary JMX runnables or getting a "Root" object representing all JMX nodes. There are some utility methods the <code>IConnectionWrapper</code> can make use of.
+ </para>
+ </section>
+
+ <section>
+ <title>UI Extensions</title>
+ <para>There are two extension points currently approved for use in the UI</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <code>org.jboss.tools.jmx.ui.providerUI</code> - provide an icon, id, displayable name, and wizardPage class for creation of new connections
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <code>org.jboss.tools.jmx.ui.attribute.controls</code> - allows you to map class types to some Control to present them in the MBean Editor
+ </para>
+ <para>We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ </section>
+ <section id="connection" xreflabel="connection">
+
+ <title>Connections Creation Task</title>
+
+ <para>
+ The <property>MBean Explorer</property> supports several different types of connections. The tooling itself comes only with a default connection type, however other adopters can provide additional connection types that may require additional or non-spec behavior. Connections can be in either the connected state or the disconnected state. Some connection types (such as the default connection type) allow you to control the current state. Other connection types may not.
+ </para>
+
+ <para>
+ Similarly, some connection types may be able to be created, and others may not. The default connection type, for example, can be created and deleted by you at will. The AS Tools connection type, which represents a JBoss server, does not allow you this level of control. A JBoss JMX connection is created when a JBoss server is created in the server's view, and deleted when said server is deleted. The JMX connection for this server is in the connected state only when the server is started.
+ </para>
- <section>
- <title>Why we should do that?</title>
-
- <para>You might be asking yourself why you'd need to extend this framework if JMX is
- a standard. Perhaps you want a connection to be automatically created after some specific
- action, or perhaps you want your connection wizard to do more than simply set a host and
- port. JBoss, for example, requires setting some credentials on the client machine, but
- using JBoss classes to do it. This requires that the connection have access to JBoss
- jars.</para>
- </section>
-
- <section>
- <title>Core Extensions</title>
-
- <para>To create your own JMX Connection type, you must use the
- org.jboss.tools.jmx.core.MBeanServerConnectionProvider extension point. This point takes
- one child, a connectionProvider with a class that implements
- org.jboss.tools.jmx.core.IConnectionProvider.</para>
-
- <para>An IConnectionProvider is responsible for creation and deletion of IConnectionWrapper
- objects. It must also keep a list of listeners that it is expected to inform when a
- connection is added or removed from its list. </para>
-
- <para>Each IConnectionWrapper is expected to handle running arbitrary JMX runnables or getting
- a "Root" object representing all JMX nodes. There are some utility methods the
- IConnectionWrapper can make use of.</para>
- </section>
-
- <section>
- <title>UI Extensions</title>
- <para>There are two extension points currently approved for use in the UI</para>
- <itemizedlist>
- <listitem>
- <para>org.jboss.tools.jmx.ui.providerUI - provide an icon, id, displayable name, and
- wizardPage class for creation of new connections</para>
- </listitem>
- <listitem>
- <para>org.jboss.tools.jmx.ui.attribute.controls - allows you to map class types to some
- Control to present them in the MBean Editor</para>
- <para>We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on <ulink
- url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- </section>
- <section id="connection" xreflabel="connection">
-
- <title>Connections Creation Task</title>
-
- <para>The <property>MBean Explorer</property> supports several different types of connections.
- The tooling itself comes only with a default connection type, however other
- adopters can provide additional connection types that may require additional
- or non-spec behavior. Connections can be in either the connected state or
- the disconnected state. Some connection types (such as the default connection type)
- allow you to control the current state. Other connection types may not. </para>
-
- <para>Similarly, some connection types may be able to be created, and others may not.
- The default connection type, for example, can be created and deleted by you
- at will. The AS Tools connection type, which represents a JBoss server, does not
- allow you this level of control. A JBoss JMX connection is created when a JBoss server is created
- in the server's view, and deleted when said server is deleted. The JMX connection for
- this server is in the connected state only when the server is started. </para>
-
-
- <section><title>Establishing Connection</title>
-
- <para> There are two ways to connect to an application with remote management enabled:</para>
-
- <para> The first step is the same for both - to connect to a MBean Server, click the
- <emphasis>
- <property>New Connection</property></emphasis> icon
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/new_connection_icon.png"/>
- </imageobject>
- </inlinemediaobject>
-
- in the <property>MBean Explorer</property> menu bar.</para>
-
- <para>Then to follow the simple one you just need to specify host, port (and optionally user
- name and password) and click <emphasis>
- <property>OK</property>.</emphasis></para>
- <para>On the <property>Advanced</property> tab you can set the sever name (it will be displayed in <property>MBean Explorer</property>), a url to the remote server.
- For example, to connect to JBoss AS you need to set the <property>JMX URL</property> to
- </para>
- <programlisting role="XML"><![CDATA[
-service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector
- ]]></programlisting>
- <para>If it is required you can enter user name and password for the server connection.
- </para>
-
-
- <note>
- <title>Note</title>
- <para>Only JMX URL based on RMI are supported.</para>
- </note>
- </section>
- </section>
+
+ <section>
+ <title>Establishing Connection</title>
+
+ <para> There are two ways to connect to an application with remote management enabled:</para>
+
+ <para>
+ The first step is the same for both - to connect to a MBean Server, click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <guilabel>MBean Explorer</guilabel> menu bar.
+ </para>
+
+ <para>
+ Then to follow the simple one you just need to specify host, port (and optionally user name and password) and click the <guibutton>OK</guibutton> button.
+ </para>
+ <para>
+ On the <guilabel>Advanced</guilabel> tab you can set the sever name (it will be displayed in <guilabel>MBean Explorer</guilabel>), a URL to the remote server. For example, to connect to JBoss AS you need to set the <guilabel>JMX URL</guilabel> to
+ </para>
+ <programlisting role="XML"><![CDATA[service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector]]></programlisting>
+ <para>If it is required you can enter user name and password for the server connection. </para>
+ <note>
+ <title>Note</title>
+ <para>Only JMX URL based on RMI are supported.</para>
+ </note>
+ </section>
+ </section>
</chapter>
15 years, 2 months