[jboss-svn-commits] JBL Code SVN: r24939 - labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Tue Jan 27 02:29:02 EST 2009
Author: michael.neale at jboss.com
Date: 2009-01-27 02:29:02 -0500 (Tue, 27 Jan 2009)
New Revision: 24939
Modified:
labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-Architecture.xml
labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-ExamplesAndTutorials.xml
labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-Introduction.xml
labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-UserGuide.xml
Log:
updated the doco
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-Architecture.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-Architecture.xml 2009-01-27 06:07:43 UTC (rev 24938)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-Architecture.xml 2009-01-27 07:29:02 UTC (rev 24939)
@@ -1,31 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
- <section version="5.0" xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook" xml:base="../../">
+<section version="5.0" xml:base="../../" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
<title>Architecture</title>
- <para>This section covers the technical aspects of the Business Rules Management System (BRMS), it is not necessary to
- use this if you are integrating or an end user of the BRMS application.
- However, JBoss Rules is open source, so build instructions form part of the
- manual.</para>
+ <para>This section covers the technical aspects of Guvnor (previously known
+ as the Business Rules Management System or BRMS), it is not necessary to use
+ this if you are integrating or an end user of the BRMS application. However,
+ Drools is open source, so build instructions form part of the manual.</para>
<para>You may want to build from source if you want to re-use components, or
embed the application within another.</para>
<figure>
- <title>Architectural diagram</title>
+ <title>Architectural diagram</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/Architecture.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/Architecture.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
<para>The above diagram shows the major components of the system and how
they integrate and are deployed. The User Guide has more details on the
@@ -40,76 +41,92 @@
<section>
<title>Building from source</title>
- <para>This section will go over the steps necessary to build
- various components. Mostly this is automated, but the manual process is
- described for thoroughness.</para>
+ <para>This section will go over the steps necessary to build various
+ components. Mostly this is automated, but the manual process is described
+ for thoroughness.</para>
<section>
<title>Modules</title>
- <para>There are 2 modules: drools-repository (back end) and drools-jbrms
- (front end and rules integration). The drools-jbrms module depends on
- the drools-repository module, as well as other components. The BRMS is
- part of the main build for all of Drools - when building Drools, the BRMS is built alongside it.</para>
+ <para>There are 2 modules: drools-repository (back end) and
+ drools-guvnor (front end and rules integration). The drools-guvnor
+ module depends on the drools-repository module, as well as other
+ components. Guvnor is part of the main build for all of Drools - when
+ building Drools, Guvnor is built alongside it.</para>
</section>
<section>
<title>Working with Maven 2</title>
- <para>Maven 2 is used as the build system. To get started, the WHOLE of the source tree for JBoss Rules will need to be checked out. This includes the other modules, and the top level lib and repository directories (which are needed by the build); as the BRMS build is part of the main drools build.</para>
+ <para>Maven 2 is used as the build system. To get started, the WHOLE of
+ the source tree for JBoss Rules will need to be checked out. This
+ includes the other modules, and the top level lib and repository
+ directories (which are needed by the build); as the BRMS build is part
+ of the main drools build.</para>
- <para>Initially, go into the root of the jboss-rules checked
- out source tree, and run mvn install to install all the components for
- the inter project dependencies. If the build is broken (all care is taken for this eventuality not to occur), the flag -Dmaven.test.skip=true can be used to prevent failing
- unit tests from preventing the build.</para>
+ <para>Initially, go into the root of the jboss-rules checked out source
+ tree, and run mvn install to install all the components for the inter
+ project dependencies. If the build is broken (all care is taken for this
+ eventuality not to occur), the flag -Dmaven.test.skip=true can be used
+ to prevent failing unit tests from preventing the build.</para>
- <para>When wishing to build the BRMS, go into the
- drools-jbrms directory, and run <code>mvn package</code>. This will run the tests,
- and then build a deployable war. The only thing this will not do is rebuild
- the GWT front end (see the next section for details on that). Once the war file is in the target directory, the BRMS is ready to go.</para>
+ <para>When wishing to build the BRMS, go into the drools-jbrms
+ directory, and run <code>mvn package</code>. This will run the tests,
+ and then build a deployable war. The only thing this will not do is
+ rebuild the GWT front end (see the next section for details on that).
+ Once the war file is in the target directory, the BRMS is ready to
+ go.</para>
</section>
<section>
<title>Working with GWT</title>
<para>The GUI widgets for the web front end are developed with GWT
- (Google Web Toolkit). If there is a need to make changes to or build the GUI, GWT will need to be downloaded separately. Once GWT is downloaded, the <filename>build.properties</filename> file in the drools-jbrms directory to
- point to where GWT is installed. Once this is completed, the
- ant tasks can be used to build the GWT components, as well as launch GWT in
- debug/hosted mode if it is desired. If running the build, it will
- update the webapp directory in the project with the new <emphasis>compiled</emphasis>
- artifacts (GWT does not use JSP, only html and javascript at
- runtime).</para>
+ (Google Web Toolkit). If there is a need to make changes to or build the
+ GUI, GWT will need to be downloaded separately. Once GWT is downloaded,
+ the <filename>build.properties</filename> file in the drools-jbrms
+ directory to point to where GWT is installed. Once this is completed,
+ the ant tasks can be used to build the GWT components, as well as launch
+ GWT in debug/hosted mode if it is desired. If running the build, it will
+ update the webapp directory in the project with the new
+ <emphasis>compiled</emphasis> artifacts (GWT does not use JSP, only html
+ and javascript at runtime).</para>
</section>
<section>
<title>Debugging, Editing and running with Eclipse</title>
<para>Each module has a ready to go and up to date eclipse project
- configuration, so they can merely be imported into the eclipse workspace.
- These projects are generated by Maven (<code>mvn eclipse:eclipse</code> to refresh
- them in case they are wrong or outdated). They have been manually
- modified to have project dependencies (this means the code can be stepped through when debugging).</para>
+ configuration, so they can merely be imported into the eclipse
+ workspace. These projects are generated by Maven (<code>mvn
+ eclipse:eclipse</code> to refresh them in case they are wrong or
+ outdated). They have been manually modified to have project dependencies
+ (this means the code can be stepped through when debugging).</para>
- <para>Some environment variables are required in eclipse
- (for Window: >Preferences->Java->Build path->Classpath
- variables): the M2_REPO, as normal, to point to where Maven downloads
- shared dependencies. GWT_HOME should point to where you installed GWT.
- GWT_DEV must point to the platform specific "dev" jar that ships with
- the version of GWT you have.</para>
+ <para>Some environment variables are required in eclipse (for Window:
+ >Preferences->Java->Build path->Classpath variables): the
+ M2_REPO, as normal, to point to where Maven downloads shared
+ dependencies. GWT_HOME should point to where you installed GWT. GWT_DEV
+ must point to the platform specific "dev" jar that ships with the
+ version of GWT you have.</para>
<para>How to launch from Eclipse: unit tests can be launched, as normal
- (in which case only M2_REPO setup is needed, GWT does not need to be downloaded seperately), or it can be launched it in <emphasis>hosted mode</emphasis> using
- the GWT browser, which is great for debugging (from GUI to back end, the code can be stepped through, and changes made on the fly and simply hit
- refresh). There is a <filename>JBRMS.launch</filename> file in in the drools-jbrms directory.
- To launch the JBRMS in debug mode, open the
- Run dialog (Run->Run), and then choose <emphasis>JBRMS</emphasis> from the list.
+ (in which case only M2_REPO setup is needed, GWT does not need to be
+ downloaded seperately), or it can be launched it in <emphasis>hosted
+ mode</emphasis> using the GWT browser, which is great for debugging
+ (from GUI to back end, the code can be stepped through, and changes made
+ on the fly and simply hit refresh). There is a
+ <filename>Guvnor.launch</filename> file in in the drools-jbrms
+ directory. To launch Guvnor in debug mode, open the Run dialog
+ (Run->Run), and then choose <emphasis>JBRMS</emphasis> from the list.
Launching this will open a new window, with the BRMS in debug mode,
ready to go</para>
<para>Normally</para>
- <para>Downloading and debugging the BRMS with GWT is optional, so if there are no GUI issues being worked on then this step can be safely skipped.</para>
+ <para>Downloading and debugging the BRMS with GWT is optional, so if
+ there are no GUI issues being worked on then this step can be safely
+ skipped.</para>
</section>
</section>
@@ -119,55 +136,56 @@
<para>The BRMS uses a service interface to separate the GUI from the back
end functionality. In this case the back end both includes the asset
repository (drools-repository and JCR) as well as the compiler specifics
- to deal with rules. </para>
+ to deal with rules.</para>
<para>The main interface is RepositoryService, which is implemented in
ServiceImplementation. The GWT ajax front end talks to this interface (via
- the asynchrony callback mechanism that GWT uses). The seam configuration file
- is <filename>components.xml</filename> (consult Seam documentation, and the components.xml file
- for details).</para>
+ the asynchrony callback mechanism that GWT uses). The seam configuration
+ file is <filename>components.xml</filename> (consult Seam documentation,
+ and the components.xml file for details).</para>
<para>This service interface may be re-used by alternative components or
front ends.</para>
- <para>The GWT user interface may be re-used, as it is GWT is only
- one html page: <filename>JBRMS.html</filename>. For those familiar with GWT, each of the
- <emphasis>features</emphasis> can be used separate (eg in a portal), look at the
- <classname>JBRMSFeature</classname> class and the classes that implement it (they can in theory
- be stand alone).</para>
+ <para>The GWT user interface may be re-used, as it is GWT is only one html
+ page: <filename>Guvnor.html</filename>. </para>
- <para>Normally the BRMS is intended to be deployed as its own war, however
- it can be combined with another application (with some care), but it is easier to keep it as a separate war. Deploying the BRMS by itself will also make it easier
- to upgrade to newer releases as they come out.</para>
-
- <para>The <filename>JBRMS.html</filename> file can be customized. For example to change logos or embed
- the BRMS in another page. Take a look at the <filename>JBRMS.html</filename> file for details.
- </para>
+ <para>Normally Guvnor is intended to be deployed as its own war, however
+ it can be combined with another application (with some care), but it is
+ easier to keep it as a separate war. Deploying Guvnor by itself will also
+ make it easier to upgrade to newer releases as they come out (and is
+ recommended).</para>
+
+ <para>The <filename>JBRMS.html</filename> file can be customized. For
+ example to change logos or embed the BRMS in another page. Take a look at
+ the <filename>Guvnor.html</filename> file for details.</para>
</section>
<section>
<title>Versioning and Storage</title>
- <para>The User Guide, Admin Section covers configuration options in some detail, for
- database and filesystems.</para>
+ <para>The User Guide, Admin Section covers configuration options in some
+ detail, for database and filesystems.</para>
- <para>Versions of assets are stored in the database along with the data.
- </para>
+ <para>Versions of assets are stored in the database along with the
+ data.</para>
- <para>When <emphasis>snapshots</emphasis> are created, copies are made of the entire package
- into a separate location in the JCR database. </para>
+ <para>When <emphasis>snapshots</emphasis> are created, copies are made of
+ the entire package into a separate location in the JCR database.</para>
- <para>For those familiar with jcr and jackrabbit, the *.cnd files are in the source for the node type definitions as some wish to view these. In a nutshell, a
- package is a <emphasis>folder</emphasis> and each asset is a file: an asset can either be
- textual or have a binary attachment.</para>
+ <para>For those familiar with jcr and jackrabbit, the *.cnd files are in
+ the source for the node type definitions as some wish to view these. In a
+ nutshell, a package is a <emphasis>folder</emphasis> and each asset is a
+ file: an asset can either be textual or have a binary attachment.</para>
</section>
<section>
<title>Contributing</title>
- <para>As an open source project, contributions from the wider community are encouraged. In order to contribute consult the wiki and project home pages. A useful way to contribute is via logging issues or feature
- requests in JIRA. However, when creating an issue in JIRA for the
- BRMS, it is important to choose <emphasis>drools-brms</emphasis> as the component in
- the list in JIRA (or else it may become lost)</para>
+ <para>As an open source project, contributions from the wider community
+ are encouraged. In order to contribute consult the wiki and project home
+ pages. A useful way to contribute is via logging issues or feature
+ requests in JIRA. The JIRA link to use is:
+ https://jira.jboss.org/jira/browse/GUVNOR</para>
</section>
</section>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-ExamplesAndTutorials.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-ExamplesAndTutorials.xml 2009-01-27 06:07:43 UTC (rev 24938)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-ExamplesAndTutorials.xml 2009-01-27 07:29:02 UTC (rev 24939)
@@ -1,109 +1,32 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <section version="5.0" xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook" xml:base="../../">
- <title>Examples and tutorials</title>
-
- <section>
- <title>Discount insurance brokers</title>
-
- <section>
- <title>Quick Start demo</title>
-
- <para>Fernando runs a dodgy fly by night insurance operation in Sao
- Paulo, Brasil. These are his rules - would you buy insurance from him ?
- (I wouldn't).</para>
-
- <para>This example takes you through the key steps in using the BRMS
- with an example repository, and using rules in a very very simple
- application (which you can use as a basis for your applications).</para>
-
- <itemizedlist>
- <listitem>
- <para>Download the latest version of BRMS from
- http://cruisecontrol.jboss.com/cc/artifacts/jboss-rules</para>
-
- <para>Deploy BRMS WAR file into JBoss4.2 AS or JBossWeb, other
- containers can be used as well (possibly with some tweaking of
- dependencies).</para>
-
- <para>Check you can access and run the BRMS.</para>
- </listitem>
-
- <listitem>
- <para>Check out the demo project from the Drools subversion
- repository (this will be included in future distributions):</para>
-
- <para>http://anonsvn.labs.jboss.com/labs/jbossrules/trunk/drools-examples/drools-examples-brms/</para>
- </listitem>
-
- <listitem>
- <para>Import the demo business rules insurance repository file into
- BRMS, the compressed can be found at "files" folder in the demo
- project.</para>
-
- <para>To do this, open the "files" directory, unzip the file there
- locally, and then go to the "Admin" section and "Manage backups" of
- the BRMS, select the file, and press "Import" - follow
- instructions.</para>
- </listitem>
-
- <listitem>
- <para>Navigate through the BRMS web application to see how things
- are placed and organized and try to create some rules.</para>
-
- <para>Go to the "Packages" feature and build the package (you should
- see no errors).</para>
- </listitem>
-
- <listitem>
- <para>Now go to the "Deployment" feature, when you click on the
- package, it will show you one snapshot (which was part of the
- import, you can create more if you like from the previous
- step).</para>
-
- <para>Open a snapshot.</para>
-
- <para>Copy the snapshot url that is displayed.</para>
-
- <para>Locate the file brmsdeployedrules.properties</para>
-
- <para>Place the copied URL in the brmsdeployedrules.properties
- file.</para>
- </listitem>
-
- <listitem>
- <para>OPTIONAL: To use a file or directory deployment in the rule
- agent just update brmsdeployedrules.properties according the
- documentation.</para>
- </listitem>
-
- <listitem>
- <para>Import the example project into eclipse and execute the
- MainClass. The program will show the following trace (and away you
- go !).</para>
-
- <programlisting>
-RuleAgent(insuranceconfig) INFO (Thu Jul 12 20:06:02 BRT 2007): Configuring with newInstance=true, secondsToRefresh=30
-RuleAgent(insuranceconfig) INFO (Thu Jul 12 20:06:02 BRT 2007): Configuring package provider : URLScanner monitoring URLs: http://localhost:8080/drools-jbrms/org.drools.brms.JBRMS/package/org.acme.insurance/fmeyer With local cache dir of /Users/fernandomeyer/projects/jbossrules/drools-examples/drools-examples-brms/cache
-RuleAgent(insuranceconfig) INFO (Thu Jul 12 20:06:02 BRT 2007): Applying changes to the rulebase.
-RuleAgent(insuranceconfig) INFO (Thu Jul 12 20:06:02 BRT 2007): Creating a new rulebase as per settings.
-RuleAgent(insuranceconfig) INFO (Thu Jul 12 20:06:02 BRT 2007): Adding package called org.acme.insurance
-APPROVED: due to no objections.
-APPROVED: Driver is safe and mature.
-APPROVED: due to no objections.
-REJECTED: Too many accidents
-</programlisting>
-
- <para>The Rule Agent will pick up any changes that happen
- automatically - as soon as you create a new snapshot of the rules
- you want to deploy.</para>
- </listitem>
- </itemizedlist>
- </section>
- </section>
-</section>
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xml:base="../../" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>Examples and tutorials</title>
+
+ <section>
+ <title>Quick Demos</title>
+
+ <section>
+ <title>Quick Start demo</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>As part of your download, you should have an examples
+ directory - in the drools-examples-brms director. Under that there
+ will be an "advertising example" and a "mortage example" - in both
+ cases there is an XML file you can import into the repository (it
+ will replace any content in your current repository - be aware). In
+ the case of the mortage example, it has some notes on how to "use"
+ it (from the client side) - in all cases you should be able to run
+ the scenarios (in some cases some "failures" are deliberate left in
+ as an example of how you test it - play around !). </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+</section>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-Introduction.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-Introduction.xml 2009-01-27 06:07:43 UTC (rev 24938)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-Introduction.xml 2009-01-27 07:29:02 UTC (rev 24939)
@@ -1,109 +1,114 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <section version="5.0" xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook" xml:base="../../">
- <title>Introduction</title>
-
- <para>This section introduces the BRMS. See the other relevant sections for
- installation, usage and administration.</para>
-
- <figure>
- <title>The BRMS main screen</title>
-
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/NewMainScreen.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
-
- <section>
- <title>What is a BRMS?</title>
-
- <para>BRMS stands for Business Rules Management System.</para>
-
- <para>This is the component of JBoss Rules which covers rule management,
- storage, editing and deployment. A Web based user interface is provided so
- this tool can be used by people who don't work in IDEs or text editors,
- but it is intended for a wide audience.</para>
-
- <para>A BRMS allows people to manage rules in a multi user environment, it
- is a single point of truth for your business rules, allowing change in a
- controlled fashion, with user friendly interfaces.</para>
-
- <section>
- <title>When to use a BRMS</title>
-
- <para>You should consider a BRMS if any of the following apply to you:
- You need to manage versions/deployment of rules, you need to let
- multiple users of different skill levels access and edit rules, you
- don't have any existing infrastructure to manage rules, you have lots of
- "business" rules (as opposed to technical rules as part of an
- application). </para>
-
- <para>A BRMS can be used on its own, or with the IDE tooling (often both
- together). </para>
-
- <para>A BRMS can be "branded" and made part of your application, or it
- can be a central rule repository.</para>
-
- <section>
- <title>When to not use a BRMS</title>
-
- <para>In some situations applications may exist which have
- the rules in a database (for instance as part of an existing application),
- and no new application is needed to manage the rules. </para>
-
- <para>Otherwise, perhaps an existing rule management system and user interface
- already exists (and is tailored to your environment already) - in this
- case migrating to the BRMS may not be necessary.</para>
-
- <para>If you are using rules to solve complex algorithmic problems,
- and the rules are essentially an integral part of the application (and
- don't need to be managed separately to the code).</para>
- </section>
- </section>
-
- <section>
- <title>Who uses a BRMS</title>
-
- <para>The main roles of people who would use a BRMS are: Business
- Analyst, Rule expert, Developer, Administrators (rule administrators etc).
- </para>
-
- <para>The BRMS is designed in such a way as these different roles can be
- accommodated, it can be controlled how much is exposed to different users in a safe fashion.</para>
- </section>
- </section>
-
- <section>
- <title>Features outline</title>
-
- <itemizedlist>
- <listitem>
- <para>Multiple types of rule editors (GUI, text)</para>
- </listitem>
- <listitem>
- <para>Version control (historical assets)</para>
- </listitem>
- <listitem>
- <para>Categorization</para>
- </listitem>
- <listitem>
- <para>Build and deploy</para>
- </listitem>
- <listitem>
- <para>Store multiple rule "assets" together as a package</para>
- </listitem>
-
-
-
-
- </itemizedlist>
- </section>
-</section>
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xml:base="../../" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>Introduction</title>
+
+ <para>This section introduces the BRMS. See the other relevant sections for
+ installation, usage and administration.</para>
+
+ <figure>
+ <title>The BRMS main screen</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/NewMainScreen.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section>
+ <title>What is a BRMS?</title>
+
+ <para>BRMS stands for Business Rules Management System.</para>
+
+ <para>A BRMS allows people to manage rules in a multi user environment, it
+ is a single point of truth for your business rules, allowing change in a
+ controlled fashion, with user friendly interfaces.</para>
+
+ <para>Guvnor is the name of the web and network related components for
+ managing rules with drools. This combined with the core drools engine and
+ other tools forms "a BRMS". </para>
+
+ <section>
+ <title>When to use Guvnor</title>
+
+ <para>You should consider Guvnor if any of the following apply to you:
+ You need to manage versions/deployment of rules, you need to let
+ multiple users of different skill levels access and edit rules, you
+ don't have any existing infrastructure to manage rules, you have lots of
+ "business" rules (as opposed to technical rules as part of an
+ application).</para>
+
+ <para>Guvnor can be used on its own, or with the IDE tooling (often both
+ together).</para>
+
+ <para>Guvnor can be "branded" and made part of your application, or it
+ can be a central rule repository.</para>
+
+ <section>
+ <title>When to not use Guvnor</title>
+
+ <para>In some situations applications may exist which have the rules
+ in a database (for instance as part of an existing application), and
+ no new application is needed to manage the rules.</para>
+
+ <para>In this case, the drools-template library is worth a look - you
+ can define templates for rules to be generated from any tablular data
+ source.</para>
+
+ <para>Otherwise, perhaps an existing rule management system and user
+ interface already exists (and is tailored to your environment already)
+ - in this case migrating to Guvnor may not be necessary.</para>
+
+ <para>If you are using rules to solve complex algorithmic problems,
+ and the rules are essentially an integral part of the application (and
+ don't need to be managed separately to the code).</para>
+ </section>
+ </section>
+
+ <section>
+ <title>Who uses Guvnor</title>
+
+ <para>The main roles of people who would use a BRMS are: Business
+ Analyst, Rule expert, Developer, Administrators (rule administrators
+ etc).</para>
+
+ <para>Guvnor is designed in such a way as these different roles can be
+ accommodated, it can be controlled how much is exposed to different
+ users in a safe fashion.</para>
+ </section>
+ </section>
+
+ <section>
+ <title>Features outline</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Multiple types of rule editors (GUI, text)</para>
+ </listitem>
+
+ <listitem>
+ <para>Version control (historical assets)</para>
+ </listitem>
+
+ <listitem>
+ <para>Categorization</para>
+ </listitem>
+
+ <listitem>
+ <para>Build and deploy</para>
+ </listitem>
+
+ <listitem>
+ <para>Store multiple rule "assets" together as a package</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+</section>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-UserGuide.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-UserGuide.xml 2009-01-27 06:07:43 UTC (rev 24938)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-UserGuide.xml 2009-01-27 07:29:02 UTC (rev 24939)
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
-<section version="5.0" xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook" xml:base="../../">
+<section version="5.0" xml:base="../../" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
<title>Quick start guide</title>
<section>
@@ -28,8 +28,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/Features.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/Features.png" format="PNG"
+ scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -79,8 +80,14 @@
<section>
<title>BRMS or Guvnor?</title>
- <para>In previous versions of Drools "BRMS" was often used to refer to the web interface to the drools management features. Nowadays we use BRMS to refer to the "whole package" - the runtime, the web tools and so on - but in some cases you can read "BRMS" as meaning the Guvnor web console and associated tools.</para>
+
+ <para>In previous versions of Drools "BRMS" was often used to refer to
+ the web interface to the drools management features. Nowadays we use
+ BRMS to refer to the "whole package" - the runtime, the web tools and so
+ on - but in some cases you can read "BRMS" as meaning the Guvnor web
+ console and associated tools.</para>
</section>
+
<section>
<title>Initial configuration</title>
@@ -250,8 +257,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/CatZoom.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/CatZoom.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -276,8 +284,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/CatEdit.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/CatEdit.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -309,8 +318,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/AdminCats.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/AdminCats.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -338,8 +348,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/AssetEditor.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/AssetEditor.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -450,8 +461,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/GuidedEditor.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/GuidedEditor.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -532,8 +544,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EnumDropDown.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EnumDropDown.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -571,8 +584,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/GuidedDSL.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/GuidedDSL.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -586,8 +600,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/GuidedComplex.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/GuidedComplex.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -622,8 +637,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/GuidedLHSConstraints.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/GuidedLHSConstraints.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -652,8 +668,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/DSLRule.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/DSLRule.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -676,8 +693,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/DecisionTable.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/DecisionTable.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -701,8 +719,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/WebDT.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/WebDT.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -715,8 +734,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/WebDT-config.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/WebDT-config.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -761,8 +781,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/DRLRule.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/DRLRule.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -780,8 +801,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/Function.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/Function.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -808,8 +830,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EnumConfig.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EnumConfig.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -930,9 +953,9 @@
<section>
<title>Status management</title>
- <para>Each asset (and also package) in the BRMS has a status flag set.
- The values of the status flag are set in the Administration section of
- the BRMS. (you can add your own status names). Similar to Categories,
+ <para>Each asset (and also package) in Guvnor has a status flag set. The
+ values of the status flag are set in the Administration section of the
+ BRMS. (you can add your own status names). Similar to Categories,
Statuses do NOT effect the execution in any way, and are purely
informational. Unlike categories, assets only have one status AT A
TIME.</para>
@@ -946,8 +969,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/AssetChangeStatus.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/AssetChangeStatus.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -961,8 +985,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/PackageChangeStatus.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/PackageChangeStatus.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -993,8 +1018,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/PackageExplorer.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/PackageExplorer.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>The above picture shows the package explorer. Clicking on an
@@ -1048,8 +1074,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/PackageNewItemTooltip.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/PackageNewItemTooltip.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure> From the package explorer you can create new rules, or new
@@ -1063,8 +1090,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/PackageConfig.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/PackageConfig.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>One of the most critical things you need to do is configure
@@ -1080,8 +1108,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/PackageBuild.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/PackageBuild.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>Finally you would "build" a package. Any errors caught are
@@ -1124,8 +1153,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/AssetVersionHistory.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/AssetVersionHistory.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1161,8 +1191,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/Snapshots.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/Snapshots.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1189,8 +1220,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/CategoryExplorer.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/CategoryExplorer.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1210,8 +1242,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/PackageExplorer.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/PackageExplorer.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1223,10 +1256,15 @@
<section>
<title>Creating a business user view</title>
- <para>
- In most cases not all users will want to see all the functionality described here. You could have a subset of users who you only want to let view or edit certain sets of rules, without getting confused by all the other stuff.
-In this case you can use fine grained authorization (see the Admin Guide on how to initialize this). By setting permissions on a per category basis, users that only have category permissions will see a limited subset of functionality, and only items that are tagged with those categories.
- </para>
+
+ <para>In most cases not all users will want to see all the functionality
+ described here. You could have a subset of users who you only want to let
+ view or edit certain sets of rules, without getting confused by all the
+ other stuff. In this case you can use fine grained authorization (see the
+ Admin Guide on how to initialize this). By setting permissions on a per
+ category basis, users that only have category permissions will see a
+ limited subset of functionality, and only items that are tagged with those
+ categories.</para>
</section>
<section>
@@ -1246,8 +1284,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/ModelChooseType.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/ModelChooseType.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1263,8 +1302,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/ModelEdit.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/ModelEdit.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1278,8 +1318,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/ModelChooseFieldType.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/ModelChooseFieldType.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1309,17 +1350,17 @@
reinforces the fact that the model "belongs" to the rulebase, rather then
the application, and allows the model to have a lifecycle separate from
the application. It also removed the hassle of keeping jar files in sync
- between rules and the applications that use the rules. </para>
+ between rules and the applications that use the rules.</para>
</section>
<section>
<title>The business user perspective</title>
<para>You can see from this manual, that some expertise and practice is
- required to use Guvnor. In fact any software system in some sense
- requires that people be "technical" even if it has a nice looking GUI.
- Having said that, in the right hands Guvnor can be setup to provide a
- suitable environment for non technical users.</para>
+ required to use Guvnor. In fact any software system in some sense requires
+ that people be "technical" even if it has a nice looking GUI. Having said
+ that, in the right hands Guvnor can be setup to provide a suitable
+ environment for non technical users.</para>
<para>The most appropriate rule formats for this use are using the Guided
editor, Decision tables and DSL rules. You can use some DSL expressions
@@ -1342,9 +1383,13 @@
<section>
<title>Advanced config options in a rule package</title>
- <para>As drools supports various configuration options for a package (such as adding functions for "accumulate" etc), this can be done by adding a X.package or X.conf file to the package - files which contain name/value pairs in the "properties" style. These will then be automatically added to the package configuration. See the main drools documentation for all the things you can do.
- </para>
-
+
+ <para>As drools supports various configuration options for a package (such
+ as adding functions for "accumulate" etc), this can be done by adding a
+ X.package or X.conf file to the package - files which contain name/value
+ pairs in the "properties" style. These will then be automatically added to
+ the package configuration. See the main drools documentation for all the
+ things you can do.</para>
</section>
<section>
@@ -1438,9 +1483,9 @@
<para>file</para>
<para>This is a space-separated list of files - each file is a
- binary package as exported by Guvnor. You can have one or many.
- The name of the file is not important. Each package must be in its
- own file.</para>
+ binary package as exported by Guvnor. You can have one or many. The
+ name of the file is not important. Each package must be in its own
+ file.</para>
<para>NOTE: it is also possible to specify .drl files - and it will
compile it into the package. However, note that for this to work,
@@ -1478,9 +1523,9 @@
<para>localCacheDir</para>
<para>This is used in conjunction with the url above, so that if the
- Guvnor is down (the url is not accessible) then if the runtime has to
- start up, it can start up with the last known "good" versions of the
- packages.</para>
+ Guvnor is down (the url is not accessible) then if the runtime has
+ to start up, it can start up with the last known "good" versions of
+ the packages.</para>
</listitem>
<listitem>
@@ -1507,8 +1552,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/SnapshotDeploy.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/SnapshotDeploy.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1553,8 +1599,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/running_execution_server.png"
- format="PNG" scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/running_execution_server.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
@@ -1788,8 +1835,9 @@
<mediaobject>
<imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/WebDAVWindows.png" format="PNG"
- scalefit="1" />
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/WebDAVWindows.png"
+ format="PNG" scalefit="1"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1823,498 +1871,642 @@
<section>
<title>Eclipse Guvnor integration</title>
- <para>The Eclipse Guvnor tools (EGT) provide the ability to push/pull artifacts from the Guvnor repository server and the developers workspace in eclipse.
-It is therefore possible for artifacts to be both managed via Guvnor as well as in traditional developer friendly SCM systems (such as subversion).
+ <para>The Eclipse Guvnor tools (EGT) provide the ability to push/pull
+ artifacts from the Guvnor repository server and the developers workspace
+ in eclipse. It is therefore possible for artifacts to be both managed via
+ Guvnor as well as in traditional developer friendly SCM systems (such as
+ subversion). The Guvnor repository is not intended as a Source Code
+ Management (SCM) solution, and the EGT are not intended to be Eclipse
+ “team provider” extensions or replacements. 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 EGT 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 EGT.</para>
-The Guvnor repository is not intended as a Source Code Management (SCM) solution, and the EGT are not intended to be Eclipse “team provider” extensions or replacements. 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 EGT 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 EGT. </para>
-
-
-
-
<section>
<title>Source Code and Plug-in Details</title>
- <para>
-The source code for the EGT is available at:
-<code>
-http://anonsvn.jboss.org/repos/labs/labs/jbossrules/trunk/drools-eclipse/
-</code>
-
-EGT consist of two plug-ins:
-org.guvnor.tools
-org.eclipse.webdav
-and requires Eclipse 3.3.x. The current Eclipse Drools plug-ins are also useful for viewing Guvnor repository resources such as rule definitions, but not required for operation of the EGT.
- </para>
+ <para>The source code for the EGT is available at: <code>
+ http://anonsvn.jboss.org/repos/labs/labs/jbossrules/trunk/drools-eclipse/
+ </code> EGT consist of two plug-ins: org.guvnor.tools org.eclipse.webdav
+ and requires Eclipse 3.3.x. The current Eclipse Drools plug-ins are also
+ useful for viewing Guvnor repository resources such as rule definitions,
+ but not required for operation of the EGT.</para>
</section>
-
<section>
<title>Functionality Overview</title>
- <para>
- Views and Perspective:
-The EGT contains two views – Repository Explorer and Version History – that will be the center of most interaction with Guvnor. Eclipse standard views such as Properties and the Resource Navigator are also useful. While each of these views can be opened and positioned independently within an Eclipse workbench, the Guvnor perspective provides a convenient method of getting a suggested layout. In the Eclipse workbench menu, choose Window, Open Perspective, Other to get the perspective list:
- </para>
+ <para>Views and Perspective: The EGT contains two views – Repository
+ Explorer and Version History – that will be the center of most
+ interaction with Guvnor. Eclipse standard views such as Properties and
+ the Resource Navigator are also useful. While each of these views can be
+ opened and positioned independently within an Eclipse workbench, the
+ Guvnor perspective provides a convenient method of getting a suggested
+ layout. In the Eclipse workbench menu, choose Window, Open Perspective,
+ Other to get the perspective list:</para>
- <figure>
- <title>Views and perspectives</title>
+ <figure>
+ <title>Views and perspectives</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT1.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
-
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/Chapter-Guvnor/EGT1.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>and then choose “Guvnor Repository Exploring.” This opens the Guvnor perspective:</para>
+ <para>and then choose “Guvnor Repository Exploring.” This opens the
+ Guvnor perspective:</para>
- <figure>
- <title>Views and perspectives</title>
+ <figure>
+ <title>Views and perspectives</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT2.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/Chapter-Guvnor/EGT2.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>
- On the left side is the Guvnor Repository Explorer and the Eclipse Properties views, the Guvnor Resource History view is on the bottom, and the Eclipse Resource Navigator is on the right side. The purpose of the Guvnor Repository Explorer is to enable access to Guvnor repository resources in a standard tree format, and the Guvnor Resource History view shows revisions of specific resources available in the repository.
- </para>
-
+ <para>On the left side is the Guvnor Repository Explorer and the Eclipse
+ Properties views, the Guvnor Resource History view is on the bottom, and
+ the Eclipse Resource Navigator is on the right side. The purpose of the
+ Guvnor Repository Explorer is to enable access to Guvnor repository
+ resources in a standard tree format, and the Guvnor Resource History
+ view shows revisions of specific resources available in the
+ repository.</para>
</section>
<section>
<title>Guvnor Connection Wizard</title>
- <para>
-After opening the Guvnor perspective, the first task is to make a connection to a Guvnor repository. This is handled by the Guvnor Connection wizard. This wizard appears in a number of places within the EGT (as detailed below), but in this section we will cover only the two most basic entry points.
-The Guvnor Connection wizard can be started using the Eclipse menu: File , New , Other , Guvnor , Guvnor repository location, or in the Guvnor Explorer using the drop-down menu:
- </para>
- <figure>
- <title>Connection wizard</title>
+ <para>After opening the Guvnor perspective, the first task is to make a
+ connection to a Guvnor repository. This is handled by the Guvnor
+ Connection wizard. This wizard appears in a number of places within the
+ EGT (as detailed below), but in this section we will cover only the two
+ most basic entry points. The Guvnor Connection wizard can be started
+ using the Eclipse menu: File , New , Other , Guvnor , Guvnor repository
+ location, or in the Guvnor Explorer using the drop-down menu:</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT3.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Connection wizard</title>
- <para>
- or the menu button:
- </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/Chapter-Guvnor/EGT3.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Connection wizard</title>
+ <para>or the menu button:</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT4.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Connection wizard</title>
- <para>Choosing either of these will start the Guvnor connection wizard:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/Chapter-Guvnor/EGT4.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Connection wizard</title>
+ <para>Choosing either of these will start the Guvnor connection
+ wizard:</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT5.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Connection wizard</title>
- <para>
-Default values appear in the Location, Port, and Repository fields. (See the “Guvnor Preferences” section below for details about how to change these default values.) Of course, any of these fields can be edited by typing in the corresponding text box. Drag-and-drop or paste into the Location field of a typical Guvnor repository URL such as:
-<code>http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</code>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/Chapter-Guvnor/EGT5.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
-Results in the URL being parsed into the respective fields as well. The authentication information (user name and password) can optionally be stored in the Eclipse workbench's key-ring file based on the selection of "Save user name and password." If the authentication information is not stored in the key-ring, then the EGT uses session authentication, which means that the credentials supplied are used only for the lifetime of the Eclipse workbench instance.
- </para>
+ <para>Default values appear in the Location, Port, and Repository
+ fields. (See the “Guvnor Preferences” section below for details about
+ how to change these default values.) Of course, any of these fields can
+ be edited by typing in the corresponding text box. Drag-and-drop or
+ paste into the Location field of a typical Guvnor repository URL such
+ as:
+ <code>http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</code>
+ Results in the URL being parsed into the respective fields as well. The
+ authentication information (user name and password) can optionally be
+ stored in the Eclipse workbench's key-ring file based on the selection
+ of "Save user name and password." If the authentication information is
+ not stored in the key-ring, then the EGT uses session authentication,
+ which means that the credentials supplied are used only for the lifetime
+ of the Eclipse workbench instance.</para>
- <para>
- If authentication information is not stored in the key-ring or the authentication information (key-ring or session) is not valid, the EGT will prompt for authentication information when it has to access the Guvnor repository:
- </para>
+ <para>If authentication information is not stored in the key-ring or the
+ authentication information (key-ring or session) is not valid, the EGT
+ will prompt for authentication information when it has to access the
+ Guvnor repository:</para>
- <figure>
- <title>Login</title>
+ <figure>
+ <title>Login</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT6.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/Chapter-Guvnor/EGT6.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>
-If authentication fails, the EGT will retry once and then issue an authentication failure error. (If an authentication failure error occurs, you can retry the same operation and supply different authentication information.)
-Note that the EGT calls the Guvnor repository at various times, such as when determining if resource updates are available, so, if you use session authentication, the authentication dialog will appear at different times during the Eclipse workbench session, depending on what actions you take. For ease of use, we recommend saving the authentication information in the Eclipse key-ring. (The Eclipse key-ring file is distinct from key-ring files found in some platforms such as Mac OS X and many forms of Linux. Thus, sometimes if you access a Guvnor repository outside the EGT, the key-ring files might become unsynchronized and you will be unexpectedly prompted for authentication in Eclipse. This is nuisance, but your usual credentials should apply in this case.)
- </para>
+ <para>If authentication fails, the EGT will retry once and then issue an
+ authentication failure error. (If an authentication failure error
+ occurs, you can retry the same operation and supply different
+ authentication information.) Note that the EGT calls the Guvnor
+ repository at various times, such as when determining if resource
+ updates are available, so, if you use session authentication, the
+ authentication dialog will appear at different times during the Eclipse
+ workbench session, depending on what actions you take. For ease of use,
+ we recommend saving the authentication information in the Eclipse
+ key-ring. (The Eclipse key-ring file is distinct from key-ring files
+ found in some platforms such as Mac OS X and many forms of Linux. Thus,
+ sometimes if you access a Guvnor repository outside the EGT, the
+ key-ring files might become unsynchronized and you will be unexpectedly
+ prompted for authentication in Eclipse. This is nuisance, but your usual
+ credentials should apply in this case.)</para>
- <para>
-Once the Guvnor connection wizard is complete, the new Guvnor repository connection will appear in the Guvnor Repository Explorer. You can then expand the tree to view Guvnor repository contents.
-
- </para>
+ <para>Once the Guvnor connection wizard is complete, the new Guvnor
+ repository connection will appear in the Guvnor Repository Explorer. You
+ can then expand the tree to view Guvnor repository contents.</para>
</section>
-
<section>
<title>Guvnor Repository Explorer</title>
-
- <figure>
- <title>Explorer</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT7.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Explorer</title>
- <para>
-The Guvnor Repository Explorer view contains tree structures for Guvnor repository contents. As described above, there are menu and tool-bar actions for creating Guvnor repository connections. The red “X” in the tool-bar and “Delete” in the menu removes a Guvnor repository connection, and the “Refresh” menu item reloads tree content for the selected node. Finally, there are a number of tool-bar/menu items in support of “drill-into” functionality: one the tool-bar these are represented by the house (“return to top level/home”) and the arrows (go into/back). Drill-down is useful when working with deeply nested tree structures and when you wish to concentrate on only branch of the tree. For example, drilling into the “defaultPackage” node shown above changes the tree view to:
- </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/Chapter-Guvnor/EGT7.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Explorer</title>
+ <para>The Guvnor Repository Explorer view contains tree structures for
+ Guvnor repository contents. As described above, there are menu and
+ tool-bar actions for creating Guvnor repository connections. The red “X”
+ in the tool-bar and “Delete” in the menu removes a Guvnor repository
+ connection, and the “Refresh” menu item reloads tree content for the
+ selected node. Finally, there are a number of tool-bar/menu items in
+ support of “drill-into” functionality: one the tool-bar these are
+ represented by the house (“return to top level/home”) and the arrows (go
+ into/back). Drill-down is useful when working with deeply nested tree
+ structures and when you wish to concentrate on only branch of the tree.
+ For example, drilling into the “defaultPackage” node shown above changes
+ the tree view to:</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT8.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Explorer</title>
- <para>
-That is, we see only the contents of “defaultPackage” in the tree. Clicking on the house button, or selecting “Go Home” returns the tree to the top-level structure shown in the previous picture above.
- </para>
- <para>
-There are a number of operations that can be performed on Guvnor repository files. Selecting a file in the Guvnor repository causes the Eclipse Properties view to update with details about that file:
- </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/Chapter-Guvnor/EGT8.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Properties</title>
+ <para>That is, we see only the contents of “defaultPackage” in the tree.
+ Clicking on the house button, or selecting “Go Home” returns the tree to
+ the top-level structure shown in the previous picture above.</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT9.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <para>There are a number of operations that can be performed on Guvnor
+ repository files. Selecting a file in the Guvnor repository causes the
+ Eclipse Properties view to update with details about that file:</para>
- <para>
- Double-clicking on a folder (directory) in the tree will cause that folder to expand if collapsed and collapse if expanded. Double-clicking on a file in the tree will cause a read-only editor in Eclipse to open, showing the contents of that file:
- </para>
+ <figure>
+ <title>Properties</title>
- <figure>
- <title>Comments</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/Chapter-Guvnor/EGT9.png"
+ format="PNG" scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT10.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <para>Double-clicking on a folder (directory) in the tree will cause
+ that folder to expand if collapsed and collapse if expanded.
+ Double-clicking on a file in the tree will cause a read-only editor in
+ Eclipse to open, showing the contents of that file:</para>
- <para>
- Dragging a file from the Guvnor repository tree to a folder in an Eclipse local project (for example in the Eclipse Resource Navigator view) will cause a copy of that file to be made in the local Eclipse workspace. (Note: You can also “Save As...” when a file is open in a read-only editor to save a local writable copy of the contents. Doing so, however, will not associate the file created with its Guvnor source.)
+ <figure>
+ <title>Comments</title>
-Finally, you can view the revision history of a file selected in the tree using the “Show History” context menu item. (The details of resource history will be discussed below.)
- </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT10.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Dragging a file from the Guvnor repository tree to a folder in an
+ Eclipse local project (for example in the Eclipse Resource Navigator
+ view) will cause a copy of that file to be made in the local Eclipse
+ workspace. (Note: You can also “Save As...” when a file is open in a
+ read-only editor to save a local writable copy of the contents. Doing
+ so, however, will not associate the file created with its Guvnor
+ source.) Finally, you can view the revision history of a file selected
+ in the tree using the “Show History” context menu item. (The details of
+ resource history will be discussed below.)</para>
</section>
-
<section>
<title>Local Copies of Guvnor Files</title>
- <para>
-As mentioned in the Introduction, the main purpose of the EGT is to allow development using resources held in a Guvnor repository. There are two method of getting local copies of Guvnor repository resources:
- </para>
- <para>1. Drag-and-drop from the Guvnor Repository Explorer, as described above.</para>
- <para>2. Using the “import from Guvnor” wizard, as described below.</para>
+ <para>As mentioned in the Introduction, the main purpose of the EGT is
+ to allow development using resources held in a Guvnor repository. There
+ are two method of getting local copies of Guvnor repository
+ resources:</para>
- <para>
- When local copies of Guvnor repository files are created, the EGT sets an association between the local copy and the master file in the repository. (This information is kept in the (normally) hidden “.guvnorinfo” folder in the local project and, like all metadata, should not be changed by end users.) This association allows for operations such as update and commit in synchronization with the master copy held in the Guvnor repository.
-The EGT decorates local resources associated with Guvnor repository master copies. This decoration appears in Eclipse views conforming to the Eclipse Common Navigator framework, such as the Eclipse Resource Navigator and the Java Package Explorer. The image below shows decoration in the Eclipse Resource Navigator:
- </para>
+ <para>1. Drag-and-drop from the Guvnor Repository Explorer, as described
+ above.</para>
- <figure>
- <title>Navigator</title>
+ <para>2. Using the “import from Guvnor” wizard, as described
+ below.</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT11.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <para>When local copies of Guvnor repository files are created, the EGT
+ sets an association between the local copy and the master file in the
+ repository. (This information is kept in the (normally) hidden
+ “.guvnorinfo” folder in the local project and, like all metadata, should
+ not be changed by end users.) This association allows for operations
+ such as update and commit in synchronization with the master copy held
+ in the Guvnor repository. The EGT decorates local resources associated
+ with Guvnor repository master copies. This decoration appears in Eclipse
+ views conforming to the Eclipse Common Navigator framework, such as the
+ Eclipse Resource Navigator and the Java Package Explorer. The image
+ below shows decoration in the Eclipse Resource Navigator:</para>
- <para>
-Note the Guvnor icon decorator on the top right of the file images, and the Guvnor revision details appended to the file names. (The presence/location of these can be changed. See “Guvnor Preferences” below for details.) Here we see that, for example, “simpleRule.drl” is associated with a Guvnor repository resource and the local copy is based on revision 3, with a 7-15-2008, 15:37:34 date/time stamp. The file “deleteTest.txt,” however, is not associated with a Guvnor repository file. Further details about the association can be found in the standard Eclipse properties page, via the context menu “Properties” selection:
- </para>
+ <figure>
+ <title>Navigator</title>
- <figure>
- <title>Properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT11.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT12.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <para>Note the Guvnor icon decorator on the top right of the file
+ images, and the Guvnor revision details appended to the file names. (The
+ presence/location of these can be changed. See “Guvnor Preferences”
+ below for details.) Here we see that, for example, “simpleRule.drl” is
+ associated with a Guvnor repository resource and the local copy is based
+ on revision 3, with a 7-15-2008, 15:37:34 date/time stamp. The file
+ “deleteTest.txt,” however, is not associated with a Guvnor repository
+ file. Further details about the association can be found in the standard
+ Eclipse properties page, via the context menu “Properties”
+ selection:</para>
- <para>
-The EGT contributes a property page to the standard Eclipse properties dialog, the contents of which are shown above. The specific Guvnor repository, the location within the repository, the version (date/time stamp) and revision number are displayed.
- </para>
+ <figure>
+ <title>Properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT12.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The EGT contributes a property page to the standard Eclipse
+ properties dialog, the contents of which are shown above. The specific
+ Guvnor repository, the location within the repository, the version
+ (date/time stamp) and revision number are displayed.</para>
</section>
<section>
<title>Actions for Local Guvnor Resources</title>
- <para>
-The EGT provides a number of actions (available through the “Guvnor” context menu on files) for working with files, both those associated with Guvnor repository master copies and those not associated. The actions are:
-<code>
-1.Update
-2.Add
-3.Commit
-4.Show History
-5.Compare with Version
-6.Switch to Version
-7.Delete
-8.Disconnect
-</code>
-Each of these actions will be described below.
- </para>
+ <para>The EGT provides a number of actions (available through the
+ “Guvnor” context menu on files) for working with files, both those
+ associated with Guvnor repository master copies and those not
+ associated. The actions are: <code> 1.Update 2.Add 3.Commit 4.Show
+ History 5.Compare with Version 6.Switch to Version 7.Delete 8.Disconnect
+ </code> Each of these actions will be described below.</para>
<para>Update Action:</para>
- <para>
-The Update action is available for one or more Guvnor resources that are not in synchronization with the Guvnor repository master copies. These resources would not be in synchronization because either/both (1) there are local changes to these resources or (2) the master copies have changed in the Guvnor repository. Performing the Update action replaces the local file contents with the current contents from the Guvnor repository master copies (equivalent to “Switch to version” for latest version).
- </para>
+ <para>The Update action is available for one or more Guvnor resources
+ that are not in synchronization with the Guvnor repository master
+ copies. These resources would not be in synchronization because
+ either/both (1) there are local changes to these resources or (2) the
+ master copies have changed in the Guvnor repository. Performing the
+ Update action replaces the local file contents with the current contents
+ from the Guvnor repository master copies (equivalent to “Switch to
+ version” for latest version).</para>
+
<para>Add Action</para>
- <para>The Add action is available for one or more local files that are not associated with a Guvnor repository master copy. Choosing the Add action launches the “Add to Guvnor” wizard:</para>
- <figure>
- <title>Add action</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT13.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- The first page of the wizard asks for the selection of the target Guvnor repository and gives the choice to create a new Guvnor repository connection (in which case the second page is the same as the Guvnor Connection wizard described above). Once the target Guvnor repository is chosen, the wizard then asks for the folder location to add the selection files:
- </para>
-
- <figure>
- <title>Add action</title>
+ <para>The Add action is available for one or more local files that are
+ not associated with a Guvnor repository master copy. Choosing the Add
+ action launches the “Add to Guvnor” wizard:</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT14.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Add action</title>
- <para>Here I have selected the folder “anotherPackage” as the destination location1. Clicking on “Finish” adds the selected files to the Guvnor repository and creates an association between the local and Guvnor repository files. (Not that the wizard will not allow for overwrite of existing Guvnor repository files – another target location must be chosen.)</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT13.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The first page of the wizard asks for the selection of the target
+ Guvnor repository and gives the choice to create a new Guvnor repository
+ connection (in which case the second page is the same as the Guvnor
+ Connection wizard described above). Once the target Guvnor repository is
+ chosen, the wizard then asks for the folder location to add the
+ selection files:</para>
+ <figure>
+ <title>Add action</title>
- <para>Compare with Version Action:</para>
- <para>The Compare with Version action is enabled for one Guvnor repository associated file. This action first opens a wizard asking for the version for comparison (with the local file contents):
- </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT14.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Compare</title>
+ <para>Here I have selected the folder “anotherPackage” as the
+ destination location1. Clicking on “Finish” adds the selected files to
+ the Guvnor repository and creates an association between the local and
+ Guvnor repository files. (Not that the wizard will not allow for
+ overwrite of existing Guvnor repository files – another target location
+ must be chosen.)</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT15.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <para>Compare with Version Action:</para>
+ <para>The Compare with Version action is enabled for one Guvnor
+ repository associated file. This action first opens a wizard asking for
+ the version for comparison (with the local file contents):</para>
- <para>Once the revision is selected, the action opens the Eclipse compare editor (read-only):</para>
+ <figure>
+ <title>Compare</title>
- <figure>
- <title>Compare</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT15.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT16.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <para>Once the revision is selected, the action opens the Eclipse
+ compare editor (read-only):</para>
- <para>This editor uses Eclipse-standard comparison techniques to show the differences in the two versions. In cases where there are no differences, the editor will not open: rather, a dialog saying that there are no differences will appear.</para>
+ <figure>
+ <title>Compare</title>
- <para>Switch to Version Action:</para>
- <para>
- The Switch to Version action is enabled for one Guvnor repository associated file. First the Switch to Version action prompts for selection of version:
- </para>
-
- <figure>
- <title>Versions</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT16.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT17.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <para>This editor uses Eclipse-standard comparison techniques to show
+ the differences in the two versions. In cases where there are no
+ differences, the editor will not open: rather, a dialog saying that
+ there are no differences will appear.</para>
- <para>Once the version is selected, the Switch to Version action replaces the local file contents with those from the revision selected.</para>
+ <para>Switch to Version Action:</para>
- <para>Delete Action:</para>
- <para>The Delete action is enabled for one or more Guvnor repository associated files. After confirmation via a dialog, the Delete action removes the files in the Guvnor repository and deletes local metadata for the Guvnor repository association. </para>
- <para>Disconnect Action:</para>
- <para>The Disconnect action is enabled for one or more Guvnor repository associated files, and removes local metadata for the Guvnor repository association.</para>
- <para>Guvnor Resource History View:</para>
- <para>The Guvnor Resource History view should details about revision history for selected files, both local and those in Guvnor repositories. The initial state of this view is:</para>
+ <para>The Switch to Version action is enabled for one Guvnor repository
+ associated file. First the Switch to Version action prompts for
+ selection of version:</para>
- <figure>
- <title>History</title>
+ <figure>
+ <title>Versions</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT18.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT17.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>
-The Guvnor Resource History view is populated by “Show History” actions in either the local “Guvnor” context menu or in the context menu for a Guvnor repository file in the Guvnor Repository Explorer. Once this action is performed, the Guvnor Resource History view updates to show the revision history:
- </para>
-
- <figure>
- <title>History</title>
+ <para>Once the version is selected, the Switch to Version action
+ replaces the local file contents with those from the revision
+ selected.</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT19.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <para>Delete Action:</para>
- <para>Here we see that the file “simpleRule.drl” has three revisions. Double clicking on a revision row (or context menu “Open (Read only)”) opens an Eclipse read-only editor with the revision contents. (Note: You can also “Save As...” when a file is open in a read-only editor to save a local writable copy of the contents. Doing so, however, will not associate the file created with its Guvnor source.)</para>
+ <para>The Delete action is enabled for one or more Guvnor repository
+ associated files. After confirmation via a dialog, the Delete action
+ removes the files in the Guvnor repository and deletes local metadata
+ for the Guvnor repository association.</para>
+ <para>Disconnect Action:</para>
+ <para>The Disconnect action is enabled for one or more Guvnor repository
+ associated files, and removes local metadata for the Guvnor repository
+ association.</para>
+
+ <para>Guvnor Resource History View:</para>
+
+ <para>The Guvnor Resource History view should details about revision
+ history for selected files, both local and those in Guvnor repositories.
+ The initial state of this view is:</para>
+
+ <figure>
+ <title>History</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT18.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Guvnor Resource History view is populated by “Show History”
+ actions in either the local “Guvnor” context menu or in the context menu
+ for a Guvnor repository file in the Guvnor Repository Explorer. Once
+ this action is performed, the Guvnor Resource History view updates to
+ show the revision history:</para>
+
+ <figure>
+ <title>History</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT19.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Here we see that the file “simpleRule.drl” has three revisions.
+ Double clicking on a revision row (or context menu “Open (Read only)”)
+ opens an Eclipse read-only editor with the revision contents. (Note: You
+ can also “Save As...” when a file is open in a read-only editor to save
+ a local writable copy of the contents. Doing so, however, will not
+ associate the file created with its Guvnor source.)</para>
</section>
<section>
<title>Importing Guvnor Repository Resources</title>
- <para>In addition to the single file drag-and-drop from the Guvnor Repository Explorer view, the EGT also includes a wizard for copying one or more files from a Guvnor repository to the local workspace (and setting the association with the Guvnor repository). This wizard is available from the Eclipse Import , Guvnor, Resource from Guvnor and the Eclipse File, New, Other, Guvnor, Resource from Guvnor menu items. (Note: the wizard is identical but appears in both locations to accommodate users who tend to view this functionality as being in either category.)
-The first page of the wizard asks for the selection of the source Guvnor repository and gives the choice to create a new Guvnor repository connection (in which case the second page is the same as the Guvnor Connection wizard described above). </para>
- <figure>
- <title>Import</title>
+ <para>In addition to the single file drag-and-drop from the Guvnor
+ Repository Explorer view, the EGT also includes a wizard for copying one
+ or more files from a Guvnor repository to the local workspace (and
+ setting the association with the Guvnor repository). This wizard is
+ available from the Eclipse Import , Guvnor, Resource from Guvnor and the
+ Eclipse File, New, Other, Guvnor, Resource from Guvnor menu items.
+ (Note: the wizard is identical but appears in both locations to
+ accommodate users who tend to view this functionality as being in either
+ category.) The first page of the wizard asks for the selection of the
+ source Guvnor repository and gives the choice to create a new Guvnor
+ repository connection (in which case the second page is the same as the
+ Guvnor Connection wizard described above).</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT20.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Import</title>
- <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT20.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Import</title>
+ <para>Once the source Guvnor repository is chosen, the wizard prompts
+ for resource selection:</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT21.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
- <para>Finally, the target location in the local workspace is chosen:</para>
- <figure>
- <title>Import</title>
+ <figure>
+ <title>Import</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT22.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT21.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>On completion the wizard copies the selected files from the Guvnor repository to the local workspace. If a file with the same name already exists in the destination, the wizard uses the Eclipse standard “prompt for rename” dialog:</para>
- <figure>
- <title>Copy</title>
+ <para>Finally, the target location in the local workspace is
+ chosen:</para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT23.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Import</title>
-
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT22.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On completion the wizard copies the selected files from the Guvnor
+ repository to the local workspace. If a file with the same name already
+ exists in the destination, the wizard uses the Eclipse standard “prompt
+ for rename” dialog:</para>
+
+ <figure>
+ <title>Copy</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT23.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
</section>
<section>
<title>Guvnor plugin Preferences</title>
- <para>The EGT provides a preference page in the “Guvnor” category:</para>
- <figure>
- <title>Preferences</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/Chapter-Guvnor/EGT24.png" format="PNG"
- scalefit="1" />
- </imageobject>
- </mediaobject>
- </figure>
+ <para>The EGT provides a preference page in the “Guvnor”
+ category:</para>
- <para>The preferences cover two categories: Guvnor repository connections and local Guvnor repository resource decorations.</para>
+ <figure>
+ <title>Preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center"
+ fileref="images/Chapter-Guvnor/EGT24.png" format="PNG"
+ scalefit="1"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>
-Guvnor Repository Connection Preferences</para>
-<para>
-There are two preferences that can be set for Guvnor repository connections, and these are used when creating new connections. The first is a default Guvnor repository URL template, which can make it easier to create multiple similar connections by simply changing part of the field, such as the host name. The second is whether saving of authentication information in the Eclipse platform key-ring should be enabled by default. As with the Guvnor repository URL template, actually whether to save a specific instance of authentication information in the Eclipse platform key-ring can be determined when actually creating the connection. That is, both of these preferences are simply convenience values set to reasonable defaults.</para>
-<para>
-Local Guvnor Repository Resource Decoration Preferences</para>
-<para>
-The second category of preferences provided by the EGT deals with how decoration of local resources associated with Guvnor repository resources is presented. Since the Guvnor repository is not a substitute for a SCM, and since SCM tools in Eclipse tend to decorate local resources, it is useful to be able to control just how the EGT decorate its local resources to avoid messy conflicts with SCM packages. In the “File Decoration” section of the preference page, you can choose the location (top right, bottom right, top left, bottom left) of the decoration icon, or you can choose not to display it. In the “Text” section, you can format the Guvnor metadata that is appended to the file names:
-Whether to show an indicator (>) when the local file has changes not committed back to the Guvnor repository.
-Whether to show the revision number.
-Whether to show the date/time stamp.
-Any changes to these preferences take effect immediately upon clicking the “Apply” or “Ok” buttons.
+ <para>The preferences cover two categories: Guvnor repository
+ connections and local Guvnor repository resource decorations.</para>
- </para>
- </section>
+ <para>Guvnor Repository Connection Preferences</para>
+ <para>There are two preferences that can be set for Guvnor repository
+ connections, and these are used when creating new connections. The first
+ is a default Guvnor repository URL template, which can make it easier to
+ create multiple similar connections by simply changing part of the
+ field, such as the host name. The second is whether saving of
+ authentication information in the Eclipse platform key-ring should be
+ enabled by default. As with the Guvnor repository URL template, actually
+ whether to save a specific instance of authentication information in the
+ Eclipse platform key-ring can be determined when actually creating the
+ connection. That is, both of these preferences are simply convenience
+ values set to reasonable defaults.</para>
- </section><!-- end EGT section -->
+ <para>Local Guvnor Repository Resource Decoration Preferences</para>
-</section>
\ No newline at end of file
+ <para>The second category of preferences provided by the EGT deals with
+ how decoration of local resources associated with Guvnor repository
+ resources is presented. Since the Guvnor repository is not a substitute
+ for a SCM, and since SCM tools in Eclipse tend to decorate local
+ resources, it is useful to be able to control just how the EGT decorate
+ its local resources to avoid messy conflicts with SCM packages. In the
+ “File Decoration” section of the preference page, you can choose the
+ location (top right, bottom right, top left, bottom left) of the
+ decoration icon, or you can choose not to display it. In the “Text”
+ section, you can format the Guvnor metadata that is appended to the file
+ names: Whether to show an indicator (>) when the local file has
+ changes not committed back to the Guvnor repository. Whether to show the
+ revision number. Whether to show the date/time stamp. Any changes to
+ these preferences take effect immediately upon clicking the “Apply” or
+ “Ok” buttons.</para>
+ </section>
+ </section>
+
+ <!-- end EGT section -->
+</section>
More information about the jboss-svn-commits
mailing list