Versions Compared

Old Version 47

changes.mady.by.user Adrian adrianc

Saved on

compared with

New Version Current

changes.mady.by.user Dennis Balkir

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edited the attributes of <make-value> because the map is optional (seen in different minilang scripts in OFBiz)
Alert
titleMini Lang Deprecated
typeWarning

According to the proposal thread in [1] we decided to deprecate mini lang. For additional information please refer to the corresponding issue [2].


[1] https://s.apache.org/iS8W

[2]

Jira
serverASF JIRA
serverId5aa69414-a9e9-3523-82ec-879b028fb15b
keyOFBIZ-9350

Current Mini Language (minilang) Reference Guide (Version 3)

Grammar version 2 (http://ofbiz.apache.org/dtds/simple-methods-v2.xsd)

Info
titleOlder versions

There are 2 older versions that you can find respectively at

Mini-Language Guide (Version 1 - Deprecated)

Mini-Language Guide (Version 2 - Deprecated)

 

Attributes

Attribute Types

Type

Description

Example

constant

A string constant. The string may not include an expression.

name="fooMethod"

constant+expr

A string constant. The string may include an expression

Mini-language Reference

The Apache Open For Business Project

Note

This is a draft document. It can be modified at any time by any committer. Comments on the draft should be made on the dev mailing list.

Attributes

...

titleProposed Attribute Type Section

Attribute Types

...

constant

...

A string constant. The string may not include an expression

...

constant+expr

...

, but an expression-only string is not allowed.

default="${foo}Method"

expression

A UEL expression

...

without enclosing brackets.

from="item.quantity * item.priceEach"

${expression}

A UEL expression with enclosing brackets.

default="${parameters.itemId}"

script

...

A short script ("scriptlet").

script="groovy:foo.bar();"

 

The <simple-method> element

Section
Column
width20%
<simple-method>
Column
Contains a block of code.

A simple method can be called in either an event context from the Control
Servlet (or another event) or in a service context through the Service
Engine, or any other component that has access to a service dispatcher.

Code Block
xml
xml

<simple-method method-name="fooMethod">
  <!-- some mini-language code goes here -->
</simple-method>
Attributes

Name

Type

Requirements

Description

Note

method-nameoptional

constant

required

A name (preferably a legal Java identifier) for this method.

Each simple method in a file must have a unique name.

short-description

constant

optional

A short description of the method.

Used for documentation.

default-error-code

optional

 

default-success-code

optional

 

login-required

constant

optional

Require a user login to run this method.

Defaults to "true".

use-transaction

constant

optional

Create a transaction if none exists for this thread.

Defaults to "true".

default-error-code

constant

optional

The default error return code.

Defaults to "error".

default-success-code

constant

optional

The default success return code.

Defaults to "success".

parameter-map-name

optional

 

event-request-object-name

constant

optional 

The name of the field containing the javax.servlet.ServletRequest object.

Defaults to "request".

event-sessionresponse-object-name

constant

optional 

The name of the field containing the javax.servlet.ServletResponse object.

Defaults to "response".

event-responsesession-object-name

optional

constant

optional

The name of the field containing the javax.servlet.http.HttpSession object.

Defaults to "session". 

event-response-code-name

constant

optional 

The name of the field containing the event response code.

Defaults to "_response_code_".

event-error-message-name

constant

optional 

The name of the field containing the event error message.

Defaults to "_error_message_".

event-error-message-list-name

constant

optional 

The name of the field containing the event message list.

Defaults to "_error_message_list_".

event-event-message-name

constant

optional 

The name of the field containing the event message.

Defaults to "_event_message_".

event-event-message-list-name

constant

optional

 

The name of the field containing the event message list.

Defaults to "_event_message_list_".

service-response-message-name

constant

optional

The name of the field containing the service response message.

Defaults to "responseMessage".

service-response-message-name

optional

 

service-error-message-name

constant

optional 

The name of the field containing the service error message.

Defaults to "errorMessage".

service-error-message-list-name

constant

optional 

The name of the field containing the service error message list.

Defaults to "errorMessageList".

service-error-message-map-name

constant

optional 

The name of the field containing the service error message map.

Defaults to "errorMessageMap".

service-success-message-name

constant

optional 

The name of the field containing the service success message.

Defaults to "successMessage".

service-success-message-list-name

optional

 

login-required

optional

 

use-transaction

optional

 

locale-name

optional

 

delegator-name

optional

 

security-name

optional

 

constant

optional

The name of the field containing the service success message list.

Defaults to "successMessageList".

 

Child Elements

Name

Requirements

 

(Any block of code)dispatcher-name

optional

 

user-login-name

optional

 

Info
titleProposed Changes
  • Eliminate unused and seldom used attributes.
  • Currently, the method-name attribute is optional. Require the method-name attribute.

Assignment Operations

Assignment operations modify the script's state.

Assignment Operations

Section
Column
width20%
<add-error>
Currently, child elements are optional. Require one child element.
Column
Adds a message to the error message list.
Code Block
xml
xml

<add-error>
  <fail-message message="There was an error" />
</add-error>
Attributes

Name

Type

Requirements

Description

Note

error-list-name

constant

optional

The name of a list that will contain the message.

Default is Defaults to "error_list".

 

Child Elements

One of the following child elements is required:

optional

Name

 

<fail-message>

<fail-property>

optional

Info
titleProposed Changes

message>

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

<fail-property>

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

Section
Column
width20%
<clear
<alt-
field>
permission>
Removes a field from memory.

Attributes

Column
Code Block
xmlxml

<clear-field field="foo" />

field

optional

The name of the field to remove

map-name

optional

The name of the map to remove

Info
titleProposed Changes
  • Currently, the field attribute is optional. Require the field attribute.
  • Eliminate the map-name attribute.
Declares an alternate permission (<check-permission> sub-element).

Alternate permissions are checked when the primary permission check fails.

Attributes

Name

Type

Requirements

Description

Note

permission

constant, ${expression}

required

The permission to check.

 

action

constant, ${expression}

optional

The action to be performed (permission scope).

Examples: "_ADMIN", "_CREATE", "_UPDATE".

Section
Column
width20%
<create-object>
<assert>
Create a new Java object.

Attributes

Column
Code Block
xmlxml

<create-object field="foo" class-name="com.acme.FooClass">
  <string value="bar" />
  <field field="foo" />
</create-object>

field

optional

The name of the field for the new object

class-name

optional

The Java class name

Child Elements

<field>

optional

<string>

optional

Info
titleProposed Changes
  • Currently, both attributes are optional. Require both attributes.
  • Deprecate and replace with scriptlet
Section
Column
width20%
<env-to-env>
Column
Warning

Deprecated. Use <set>.

Section
Column
width20%
<env-to-field>
Column
Warning

Deprecated. Use <set>.

Adds an error message to the error message list for each condition that evaluates to false.
Attributes

Name

Type

Requirements

Description

Note

title

constant, ${expression}

optional

The title of the assert operation.

The title is used in test reports.

error-list-name

constant

optional

The name of a list that will contain the message.

Defaults to "error_list".

 

Child Elements

Name

 

Any <condition> child element

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

Section
Column
width20%
<fail
<check-
message>
id>
Declares a message to be added to a message list.

Attributes

Column
Code Block
xmlxml

<add-error>
  <fail-message message="There was an error" />
</add-error>

message

optional

The message text

Info
titleProposed Changes
  • Currently, the message attribute is optional. Require the message attribute.
Section
Column
width20%
<fail-property>
Column
Declares a property key that is used to add a message to a message list.
Code Blockxmlxml

<add-error>
  <fail-property resource="ErrorMessages" property="FooError" />
</add-error>

Attributes

resource

optional

Name of the resource where the message can be found

property

optional

The message property key

Info
titleProposed Changes
  • Currently, both attributes are optional. Require both attributes.
Evaluates the specified field, and adds an error message to the error message list if the field's value is not a valid data source ID value.

Valid IDs can be any sequence of characters or digits, but they must not contain the following characters: space [ ], double quote ["], single quote ['], ampersand [&], question mark [?], less-than sign [<]\, greater-than sign [>], forward-slash [/], back-slash [\ ].

Attributes

Name

Type

Requirements

Description

Note

field

expression

optional

The name of the field to test.

 

error-list-name

constant

optional

The name of a list that will contain the message.

Defaults to "error_list".

 

Child Elements

One of the following child elements is required:

Name

 

<fail-message>

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

<fail-property>

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

Section
Column
width20%
<field-to-env>
Deprecated. Use <set>.
Column
Warning

Section
Column
width20%
<field-to-field>
Column
Warning

Deprecated. Use <set>.

<check-permission>
Column
Checks if the user has the specified permission, and adds an error message to the error message list if the user does not have the specified permission.

Note that this element must be followed by the <check-errors> element for it to do anything meaningful.

Attributes

Name

Type

Requirements

Description

Note

permission

constant, ${expression}

required

The permission to check.

 

action

constant, ${expression}

optional

The action to be performed (permission scope).

Examples: "_ADMIN", "_CREATE", "_UPDATE".

error-list-name

constant

optional

The name of a list that will contain the message.

Defaults to "error_list".

 

Child Elements

One or more of the following child element is optional:

Name

 

<alt-permission>

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

One of the following child elements is required:

Name

 

<fail-message>

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

<fail-property>

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

Section
Column
width20%
<clear-field>
Column
Sets the value of the specified field to null
Section
Column
width20%
<field-to-list>
Column
Copies a field to a list.
Code Blockxmlxml

<field-to-list list="barList" field="foo" />

Attributes

list

optional

Name of the list. If the list does not exist, one is created.

field

optional

The field to add to the list

Info
titleProposed Changes
  • Currently, both attributes are optional. Require both attributes.
  • Deprecate and replace with UEL expression.
Section
Column
width20%
<field-to-request>
Column
Copies a field to a servlet request attribute
.
Code Block
xml
xml

<field-to-request<clear-field field="foo" request-name="fooAttribute" />
Attributes
field

Name

optional

The name of the field to copy from

request-name

optional

The name of the request attribute to copy to

Type

Requirements

Description

Note

field

expression

required

map-name

optional

The name of the map containing field

Info
titleProposed Changes
  • Currently, all attributes are optional. Require the field and request-name attributes.
  • Eliminate the map-name attribute.
  • Deprecate and replace with a UEL expression.

field to remove.

 

Section
Column
width20%
<field
<create-
to-result>
object>

Attributes

Column
Creates an instance of the specified class.

The <string> and <field> sub-elements are passed to the constructor method as arguments in the order they are specified.
A runtime exception will be thrown if the sub-elements do not match the constructor method arguments.

Code Block
xml
xml
<create-object field="foo" class-name="com.acme.FooClass">
  <string value="bar" />
  <field field="foo" />
</create-object>
Attributes

Name

Type

Requirements

Description

Note

field

expression

required

The name of the field for the new object.

 

class-name

constant

required

The Java class name.

 

 

Child Elements

Name

Requirements

 

<field>

optional

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

<string>

optional

(?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

Warning

Deprecated - use the <script> element

Copies a field to a service OUT attribute.
Code Block
xmlxml

<field-to-result field="foo" result-name="fooAttribute" />

field

optional

The name of the field to copy from

result-name

optional

The name of the service OUT attribute to copy to

map-name

optional

The name of the map containing field

Info
titleProposed Changes
  • Currently, all attributes are optional. Require the field and result-name attributes.
    • Eliminate the map-name attribute

    .

    Section
    Column
    width20%
    <field
    <fail-
    to-session>
    message>
    Column
    Copies a field to a servlet session attribute
    Declares an error message.
    Code Block
    xml
    xml
    
<field-to-session field="foo" session-name="fooAttribute"<add-error>
  <fail-message message="There was an error." />
</add-error>
    Attributes
    field

    Name

    optional

    The name of the field to copy from

    session-name

    optional

    The name of the session attribute to copy to

    map-name

    optional

    The name of the map containing field

    Info
    titleProposed Changes
    • Currently, all attributes are optional. Require the field and session-name attributes.
    • Eliminate the map-name attribute.
    • Deprecate and replace with a UEL expression.

    Type

    Requirements

    Description

    Note

    message

    constant+expr

    required

    The message text.

     

    Section
    Column
    width20%
    <first
    <fail-
    from-list>
    property>
  • Currently, both attributes are optional. Require both attributes.
    • Deprecate and replace with a UEL expression
    Column
    Copies the first element in a list to a field. If the list is empty or not found, sets the field to null
    Declares an error message found in a properties file.
    Code Block
    xml
    xml
    
<first-from-list entry-name="foo" list-name="fooList<add-error>
  <fail-property resource="ErrorMessages" property="FooError" />
</add-error>
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    resource

    constant

    required

    entry-name

    optional

    The name of the field to copy to

    list-name

    optional

    The name of the list to copy from

    Info
    titleProposed Changes

    resource where the message can be found.

     

    property

    constant

    required

    The message property key.

     

    .

    Section
    Column
    width20%
    <list-to-list>
    <field>

    Attributes

    Column
    Declares an environment field to be passed as an argument to an object method call.
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    field

    expression

    required

    Copies list elements to another list. If the target list is not found, a new list is created.
    Code Block
    xmlxml
    
<list-to-list list-name="foo" to-list-name="fooList" />

    list-name

    optional

    The name of the list to copy fromenvironment field to use.

     

    type

    constantto-list-name

    optional

    The name Java class of the list to copy to

    Info
    titleProposed Changes

    argument.

    Defaults to "java.lang.String"

  • Currently, both attributes are optional. Require both attributes.
    • Rename the list-name attribute to from-field or from-list to make the syntax similar to other operators

    .

    Section
    Column
    width20%
    <map
    <field-to-
    map>
    list>
    Column
    Copies map entries to another map. If the target map is not found, a new map is created
    Appends an object to the specified list.
    Code Block
    xml
    xml
    
<map<field-to-maplist map-namelist="foobarList" to-map-namefield="fooMapfoo" />
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    field

    expression

    required

    The field to add to the list.

    The operation does nothing if the field does not exist.

    list

    expression

    required

    Name of the list.

    If the list does not exist, one is created.

    Warning

    Deprecated - use the <set> element

    map-name

    optional

    The name of the map to copy from

    to-map-name

    optional

    The name of the map to copy to

    Info
    titleProposed Changes
  • Currently, both attributes are optional. Require both attributes.
    • Rename the map-name attribute to from-field or from-map to make the syntax similar to other operators

    .

    Section
    Column
    width20%
    <now
    <field-
    date-
    to-
    env>
    request>
  • Currently, the field attribute is optional. Require the attribute.
    • Deprecate and replace with UEL expression
    Column
    Copies a field to a servlet request attribute.

    Valid only when the simple-method is called as an event, it is ignored otherwise

    Creates a java.sql.Date object that is set to the current system time

    .

    Code Block
    xml
    xml
    
<now-date<field-to-envrequest field="foo" request-name="fooDatefooAttribute" />
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    field

    expression

    requiredoptional

    The name of the field

    Info
    titleProposed Changes

    to copy from. The source of the assignment.

    The operation does nothing if the field does not exist.

    request-name

    constant, ${expression}

    optional

    The servlet request attribute name. The target of the assignment.

    Defaults to the value of field attribute.

    Section
    Column
    width20%
    <now
    <field-
    timestamp-
    to-
    env>
    result>
  • Currently, the field attribute is optional. Require the attribute.
    • Deprecate and replace with UEL expression
    Column
    Copies a field to a service OUT attribute.
    Creates a java.sql.Timestamp object that is set to the current system time.
    Code Block
    xml
    xml
    
<now<field-timestamp-to-envresult field="fooDatefoo" result-name="fooAttribute" />
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    field

    expression

    optionalrequired

    The name of the field

    Info
    titleProposed Changes

    to copy from. The source of the assignment.

    The operation does nothing if the field does not exist.

    result-name

    expression

    optional

    The name of the result field to set. The target of the assignment.

    Defaults to the value of field attribute.

    Section
    Column
    width20%
    <order-by>
    Child element of <order-map-list>
    <field-to-session>
    field to a servlet session attribute.

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

    Column
    Defines
    Copies a
    map key to sort on.
    Code Block
    xmlxml
    
<order-map-list list="fooList">
    <order-by field="fooKey" />
</order-map-list>
    Code Block
    xml
    xml
    <field-to-session field="foo" session-name="fooAttribute" />
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    field

    expression

    required

    The name of the field to copy from. The source of the assignment.

    The operation does nothing if the field does not exist.

    session-name

    constant, ${expression}

    optional

    The servlet session attribute name. The target of the assignment.

    Defaults to the value of field attribute.

    Attributes

    field

    optional

    The name of the key to sort on

    Section
    Column
    width20%
    <order
    <first-
    map
    from-list>
    Column
    Sorts
    Assigns the first (lowest order) entry in a list
    of maps
    to a field.
    Code Block
    xml
    xml
    
<order<first-mapfrom-list listentry-name="fooListfoo">
    <order-by field list="fooKeyfooList" />
</order-map-list>
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    entry-name

    expression

    required

    list

    optional

    The name of the list to be sorted

    Child Elements

    <order-by>

    optional

    Defines a map key to sort on

    Info
    titleProposed Changes
    • Currently, the list attribute is optional. Require the attribute.
    • Currently, the child elements are optional, and the operator throws an exception at run time when none are found. Require at least one child element.
    Section

    field to set.

     

    list

    expression

    required

    The name of the list that contains the object to copy.

    Defaults to a null value if the list does not exist or is empty.

    Warning

    Deprecated - use the <set> element.

    Section
    Column
    width20%
    <list-to-list>
    Column
    Copies list elements to another list
    Column
    width20%
    <property-to-field>
    Currently, all attributes are optional. Require the field, resource, and property attributes
    Column
    Assigns a resource property to a field
    .
    Code Block
    xml
    xml
    
<property<list-to-fieldlist fieldlist="foo" resourceto-list-name="fooResource.propertiesfooList" property="fooKey" />
    Attributes
    field

    Name

    optional

    The name of the field

     

    resource

    optional

    The resource that contains the property

     

    property

    optional

    The property key

     

    default

    optional

    A default value to be used when the property is not found

     

    no-locale

    optional

    If "true" no localization will be performed on the property's value

    Default is "false"

    arg-list-name

    optional

    The name of a field that contains a list of arguments to be used in formatted property values

     

    Info
    titleProposed Changes

    Type

    Requirements

    Description

    Note

    list

    expression

    required

    The name of the list to copy from.

    Operation does nothing if the list does not exist.

    to-list-name

    expression

    required

    Name of the list to copy to.

    If the list does not exist, one will be created.

    Section
    Column
    width20%
    <request-parameters
    <map-to-
    list>
    map>
    Column
    Copies
    request parameters to a list
    a map to another map.
    Code Block
    xml
    xml
    
<request-parameters<map-to-listmap list-namemap="fooListoldMap" requestto-namemap="fooParameternewMap" />
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    map

    expression

    required

    The name of the map to copy from.

    Operation does nothing if the map does not exist.

    to-map

    expression

    list-name

    optional

    Name of the list. If the list does not exist, one is created.

    request-name

    optional

    The name of the request parameter. All parameter values will be added to the list

    Info
    titleProposed Changes

    map to copy to.

    If this attribute is empty, the source map will be copied to the current environment

  • Currently, both attributes are optional. Require both attributes.
  • Rename the list-name attribute to list - to make the syntax similar to other operators.
    • Rename the request-name attribute to parameter-name - to make the syntax clearer

    .

    Section
    Column
    width20%
    <request-to-field>
    <now>
    Column
    Copies
    Sets a
    Servlet request attribute to a field
    field to the current system time.
    Code Block
    xml
    xml
    
<request-to-field<now field="foofooNow" request-name="fooAttribute" />
    Attributes
    field

    Name

    Type

    Requirements

    Description

    Note

    field

    expression

    required

    optional

    The name of the field for the new object

    request-name

    optional

    The name of the request attribute

    default

    optional

    A default constant value - used if the request attribute does not exist

    map-name

    optional

    The name of the map containing field

    Info
    titleProposed Changes
    • Currently, the field and request-name attributes are optional. Require both attributes.
    • Eliminate the map-name attribute.
    • Rename the request-name attribute to attribute-name - to make the syntax clearer.

    field to set, the target of the assignment.

     

    type

    constant

    optional

    The field data type.

    Defaults to "java.sql.Timestamp".

    Section
    Column
    width20%
    <session
    <now-date-to-
    field>
    env>
    Column
    Copies
    Sets a
    Servlet session attribute
    field to a
    field
    java.sql.Date object initialized to the current system time.
    code
    Attributes
    xml

    Name

    		xml
    
<session-to-field field="foo" session-name="fooAttribute" />

    Type

    Requirements

    Description

    Note

    field

    expression

    required

    Attributes

    field

    optional

    The name of the field for the new object

    session-name

    optional

    The name of the session attribute

    default

    optional

    A default constant value - used if the session attribute does not exist

    map-name

    optional

    The name of the map containing field

    field to set, the target of the assignment.

     

    Warning

    Deprecated - use the <now> element

    Info
    titleProposed Changes
  • Currently, the field and session-name attributes are optional. Require both attributes.
  • Eliminate the map-name attribute.
    • Rename the session-name attribute to attribute-name - to make the syntax clearer

    .

    Section
    Column
    width20%
    <set>
    <now-timestamp>
    Column
    Assigns
    Sets a
    value to a field.
    field to a java.sql.Timestamp object initialized to the current system time.
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    field

    expression

    required

    The name of the field to set, the target of the assignment.

     

    Warning

    Deprecated - use the <now> element.

    Section
    Column
    width20%
    <order-by>
    Column
    Declares a field or map key to sort on.
    Code Block
    xml
    xml
    
<set field<order-map-list list="foofooList">
 value="bar" />
<set field="baz" from<order-by field="foofooKey" />
</order-map-list>
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    field

    expression

    optionalrequired

    The name of the field to set (the l-value)or map key to sort on.

     

    from-field

    optional

    The name of a field to copy from (the r-value)

     

    value

    optional

    A constant value

     

    default-value

    optional

    A default constant value - used if from-field evaluates to null

     

    type

    optional

    The Java data type of field

    Defaults to "String"

    set-if-null

    optional

    Controls if field can be set to null.

    Defaults to "false"

    set-if-empty

    optional

    Controls if field can be set to an empty value. The meaning of "empty" depends on the Java data type.

    Defaults to "true"

    Info
    titleProposed Changes
    • Currently, the field attribute is optional. Require the field attribute.
    • Currently, the from-field and value attributes are optional. Require one of the two attributes.
    • Add a new attribute: from-script. The attribute will be used exclusively for scriptlets that are currently found in other attributes.
    • Rename the from-field attribute to from. The attribute will be used exclusively for UEL expressions.
    • Change the behavior of the value attribute: The attribute will be used exclusively for string constants.
    • Rename the default-value attribute to default.
    • Remove the type attribute default.
    Section
    Column
    width20%
    <order-map-list>
    Column
    Sorts a list of maps.

    Maps are sorted by the keys specified in the <order-by> sub-elements.

    Code Block
    xml
    xml
    <order-map-list list="fooList">
    <order-by field="fooKey" />
</order-map-list>
    Attributes

    Name

    Type

    Requirements

    Description

    Note

    list

    expression

    required

    The name of the list to be sorted.

    The operation does nothing if the list is not found.

     

    Child Elements

    One or more of the following child element is required:

    Name

     

    <order-by>

    (?) (https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{}})

    Section
    Column
    width20%
    <set
    <property-to-
    calendar>
    field>
    Column
    Performs a Timestamp adjustment operation
    Assigns a resource property value to a field.
    Code Block
    xml
    xml
    
<set-calendar<property-to-field field="tomorrowStampfoo" from-fieldresource="nowTimestampfooResource.properties" dayproperty="1fooKey" />
<set-calendar field="yesterdayStamp" from-field="nowTimestamp" day="-1" />

    Attributes

    Attributes
    Name
    Type
    Requirements
    Description
    Note
    field
    expression
    required
    field
    optional
    The name of the field to set (the l-value)
    from-field
    , the target of the assignment.
     
    resource
    constant, ${expression}
    requiredoptional
    The name of a field to copy from (the r-value)
    value
    optional
    A constant value
    default-value
    optional
    A default constant value - used if from-field evaluates to null
    type
    optional
    The Java data type of field
    years
    optional
    A signed integer adjustment amount
    months
    optional
    A signed integer adjustment amount
    days
    optional
    A signed integer adjustment amount
    hours
    optional
    A signed integer adjustment amount
    minutes
    optional
    A signed integer adjustment amount
    seconds
    optional
    A signed integer adjustment amount
    millis
    optional
    A signed integer adjustment amount
    period-align-start
    optional
    Set the adjusted Timestamp to period start: "day", "week", "month", "year"
    period-align-end
    optional
    Set the adjusted Timestamp to period end: "day", "week", "month", "year"
    locale
    optional
    The locale (calendar) to be used for the operation
    time-zone
    optional
    The time zone to be used for the operation
    properties resource. Can be a file on the classpath or a resource defined in the SystemProperty entity.
     
    property
    constant, ${expression}
    required
    The property key.
     
    default
    constant, ${expression}
    optional
    The default value to use if the property value is null or empty.
     
    no-locale
    constant
    optional
    Suppress property value localization. The user's/system locale will be ignored when retrieving the property value.
    Default is "false".
    arg-list
    expression
    optional
    The name of an argument list to be used with a formatting string. The argument list is applied to the property value.
    The attribute does nothing if the argument list is not found. See the java.text.MessageFormat class for more information.
     Section
     Column
    width20%
    <request-parameters-to-list>
  • Currently, the field attribute is optional. Require the field attribute.
  • Currently, the from-field and value attributes are optional. Require one of the two attributes.
  • Rename the from-field attribute to from. The attribute will be used exclusively for UEL expressions.
  • Change the behavior of the value attribute: The attribute will be used exclusively for string constants.
    • Remove the default-value attribute. The value attribute will be used for default constant values
     Column
    Appends a servlet request parameter list to a list.
    Valid only when the simple-method is called as an event, it is ignored otherwise.
     Code Block
    xml
    xml
    <request-parameters-to-list list="fooList" request-name="fooParameter" />

    Attributes
    Name
    Type
    Requirements
    Description
    Note
    request-name
    constant, ${expression}
    required
    The name of the servlet request parameter. All matching parameter values will be added to the list.
     
    list
    expression
    optional
    The name of the list.
    If the list does not exist, one will be created. Defaults to the request-name attribute value
     Info
    titleProposed Changes
    .
     Section
     Column
    width20%
    <set
    <request-
    service
    to-
    fields>
    field>
     Column
    Copies 
     map entries that match a service definition to another map. If the target map is not found, a new map is created
    a servlet request attribute to a field.
    Valid only when the simple-method is called as an event, it is ignored otherwise.
     Code Block
    xml
    xml
    
<set<request-serviceto-fieldsfield service-namefield="fooServicefoo" map="barMap" to-maprequest-name="fooServiceAttributesfooAttribute" />

    Attributes
    service-name
    Name
    optional
    The name of the service
    map
    optional
    The name of the map to copy from
    Type
    Requirements
    Description
    Note
    field
    expression
    required
    to-map
    optional
    The name of the map to copy tofield to set, the target of the assignment.
     
    request-name
    constant, ${expression}error-list
    optional
    The servlet request attribute name of a list to copy error messages to
     Info
    titleProposed Changes
    .
    Defaults to the value of field attribute.
    default
    constant, ${expression}
    optional
    A default value to use if the request attribute does not exist.
     
  • Currently, the service-name, map, and to-map attributes are optional. Require all three attributes.
    • Eliminate the error-list attribute, error messages are added to the result map
     Section
     Column
    width20%
    <string
    <session-to-
    append>
    field>
     Column
     Info
    titleProposed Changes
    Deprecate and replace with <set>
     Section
     Column
    width20%
    <string-to-field>
     Column
     Info
    titleProposed Changes
    Deprecate and replace with <set>
     Section
     Column
    width20%
    <string-to-list>
     Column
     Info
    titleProposed Changes
    Deprecate and replace with <set>
     Section
     Column
    width20%
    <to-string>
     Column
     Info
    titleProposed Changes
    Deprecate and replace with <set>
    Copies a servlet session attribute to a field.
    Valid only when the simple-method is called as an HTTP event, it is ignored otherwise.
     Code Block
    xml
    xml
    <session-to-field field="foo" session-name="fooAttribute" />

    Attributes
    Name
    Type
    Requirements
    Description
    Note
    field
    expression
    required
    The name of the field to set, the target of the assignment.
     
    session-name
    constant, ${expression}
    optional
    The servlet session attribute name.
    Defaults to the value of the field attribute.
    default
    constant, ${expression}
    optional
    A default value to use if the session attribute does not exist.
     
     Section
     Column
    width20%
    <webapp-property-to-field>
    <set>
     Column
    Copies a ServletContext resource property to a field
    Assigns a field from an expression or script, or from a constant value.
     Code Block
    xml
    xml
    
<webapp-property-to-field field="foo" resource="fooResource" property="fooKey" />

    Attributes
    <set field="foo" value="bar" />
<set field="baz" from="foo" />
<!-- Field "baz" contains the string "bar" -->

    Attributes
    Name
    Type
    Requirements
    Description
    Notes
    field
    expression
    required
    field
    optional
    The name of the field for the new object
    resource
    optional
    The resource that contains the property
    property
    optional
    The property key
    default
    optional
    A default value to be used when the property is not found
    map-name
    optional
    The name of the map containing field
     Info
    titleProposed Changes
    • Currently, the field, resource and property attributes are optional. Require all three attributes.
    • Eliminate the map-name attribute.
    Conditional/Looping Statements
     Info
    titleProposed Changes
    Add <continue> and <break> looping sub-elements.
    to set, the target of the assignment.
     
    from
    expression, script
    required if value is empty
    An expression or script that returns an object or null.
    The script must be prefixed with the script language followed by a colon (":").
    value
    constant+expr
    required if from is empty
    A constant value.
    Default type = "java.lang.String".
    default
    constant, ${expression}
    optional
    A default value that is used when the from attribute evaluates to null or empty.
     
    type
    constant
    optional
    The Java data type of field.
    "NewList" will create a new java.util.List, "NewMap" will create a new java.util.Map. Otherwise, the attribute must contain a valid Java class name.
    locale
    constant, ${expression}
    optional
    If a locale dependent type is passed allows to i18n the value.
    Defaults to environment locale.
    set-if-null
    constant
    optional
    Controls if field can be set to null.
    Defaults to "false".
    set-if-empty
    constant
    optional
    Controls if field can be set to an empty value. The meaning of "empty" depends on the Java data type.
    Defaults to "true".
     Section
     Column
    width20%
    <set-calendar>
     Column
    Adjusts a Timestamp by a specified time duration.
     Code Block
    xml
    xml
    <set-calendar field="tomorrowStamp" from-field="nowTimestamp" day="1" />
<set-calendar field="yesterdayStamp" from-field="nowTimestamp" day="-1" />

    Attributes
    Name
    Type
    Requirements
    Description
    Notes
    field
    expression
    required
    The name of the field to set, the target of the assignment.
     
    from
    expression, script
    required if value is empty
    An expression or script that returns an object or null.
    The script must be prefixed with the script language followed by a colon (":").
    value
    constant+expr
    required if from is empty
    A constant value.
    Default type = "java.lang.String".
    default
    constant, ${expression}
    optional
    A default value that is used when the from attribute evaluates to null or empty.
     
    set-if-null
    constant
    optional
    Controls if field can be set to null.
    Defaults to "false".
    years
    constant, ${expression}
    optional
    Add (optionally using +) or subtract (using -) a number of year(s).
    If an expression is used, it should evaluate to an integer.
    months
    constant, ${expression}
    optional
    Add (optionally using +) or subtract (using -) a number of month(s).
    If an expression is used, it should evaluate to an integer.
    days
    constant, ${expression}
    optional
    Add (optionally using +) or subtract (using -) a number of days(s).
    If an expression is used, it should evaluate to an integer.
    hours
    constant, ${expression}
    optional
    Add (optionally using +) or subtract (using -) a number of hour(s).
    If an expression is used, it should evaluate to an integer.
    minutes
    constant, ${expression}
    optional
    Add (optionally using +) or subtract (using -) a number of minute(s).
    If an expression is used, it should evaluate to an integer.
    seconds
    constant, ${expression}
    optional
    Add (optionally using +) or subtract (using -) a number of second(s).
    If an expression is used, it should evaluate to an integer.
    millis
    constant, ${expression}
    optional
    Add (optionally using +) or subtract (using -) a number of milli-second(s).
    If an expression is used, it should evaluate to an integer.
    period-align-start
    constant, ${expression}
    optional
    Align the adjusted date to the start of a period: "day", "week", "month", "year"
     
    period-align-end
    constant, ${expression}
    optional
    Align the adjusted date to the end of a period: "day", "week", "month", "year"
     
    locale
    constant, ${expression}
    optional
    The locale (calendar) to be used for the operation
    Defaults to the environment locale.
    time-zone
    constant, ${expression}
    optional
    The time zone to be used for the operation
    Defaults to the environment time zone.
     Section
     Column
    width20%
    <and>
     Column
    Combines conditional elements using a boolean AND.
     Code Blockxmlxml
    
<if>
    <condition>
        <and>
            <if-compare field="colorModel" operator="equals" value="RYB" />
            <or>
                <if-compare field="color" operator="equals" value="red" />
                <if-compare field="color" operator="equals" value="yellow" />
                <if-compare field="color" operator="equals" value="blue" />
            </or>
        </and>
    </condition>
    <then>
        <set field="isPrimaryColor" value="true" type="Boolean" />
    </then>
    <else>
        <set field="isPrimaryColor" value="false" type="Boolean" />
    </else>
</if>

     Section
     Column
    width20%
    <assert>
     Column
    Evaluates each contained condition independently, and adds an error message to the error message list for each condition that does not evaluate to true.
    Attributes
    title
    optional
    The assertion title - used in error messages to identify the assertion
     
    error-list-name
    optional
    The name of the error list
    Defaults to "error_list"
    Child Elements
    Any <condition> child element
    optional
    A condition to test
     Info
    titleProposed Changes
    • Currently, the title attribute is optional. Keep the title attribute optional but have it default to the file location and line number.
    • Eliminate the error-list-name attribute.
    • Currently, the child element is optional. Require at least one child element.
     Section
     Column
    width20%
    <check-id>
  • Currently, the field attribute is optional. Require the field attribute.
  • Eliminate the map-name and error-list-name attributes.
    • Currently, the child elements are optional. Require one child element.
     Column
    Evaluates the specified field, and adds an error message to the error message list if the field's value is not a valid database ID value.
    Attributes
    field
    optional
    The name of the field to validate
     
    map-name
    optional
    The name of the map containing field
     
    error-list-name
    optional
    The name of the error list
    Defaults to "error_list"
    Child Elements
    <fail-message>
    optional
    <fail-property>
    optional
     Info
    titleProposed Changes