[jboss-svn-commits] JBL Code SVN: r14513 - labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Fri Aug 24 00:11:40 EDT 2007
Author: michael.neale at jboss.com
Date: 2007-08-24 00:11:40 -0400 (Fri, 24 Aug 2007)
New Revision: 14513
Added:
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/EnumConfig.png
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/EnumDropDown.png
Modified:
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml
Log:
JBRULES-1020
Added: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/EnumConfig.png
===================================================================
(Binary files differ)
Property changes on: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/EnumConfig.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/EnumDropDown.png
===================================================================
(Binary files differ)
Property changes on: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/EnumDropDown.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-08-24 03:47:16 UTC (rev 14512)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-AdminGuide.xml 2007-08-24 04:11:40 UTC (rev 14513)
@@ -189,6 +189,9 @@
<section>
<title>Security</title>
+ <para>Please note that giving someone access to the BRMS indicates a level of trust.
+ Being able to editing and build rules is providing a great deal of power to a user. Thus you should not open up the BRMS to your entire organisation - but instead to a select few. Use https (http with TLS/SSL) whereever possible (even internally in a companies network this is a good idea). Use this power wisely - this not a "run of the mill" application that provides read/write access to a database, but something much more power. Just imagine you are spider man - with great power comes great responsibility (of course even more so for super man).</para>
+
<para>Security is configured by using the components.xml file in the war
file. To customize this, you will need to unzip the war file, and locate
the components.xml file which is in the WEB-INF directory.</para>
@@ -318,6 +321,16 @@
</section>
<section>
+ <title>Customised selectors for package building</title>
+ <para>When building packages (from the "Packages" feature) you have the option to specify the name of a "selector". This selector will filter the list of rules that are built into the package. What you enter in the selector text box, is the name of a selector as configured on the server.</para>
+
+ <para>
+ To configure a selector, you will need to "explode" the war file for the BRMS, and locate the selectors.properties file (note you can also put your own selectors.properties file in the system classpath if you like).
+ In this file, you will find details on how you can configure a custom selector. The options are to use a drl file, or the name of a class that you have written (and which is available on the classpath). Classes must implement the AssetSelector interface. DRL files can also be used (there is an example one in the selectors.properties file). Each selector you configure has a unique name in this properties file - and this is the name that you can use when building packages.
+ </para>
+ </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
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml 2007-08-24 03:47:16 UTC (rev 14512)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml 2007-08-24 04:11:40 UTC (rev 14513)
@@ -502,6 +502,24 @@
"priority". This would probably be the most common option to
use.</para>
+ <section><title>User driven drop down lists</title>
+
+ <figure>
+ <title>Data enumeration showing as a drop down list</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="EnumDropDown.png" format="PNG"
+ scalefit="1" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Note that is it possible to limit field values to items in a pre configured list. This list is configured as part of the package (using a data enumeration to provide values for the drop down list). These values can be a fixed list, or (for example) loaded from a database. This is useful for codes, and other fields where there are set values. It is also possible to have what is displayed on screen, in a drop down, be different to the value (or code) used in a rule. See the section on data enumerations for how these are configured.
+ </para>
+
+ </section>
+
<para>Augmenting with DSL sentences: If the package the rule is part
of has a dsl configuration, when when you add conditions or actions,
then it will provide a list of "DSL Sentences" which you can choose
@@ -694,6 +712,29 @@
</figure>
</section>
+ <section>
+ <title>Data enumerations (drop down list configurations)</title>
+
+ <para>Data enumerations are an optional asset type that technical folk can configure to provide drop down lists for the guided editor. These are stored and edited just like any other asset, and apply to the package that they belong to.</para>
+
+ <para>
+ The contents of an enum config are a mapping of Fact.field to a list of values to be used in a drop down. That list can either be literal, or use a utility class (which you put on the classpath) to load a list of strings. The strings are either a value to be shown on a drop down, or a mapping from the code value (what ends up used in the rule) and a display value (see the example below, using the '=').
+ </para>
+
+
+
+ <figure>
+ <title>Data enumeration</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="EnumConfig.png" format="PNG"
+ scalefit="1" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
<para>Tip: 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
@@ -795,7 +836,7 @@
<listitem>
<para>Technical assets: this is a list of items that would be
- considered technical (eg DRL rules, and rule flows).</para>
+ considered technical (eg DRL rules, data enumerations and rule flows).</para>
</listitem>
<listitem>
@@ -862,6 +903,8 @@
the "drl" that this package results in. WARNING: in cases of large
numbers of rules, all these operations can take some time.</para>
+ <para>It is optional at this stage to enter the name of a "selector" - see the admin section for details on how to configure custom selectors for your system (if you need them - selecters allow you to filter down what you build into a package - if you don't know what they are for, you probably don't need to use them).</para>
+
<section>
<title>Importing drl packages</title>
More information about the jboss-svn-commits
mailing list