Page History

Table of Contents

Introduction

he Mini-Language concept in Open For Business is similar to the Gang of Four Interpreter pattern, or the Mark Grand Little Language pattern. This is also the central theme of the Building Parsers with Java book by Steven John Metsker which the OFBiz Rule Engine is based on. The idea is to create simple languages that simplify complex or frequently performed tasks.

...

The only difference between the two DOCTYPE definitions is the root node to use from the DTD.

The Simple Map Processor Mini-Language

• Simple Map Processor Overview
• Make In String Operations
• Process Field Operations
• Simple Map Processors Example

Simple Map Processor Overview

The Simple Map Processor Mini-Language performes two primary tasks: validation and conversion. It does this in a context of moving values from one Map to another. The input map will commonly contain Strings, but can contain other object types like Integer, Long, Float, Double, java.sql.Date, Time, and Timestamp.

NOTE: The reference information for the simple-map-processor has been moved to annotations in the simple-methods.xsd file.

Simple Map Processors Example

<!DOCTYPE simple-map-processors PUBLIC "-//OFBiz//DTD Simple Methods//EN" "http://ofbiz.apache.org/dtds/simple-methods.dtd">

<simple-map-processors>
 <simple-map-processor name="update">
 <make-in-string field="estimatedStartDate">
 <in-field field="estimatedStartYear"><constant>-</constant>
 <in-field field="estimatedStartMonth"><constant>-</constant>
 <in-field field="estimatedStartDay"><constant>T</constant>
 <in-field field="estimatedStartHour"><constant>:</constant>
 <in-field field="estimatedStartMinute"><constant>:</constant>
 <in-field field="estimatedStartSecond">
 </make-in-string>
 <process field="workEffortId"><copy replace="false"/></process>
 <process field="scopeEnumId"><copy/></process>
 <process field="currentStatusId"><copy/><not-empty><fail-message message="Status is missing."/></not-empty></process>
 <process field="priority"><convert type="Long"><fail-message message="Priority is not a valid whole number."/></convert></process>
 <process field="estimatedStartDate">
 <compare-field operator="less" field="estimatedCompletionDate" type="Timestamp" format="yyyy-MM-dd'T'HH:mm:ss">
 <fail-message message="Estimated Start date/time must be BEFORE End date/time."/></compare-field>
 <convert type="Timestamp" format="yyyy-MM-dd'T'HH:mm:ss">
 <fail-message message="Estimated Start Date is not a valid Date-Time."/></convert></process>
 <process field="estimatedCompletionDate">
 <convert type="Timestamp"><fail-message message="Estimated Completion Date is not a valid Date-Time."/></convert></process>
 <process field="estimatedMilliSeconds">
 <convert type="Double"><fail-message message="Estimated Milli-seconds is not a valid number."/></convert></process>
 </simple-map-processor>
 <simple-map-processor name="delete">
 <process field="workEffortId"><copy/><not-empty><fail-message message="Work Effort ID is missing."/></not-empty></process>
 </simple-map-processor>
</simple-map-processors>

The Simple Method Mini-Language

• Simple Method Overview
• Special Context Access Syntax
• Call Operations
• Java Call Operations
• Control and Error Handling Operations
• Event Specific Operations
• Service Specific Operations
• Method Environment Operations
• Entity Engine Misc. Operations
• Entity Engine Find Operations
• Entity Engine Value Operations
• Entity Engine List Operations
• Entity Engine Transaction Operations
• Conditional (If) Operations
• Other Operations
• Simple Methods Example

Simple Method Overview

The Simple Method Mini-Language is a simple way to implement an event that is invoked by the Control Servlet or a service that is invoked by the Service Engine. A Simple Method can be invoked through the static methods on the SimpleMethod class, or as an event through an entry in the controller configuration XML file like the following:

...

Special Context Access Syntax

In strings and field names a special syntax is supported to flexibly access Map member, List elements and to insert environment values into string constants.

...

Okay, enough of the general stuff, here is a catalog and description of the available operations.

Call Operations

call-map-processor

The call-map-processor tag invokes a simple map processor from an existing map, creating a new map or adding to an existing one if the named out-map already exists. Resulting messages are added to the named list, and a new list is created if a list with the given name does not yet exist. Note that all lists and maps exist in the same context and must have unique names.

...

Java Call Operations

create-object

Creates an object of the given class and if the field-name is specified saves it in that field.

...

The return value will be put in the named field if an value is returned and if a field and optionally a map name are specified.

Control and Error Handling Operations

check-errors

The message lists from invoking are not checked until the check-errors tag is used. The named list is checked and if it contains any messages they are put in the servlet request object and the specified error code is returned to the control servlet.

add-error

Adds an error message with to the given error list from either an inline message or a message from a properties file

return

Returns immediately from the simple-method with the given response code string.

Event Specific Operations

field-to-request

The field-to-request tag copies a field from a map to the specified servlet request attribute.

The tag is only used when the simple-method is called as an event, it is ignored otherwise.

field-to-session

The field-to-session tag copies a field from a map to the specified servlet session attribute.

The tag is only used when the simple-method is called as an event, it is ignored otherwise.

request-to-field

The request-to-field tag copies an attribute from the servlet request to a field of a map in the method environment.

The tag is only used when the simple-method is called as an event, it is ignored otherwise (except the default value, if specified).

request-parameters-to-list

The request-parameters-to-list tag appends a request parameter values from the servlet request to the specified list.

The tag is only used when the simple-method is called as an event, it is ignored otherwise.

session-to-field

The session-to-field tag copies an attribute from the servlet session to a field of a map in the method environment.

The tag is only used when the simple-method is called as an event, it is ignored otherwise (except the default value, if specified)

webapp-property-to-field

The webapp-property-to-field tag copies a property value from a properties file in a ServletContext resource to a field.

The tag is only used when the simple-method is called as an event, it is ignored otherwise (except the default value, if specified).

Service Specific Operations

field-to-result

The field-to-result tag copies a field from a map to the specified service result field.

The tag is only used when the simple-method is called as a service, it is ignored otherwise.

Method Environment Operations

map-to-map

The map-to-map tag copies all fields from one map to another map

field-to-field

The field-to-field tag copies a field from a map to a field in another map.

field-to-list

The field-to-list tag appends a field to the specified list

env-to-field

The env-to-field tag copies a field from the method environment to a field in a map.

field-to-env

The field-to-env tag copies a field from a map to a field in the method environment.

string-to-field

The string-to-field tag puts the inlined string value in the specified field.

string-to-list

The string-to-list tag appends the inlined string value in the specified List.

to-string

The to-string tag converts the Object in the specified field to a String, putting the string in the same field.

clear-field

The clear-field tag clears/removes the specified field.

iterate

The operations contained by the iterate tag will be executed for each of the entries in the list, and will make the current entry available in the method environment by the entry-name specified. This tag can contain any of the simple-method operations, including the conditional/if operations.

first-from-list

The first-from-list tag will get the first entry from the given list and put it in the environment field with the given entry-name.

Entity Engine Misc. Operations

now-timestamp-to-env

The now-timestamp-to-env tag creates a java.sql.Timestamp object with the current date and time in it and puts it in a field in the method environment.

now-date-to-env

The now-date-to-env tag creates a java.sql.Date object with the current date in it and puts it in a field in the method environment.

sequenced-id-to-env

The sequenced-id-to-env tag gets a sequenced ID from the Entity Engine (through the delegator) and puts it in the specified method environment field. The object will be a java.lang.Long, but can of course be converted to a String.

set-current-user-login

The set-current-user-login tag sets the UserLogin GenericValue object to be used for authentication for the rest of the method. This is mostly used for calling services, etc.

Entity Engine Find Operations

find-by-primary-key

The find-by-primary-key tag uses the delegator to find an entity value by its primary key. The resulting GenericValue object will be placed in the method environment using the specified value-name.

find-by-and

The find-by-and tag uses the delegator to find entity values by anding the fields passed in the map. The resulting GenericValue objects will be placed in the method environment using the specified list-name.

filter-list-by-and

The filter-list-by-and tag filters the given list by the fields in the specified map.

filter-list-by-date

The filter-list-by-date tag filters the given list by the valid date using the from and thru dates in each value object.

Entity Engine Value Operations

make-value

The make-value tag uses the delegator to construct an entity value. The resulting value will not necessarily exist in the database, but will simply be assembled using the entity-name and fields map. The resulting GenericValue object will be placed in the method environment using the specified value-name.

clone-value

The clone-value tag make a copy of the value in the method environment field specified by value-name. The resulting GenericValue object will be placed in the method environment using the specified new-value-name.

create-value

The create-value tag persists the specified GenericValue object by creating a new instance of the entity in the datasource. An error will result if an instance of the entity exists in the datasource with the same primary key.

store-value

The store-value tag persists the specified GenericValue object by updating the instance of the entity in the datasource. An error will result if an instance of the entity does not exist in the datasource with the same primary key.

remove-value

The remove-value tag removes the specified GenericValue object by removing the instance of the entity in the datasource. An error will result if an instance of the entity does not exist in the datasource with the same primary key.

remove-by-and

The remove-by-and tag uses the delegator to remove entity values from the datasource and is constrained by anding the fields passed in the map. Make sure the map contains something, or all values will be removed.

clear-cache-line

Uses the delegator to clear elements from the cache; intelligently looks at the map passed to see if it is a byPrimaryKey, and byAnd, or an all.

clear-entity-caches

This is a very simple tag that should be used sparingly because of the performance impact. It clears all lines from all Entity Engine caches. It has no attributes or sub-elements.

set-pk-fields

Looks for each PK field in the named map and if it exists there it will copy it into the named value object.

set-nonpk-fields

Looks for each non-PK field in the named map and if it exists there it will copy it into the named value object.

Entity Engine List Operations

store-list

The store-list tag uses the delegator to store all entity values in the list. This is different than storing a single value in that values in the list will be inserted if it does not exist or updated if it does exist.

remove-list

The remove-list tag uses the delegator to remove all entity values in the list. For each value in the list if it is a primary key just that entity instance will be removed, but if it is not a full primary key all entity instances will be removed from the datasource that match the constraint of the field map.

Entity Engine Transaction Operations

transaction-begin

The transaction-begin tag will begin a transaction if one is not already in place. If a transaction is begun the environment field named as the began-transaction-name will be set to true, otherwise it will be set to false.

Note that unless the simple-method is flagged to not use a transaction all simple-methods will be inside a transaction. The same is true for service calls through the Service Engine.

transaction-commit

The transaction-commit tag will commit a transaction if a transaction was begun in the current demarcation context as represented by the environment field named as the began-transaction-name. If the Boolean in that field is false no commit will be done.

transaction-rollback

The transaction-rollback tag will rollback a transaction if a transaction was begun in the current demarcation context as represented by the environment field named as the began-transaction-name. If the Boolean in that field is false a set rollback only will operation will be done instead of rollback which will force the transaction to rollback regardless of which method or object is responsible for beginning and ending the transaction.

Conditional (If) Operations

if

The if operation offers a flexible way of specifying combinations of conditions, alternate conditions, and operations to run on true evaluation of the conditions or to run otherwise.

The other if operations are meant for a specific, simple condition when used outside of the condition sub-element of this operation. The attributes of the other if operations are the same when used inside this operation. In this case they are empty tags and do not have any sub-elements because the operations to run are under the then or else tags.

if-validate-method

The operations contained by the if-validate-method tag will only be executed if the validate method returns true. This tag can contain any of the simple-method operations, including the conditional/if operations.

if-compare

The operations contained by the if-compare tag will only be executed if the comparison returns true. This tag can contain any of the simple-method operations, including the conditional/if operations.

if-compare-field

The operations contained by the if-compare-field tag will only be executed if the comparison returns true. This tag can contain any of the simple-method operations, including the conditional/if operations.

if-regexp

The operations contained by the if-regexp tag will only be executed if the value complies with the regular expression. This tag can contain any of the simple-method operations, including the conditional/if operations.

if-empty

The operations contained by the if-empty tag will only be executed if the map field is empty. This tag can contain any of the simple-method operations, including the conditional/if operations.

if-not-empty

The operations contained by the if-not-empty tag will only be executed if the map field is not empty. This tag can contain any of the simple-method operations, including the conditional/if operations.

if-has-permission

The operations contained by the if-has-permission tag will only be executed if the user has the specified permission, and optionally the action. This tag can contain any of the simple-method operations, including the conditional/if operations.

check-permission

The check-permission tag checks to see if the current user has the specified permission. The the user does not have the specified permission or there is no user associated with the context then the failure message from fail-message or file-property will be added to the specified error list.

check-id

The check-id tag checks to see if the ID value in the given field is a valid ID string. Valid IDs can be any sequence of characters or digits but must not containt the following characters: space [ ], doublequote ["], single quote ['], ampersand [&], question mark [?], less-than sign [<], greater-than sign [>].

Other Operations

property-to-field

The property-to-field tag puts the inlined string value in the specified field.

log

The log tag logs a message used the OFBiz Debug class, which uses Log4J to log to the console, a file, or some other location. The message is a concatenation of the message attribute and then all of the field and string sub-element values in the order they are specified.

calculate

The calculate tag performs the specified calculation and puts the result in an object in the field of the specified map (see the calculate element attribute descriptions above). The type of the object can be specified with the type attribute, but defaults to Double.

The calculate tag can contain calcop and number tags, and the calcop tag can also contain these two tags to enable nested calculations.

Each calcop tag has three attributes: operator, map-name and field-name. Only the operator is required. The operator specifies the operation to perform on the given field and nested calcops and numbers. It must be one of the following: get | add | subtract | multiply | divide | negative.

Regardless of the operator the action is very similar. It translates to a formula like the following: (V1 [operator] V2 [operator] V3). In other words a final result is calculated by applying the operator to the values in the order they are specified. If a field-name (and optionally map-name) is specifies on the calcop tag that field will be used as the first value, otherwise the first nested calcop or number will be the first value.

The get operator is just an alias for add. It adds all of the values under it. Likewise the negative operator is almost an alias for subtract, with the exception that the first value is negated instead of left positive. For convenience the calculate tag itself acts like an add, in other words the calcops and numbers under it are all added together.

Here is an example of an XML snippet that performs the calculation a=b+(((c+x+2)*-d)/e), or in Reverse Polish Notation (a little bit closer to the resulting XML, and the notation used in the Rule Engine) a=+(b,/(*(+(c,x,2),-d),e)). Here is the XML:

<calculate field-name="a">
<calcop operator="get" field-name="b"/>
<calcop operator="divide">
<calcop operator="multiply">
<calcop operator="add" field-name="c">
<calcop operator="get" field-name="x"/>
<number value="2"/>
</calcop>
<calcop operator="negative" field-name="d"/>
</calcop>
<calcop operator="get" field-name="e"/>
</calcop>
</calculate>

Simple Methods Example

<!DOCTYPE simple-methods PUBLIC "-//OFBiz//DTD Simple Methods//EN" "http://ofbiz.apache.org/dtds/simple-methods.dtd">

<simple-methods>
 <simple-method method-name="createProduct" short-description="Create an Product">
 <check-permission permission="CATALOG" action="_CREATE"><fail-message message="Security Error: to run createProduct you must have the CATALOG_CREATE or CATALOG_ADMIN permission"/></check-permission>
 <check-id field-name="productId" map-name="parameters"/>
 <check-errors/>

 <make-value value-name="newEntity" entity-name="Product"/>
 <set-nonpk-fields map-name="parameters" value-name="newEntity"/>
 <set-pk-fields map-name="parameters" value-name="newEntity"/>
 
 <now-timestamp-to-env env-name="nowTimestamp"/>
 <env-to-field env-name="nowTimestamp" field-name="lastModifiedDate" map-name="newEntity"/>
 <env-to-field env-name="nowTimestamp" field-name="createdDate" map-name="newEntity"/>
 <field-to-field field-name="userLoginId" map-name="userLogin" to-field-name="lastModifiedByUserLogin" to-map-name="newEntity"/>
 <field-to-field field-name="userLoginId" map-name="userLogin" to-field-name="createdByUserLogin" to-map-name="newEntity"/>
 
 <create-value value-name="newEntity"/>

 <!-- induce keywords if autoCreateKeywords is emtpy or Y-->
 <if-empty field-name="autoCreateKeywords" map-name="newEntity">
 <call-bsh><![CDATA[org.ofbiz.commonapp.product.product.KeywordSearch.induceKeywords(newEntity);]]></call-bsh>
 <else>
 <if-compare field-name="autoCreateKeywords" map-name="newEntity" operator="equals" value="Y">
 <call-bsh><![CDATA[org.ofbiz.commonapp.product.product.KeywordSearch.induceKeywords(newEntity);]]></call-bsh>
 </if-compare>
 </else>
 </if-empty>
 </simple-method>
 <simple-method event-name="create" short-description="Create Work Effort">
 <call-map-processor xml-resource="org/ofbiz/commonapp/workeffort/workeffort/WorkEffortMapProcessors.xml" 
 processor-name="update" in-map-name="parameters" out-map-name="context"/>
 <check-errors/>
 <call-service service-name="createWorkEffort" in-map-name="context">
 <default-message>Work Effort successfully created.</default-message>
 <result-to-request result-name="workEffortId"/></service>
 </simple-method>
 <simple-method event-name="update" short-description="Update Work Effort">
 <call-map-processor xml-resource="org/ofbiz/commonapp/workeffort/workeffort/WorkEffortMapProcessors.xml" 
 processor-name="update" in-map-name="parameters" out-map-name="context"/>
 <check-errors/>
 <call-service service-name="updateWorkEffort" in-map-name="context">
 <default-message>Work Effort successfully updated.</default-message></service>
 </simple-method>
</simple-methods>