[jboss-svn-commits] JBL Code SVN: r13027 - labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Mon Jul 2 22:50:47 EDT 2007
Author: michael.neale at jboss.com
Date: 2007-07-02 22:50:46 -0400 (Mon, 02 Jul 2007)
New Revision: 13027
Added:
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/CatEdit.png
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/CatZoom.png
Modified:
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Architecture.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml
Log:
JBRULES-688
Added: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/CatEdit.png
===================================================================
(Binary files differ)
Property changes on: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/CatEdit.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/CatZoom.png
===================================================================
(Binary files differ)
Property changes on: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/CatZoom.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml 2007-07-03 02:33:26 UTC (rev 13026)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml 2007-07-03 02:50:46 UTC (rev 13027)
@@ -30,7 +30,8 @@
<para>Once the drools-jbrms.war has been placed in the deployment
directory, and the application server started, you should navigate to
http://localhost/drools-jbrms and check that the BRMS appears. (Obviously
- substitute the URL for what your application is configured to).</para>
+ substitute the URL for what your application server is configured
+ to).</para>
<para>Once that shows up, you are deployed and ready to go !</para>
@@ -296,14 +297,14 @@
directory.</para>
<para>Ideally you will either stop the BRMS application while a file
- backup is being done, or ensure that no one is using it. </para>
+ backup is being done, or ensure that no one is using it.</para>
<para>In the case of using an external database (eg Oracle, MySQL), then
the normal scheme can apply that you would use to backup those database
(you do back them up, right?). In this case, when restoring, it is also
a good idea to clear the indexes (delete the directory where the indexes
are) so they are created fresh from the data (and thus guaranteed to be
- in sync). </para>
+ in sync).</para>
</section>
<section>
@@ -317,16 +318,56 @@
</section>
<section>
+ <title>Adding your own logos or styles to the BRMS web GUI</title>
+
+ <para>Everyone loves having their own logo on screen - this is to ensure
+ that the people using the application don't forget who they work for or
+ what product they are using for more then a nanosecond (the consequences
+ of them forgetting are too terrible con contemplate).</para>
+
+ <para>To achieve, this, you can "explode" the deployment war file, and
+ locate the JBRMS.html file. <programlisting>
+<html>
+<head>
+ <meta name='gwt:module' content='org.drools.brms.JBRMS'>
+ <link rel='stylesheet' href='JBRMS.css'>
+ <title>JBoss Business Rules Management System</title>
+ <link rel="shortcut icon" href="images/drools.gif" type="image/gif">
+ <link rel="icon" href="images/drools.gif" type="image/gif">
+ </head>
+ <body>
+ <div class="headerBarblue"><img src="images/jbossrules_hdrlogo.png" width="279" height="70" /></d
+ <!-- This script is the bootstrap stuff that simply must be there; it is sent down uncompressed -->
+ <script language='javascript' src='gwt.js'></script>
+ <iframe id='__gwt_historyFrame' style='width:0;height:0;border:0'></iframe>
+</body>
+</html></programlisting> The above is the contents of the JBRMS.html
+ file - it is faily empty (as most of the work is done by the GWT - the
+ GUI is built dynamically in the browser). The parts you can customise
+ are the style sheet - you can either edit the JBRMS.css (or better yet,
+ take a copy, and change the style to be what you need), the "shortcut
+ icon" (its what shows in the address bar in the browser etc - also
+ change the "icon" link to be the same so it works in IE), and the header
+ logo. The rest should be left as is, to allow the GWT components to be
+ loaded and attached to the page. This html page is loaded only once by
+ the browser when the user accesses the BRMS web GUI.</para>
+
+ <para>The best way to customise is to take a copy of the JBRMS.html -
+ and then edit. You can also change the URL by editing the web.xml via
+ the normal means. </para>
+ </section>
+
+ <section>
<title>Import and Export</title>
<para>A JCR standard export/import feature is available from the Admin
- part of the web interface. </para>
+ part of the web interface.</para>
<para>This will export the entire repository to an XML format as defined
- by the JCR standard. </para>
+ by the JCR standard.</para>
<para>In the case of import, it will clear any existing content in the
- database. </para>
+ database.</para>
<para>This is not a substitute for backup but can be useful when
migrating. It is important to note that version history is not exported
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Architecture.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Architecture.xml 2007-07-03 02:33:26 UTC (rev 13026)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Architecture.xml 2007-07-03 02:50:46 UTC (rev 13027)
@@ -150,6 +150,11 @@
you could in theory combine it with your own application (with some care)
- but it is easier to keep it as a seperate war, and will make it easier
to upgrade to newer releases as they come out.</para>
+
+ <para>The JBRMS.html file can be customised - for example to change logos or embed
+ the BRMS in another page. Take a look at the JBRMS.html file for details (its
+ very simple).
+ </para>
</section>
<section>
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml 2007-07-03 02:33:26 UTC (rev 13026)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml 2007-07-03 02:50:46 UTC (rev 13027)
@@ -8,13 +8,14 @@
<para>If you are reading this, you must be the impatient type who wants to
kick the tyres (and light the fires) and have a look around as soon as
possible. This section will provide a quick end to end tour of the steps
- involved (but not go through the concepts in detail). This assumes you
- have installed the repository correctly, and are able to access the main
- login screen.</para>
+ involved (but does not go through the concepts in detail). This assumes
+ you have installed the repository correctly, and are able to access the
+ main login screen.</para>
<para>You can also consult the wiki:
http://wiki.jboss.org/wiki/Wiki.jsp?page=RulesRepository for some
- tutorials and user tips.</para>
+ tutorials and user tips (it IS a wiki, so you can even contribute your own
+ tips and examples and even upload files if you desire !).</para>
<section>
<title>Initial configuration</title>
@@ -26,8 +27,8 @@
<itemizedlist>
<listitem>
<para>Once deployed, go to "http://<your
- server>/drools-jbrms/" (This will show the initial info
- screen)</para>
+ server>/drools-jbrms/" (This will show the initial info screen -
+ or login screen depending on the configuration).</para>
</listitem>
<listitem>
@@ -166,7 +167,72 @@
<title>BRMS concepts</title>
<section>
+ <title>Rules are assets</title>
+
+ <para>As the BRMS can manage many different types of rules (and more),
+ they are all classes as "assets". An asset is anything that can be
+ stored as a version in the repository. This includes decision tables,
+ models, DSLs and more. Sometimes the word "rule" will be used to really
+ mean "asset" (ie the things you can do also apply to the other asset
+ types). You can think of asset as a lot like a file in a folder. Assets
+ are grouped together for viewing, or to make a package for deployment
+ etc.</para>
+ </section>
+
+ <section>
<title>Categorisation</title>
+
+ <figure>
+ <title>Categories</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="CatZoom.png" format="PNG"
+ scalefit="1" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Categories allow rules (assets) to be labelled (or tagged) with
+ any number of categories that you define. This means that you can then
+ view a list of rules that match a specific category. Rules can belong to
+ any number of categories. In the above diagram, you can see this can in
+ effect create a folder/explorer like view of assets. The names can be
+ anything you want, and are defined by the BRMS administrator (you can
+ also remove/add new categories - you can only remove them if they are
+ not currently in use).</para>
+
+ <para>Generally categories are created with meaningful name that match
+ the area of the business the rule applies to (if the rule applies to
+ multiple areas, multiple categories can be attached). Categories can
+ also be used to "tag" rules as part of their lifecycle, for example to
+ mark as "Draft" or "For Review".</para>
+
+ <figure>
+ <title>Assets can have multiple categories</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="CatEdit.png" format="PNG"
+ scalefit="1" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The view above shows the category editor/viewer that is seen when
+ you open an asset. In this example you can see the asset belongs to 2
+ categories, with a "+" button to add additional items. This means that
+ when either category is viewed, you will see that asset.</para>
+
+ <para>When you open an asset to view or edit, it will show a list of
+ categories that it currently belongs to If you make a change (remove or
+ add a category) you will need to save the asset - this will create a new
+ item in the version history. Changing the categories of a rule has no
+ effect on its execution.</para>
+
+ <para>[pic of admin, show that they can be hierarchical]</para>
+
+ <para>[some general guidelines on names, depth of hierarchy etc]</para>
</section>
<section>
@@ -182,7 +248,7 @@
the advanced tooling and content assistance and debugging.</para>
<para>If you import a vanilla DRL into a new package, it will
- automatically break apart the rules in to separate assets. </para>
+ automatically break apart the rules in to separate assets.</para>
</section>
<section>
@@ -195,15 +261,16 @@
<section>
<title>Version management</title>
- <para>Asset versions</para>
+
+ <para>Asset versions</para>
</section>
<section>
<title>Deployment management</title>
- <para>Snapshots, URLS and binary packages</para>
+
+ <para>Snapshots, URLS and binary packages</para>
</section>
-
<section>
<title>Navigating and finding rules</title>
@@ -238,9 +305,8 @@
<para>[ how to use agent etc... ]</para>
</section>
-
+
<section>
- <title>Using the RuleAgent for deployment</title>
-
+ <title>Using the RuleAgent for deployment</title>
</section>
</section>
\ No newline at end of file
More information about the jboss-svn-commits
mailing list