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

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

Author: michael.neale at jboss.com
Date: 2007-07-06 03:54:49 -0400 (Fri, 06 Jul 2007)
New Revision: 13153

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

Added: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/AssetChangeStatus.png
===================================================================
(Binary files differ)


Property changes on: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/AssetChangeStatus.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/PackageChangeStatus.png
===================================================================
(Binary files differ)


Property changes on: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/PackageChangeStatus.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

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-06 07:20:05 UTC (rev 13152)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml	2007-07-06 07:54:49 UTC (rev 13153)
@@ -323,19 +323,65 @@
     <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, Statuses do NOT effect the execution in any way, and are purely informational.
+		Unlike categories, assets only have one status AT A TIME. 
+	  </para>	
+	  
+	  <para>
+	  	Using statuses is completely optional. You can use it to manage the lifecycle of assets 
+	  	(which you can also do with categories if you like).
+	  </para>
       
+      <para>      
+      <figure>
+          <title>Asset status</title>
+
+          <mediaobject>
+            <imageobject>
+              <imagedata align="center" fileref="AssetChangeStatus.png" format="PNG"
+                         scalefit="1" />
+            </imageobject>
+          </mediaobject>
+        </figure>
+        You can change the status of an individual asset (like in the diagram above).
+        Its change takes effect immediately, no seperate save is needed.
+      </para>
+
+
+      <para>      
+      <figure>
+          <title>Asset status</title>
+
+          <mediaobject>
+            <imageobject>
+              <imagedata align="center" fileref="PackageChangeStatus.png" format="PNG"
+                         scalefit="1" />
+            </imageobject>
+          </mediaobject>
+        </figure>
+        You can change the status of a whole package - this sets the status flag on the package itself,
+        but it ALSO changes the statuses on ALL the assets that belong to this package in one hit (to be the same as what you set the package to).
+      </para>
+
       
     </section>
 
     <section>
       <title>Package management</title>
+      
+      <para>[pix on package editor, talk about models etc]</para>
     </section>
 
     <section>
       <title>Version management</title>
 
+	<para>Both assets and whole packages of assets are "versioned" in the BRMS, but the mechanism is slightly different. Individual assets are saved a bit like a version of a file in a source control system. However, packages of assets are versioned "on demand" by taking a snapshot (typically which is used for deployment).
+	The next section talks about deployment management and snapshots.</para>
 
-
       <para>
       <figure>
           <title>Asset versions</title>
@@ -375,6 +421,8 @@
       stored in the database, and also seperates rules into packages (name
       spaces) and their type (format, as rules can be in many different
       formats).</para>
+      
+      <para>[picture of rules explorer list, and package explorer]</para>
     </section>
   </section>