[jboss-svn-commits] JBL Code SVN: r13348 - labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS.

[jboss-svn-commits at lists.jboss.org]

Author: michael.neale at jboss.com
Date: 2007-07-11 02:13:37 -0400 (Wed, 11 Jul 2007)
New Revision: 13348

Modified:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml
Log:
JBRULES-688

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-11 05:28:11 UTC (rev 13347)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml	2007-07-11 06:13:37 UTC (rev 13348)
@@ -403,19 +403,37 @@
     </section>
 
     <section>
-      <title>Rule types and formats</title>
+      <title>Rule authoring</title>
 
-      <para>[enumerate and have some screenshots of different rule assets,
-      including functions, briefly describe]</para>
+	  <para> </para>
+      
+      <para>
+      	Guided editor style "Business rules": (also known as "BRL format"). These rules use the guided GUI which controls and propts user input based on knowledge of the 
+      	object model. This can also be augmented with DSL sentences. 
+      </para>
+      
+      <para>
+		DSL rules:
+	  </para>
 
-      <para>Vanilla DRL - regular DRL "files" can be managed in the BRMs. A
+      <para>
+		Spreadsheet decision tables:
+	  </para>
+
+
+	  <para>
+		Technical (drl) rules: Rules stored as drl text can be managed in the BRMS, as well as more "traditional" drl files. A
       DRL can either be a whole chunk of rules, or an individual rule. if its
-      an individual rule, no package statement or imports are required.
+      an individual rule, no package statement or imports are required (in fact, you can skip the "rule" statement altogether, just use 
+"when" and "then" to mark the condition and action sections respectively).
       Normally you would use the IDE to edit raw DRL files, since it has all
-      the advanced tooling and content assistance and debugging.</para>
+      the advanced tooling and content assistance and debugging, however there are times when a rule may have to deal with something fairly technical.
+      </para>
 
-      <para>If you import a vanilla DRL into a new package, it will
-      automatically break apart the rules in to separate assets.</para>
+	  <para>Rule flows: Rule flows allow you to visually describe the steps taken - so not all rules are evaluated at once, but there is a flow of logic. Rule flows are not covered in this chapter on the BRMS, but you can use the IDE to graphically draw ruleflows, and upload the .rf file to the BRMS.</para>
+
+	  <para>Suggestion: As you may have many similar rules, you can create rule templates, which are simply rules which are kept in an inactive package - you can then categories templates accordingly, and copy them as needed (choosing a live package as the target package).</para>
+
     </section>
 
     <section>
@@ -506,14 +524,14 @@
 
       <para>The asset types: <itemizedlist>
           <listitem>
-            <para>Business rule assets: this shows a list of all "business
-            rule" types, which include decision tables, business rules
+            <para>Business assets: this shows a list of all "business
+            rule" types, which include decision tables, business rules etc.
             etc.</para>
           </listitem>
 
           <listitem>
-            <para>Technical rule assets: this is a list of rules that would be
-            considered technical (eg DRL files).</para>
+            <para>Technical assets: this is a list of items that would be
+            considered technical (eg DRL rules, and rule flows).</para>
           </listitem>
 
           <listitem>
@@ -585,7 +603,7 @@
       	<para>It is also possible to create a package by importing an existing "drl" file.
       	When you choose to create a new package, you can choose an option to upload a .drl file. The BRMS
       	will then attempt to understand that drl, break create a package for you. The rules in it will be stored as individual assets (but still as drl text content).
-      	Note that to actually build the package, you will need to upload an appropriate model (as a jar) to validate against, as a separate step.
+      	Note that to actually build the package, you will need to upload an appropriate model (as a jar) to validate against, as a separate step.</para>
       </section>
       
     </section>
@@ -643,15 +661,7 @@
     </section>
   </section>
 
-  <section>
-    <title>Rule authoring</title>
 
-    <para>[detail on guided editor, how to use DSLs, dsl editor, upload rf +
-    dt etc]</para>
-
-    <para>[also mention possibility of creating templates to copy etc]</para>
-  </section>
-
   <section>
     <title>The business user perspective</title>