Page History

...

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, 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();"

...

Section

Column

width	20%

`<first-from-list>`

Column

Copies

Assigns the first

element

(lowest order) entry in a list to a

field. If the list is empty or not found, sets the

field

to null

.

Code Block

	xml
	xml

<first-from-list entry-name="foo" list-name="fooList" />

Attributes

Name	Type	Requirements	Description	Note
entry-name	expression	optionalrequired	The name of the field to copy toset.
list-name	expression	optionalrequired	The name of the list to copy fromthat 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.

Note

title	Draft Status

Final draft

Info

title	Proposed Changes

Currently, both attributes are optional. Require both attributes.

Deprecate and replace with a UEL expression

.

Section

Column

width	20%

`<list-to-list>`

Column

Copies list elements to another list.

If the target list is not found, a new list is created.

Code Block

xml
	xml

<list-to-list list-name="foo" to-list-name="fooList" />

Attributes

Name	Type	Requirements	Description	Note
list-name	expression	requiredoptional	The name of the list to copy from.	Operation does nothing if the list does not exist.
to-list-name	expression	optionalrequired	The name Name of the list to copy to.	If the list does not exist, one will be created.

Noteinfo

title	Proposed Changes	Draft Status

Final draft

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

width	20%

`<map-to-map>`

Column

Copies a map

entries

to another map.

If the target map is not found, a new map is created.

Code Block

	xml

Code Block

xml
	xml

<map-to-map map-name="foooldMap" to-map-name="fooMapnewMap" />

Attributes

Name	Type	Requirements	Description	Note
map-name	expression	optionalrequired	The name of the map to copy from.	Operation does nothing if the map does not exist.
to-map-name	expression	optional	The name of the map to copy to

Info

title	Proposed 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.

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

Note

title	Draft Status

Final draft.

Section

Column

width	20%

Section

Column

width	20%

`<now>`

Column

Sets a field to the current system time.

Code Block

	xml
	xml

<now field="fooNow" />

Attributes

Name	Type	Requirements	Description	Note
field	expression	required	The name of the field to set, the target of the assignment.
type	constant	optional	The Java field data type of field.	Defaults to "java.sql.Timestamp".

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<now-date-to-env>`

Deprecated - use `<now>`.

Column

Note

title	Draft Status

Final draft.

Section

Sets a field to a `java.sql.Date` 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

Column

width	20%

`<now-timestamp>`

column


Deprecated - use the `<now>` element.

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<order-by>`

Child element of <order-map-list>

`<now-timestamp>`

field to a `java.sql.Timestamp` object initialized to the current system time.

Attributes

Column
Defines Sets a map key to sort on.
Code Block
xml	xml
<order-map-list list="fooList"> <order-by field="fooKey" /> </order-map-list>

Name	Type	Requirements	Description	Note
field	expression	required

Attributes

field

optional

The name of the key to sort onfield to set, the target of the assignment.

Warning
Deprecated - use the `<now>` element.

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<order-`

map-list>

`by>`

Column

Sorts a list of maps

Defines a field or map key to sort on.

Code Block

	xml
	xml

<order-map-list list="fooList">
    <order-by field="fooKey" />
</order-map-list>

Attributes

Name	Type	Requirements	Description	Note
field	expression	required	list	optional	The name of the list to be sorted

Child Elements

<order-by>

optional

Defines a field or map key to sort on.

Infonote

title	Proposed Changes	Draft Status

Final draft

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

Column

width	20%

<property

`<order-`

to

`map-`

field>

`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

Assigns a resource property to a field.

Code Block
xml	xml	<property-to-field field="foo" resource="fooResource.properties" property="fooKey" /> </order-map-list>

Attributes

Name	Type	Requirements	Description	Note
list	expression	required	field	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

title	Proposed Changes

Currently, all attributes are optional. Require the field, resource, and property attributes.

list to be sorted.

Operation does nothing if the list is not found.

Child Elements

Name	Requirements
`<order-by>`	required

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<property-to-field>`

Column

Assigns a resource property value to a field.

Code Block

	xml
	xml


<property-to-field field="foo" resource="fooResource.properties" property="fooKey" />

Attributes

Name	Type	Requirements	Description	Note
field	expression	required	The name of the field to set, the target of the assignment.
resource	constant, ${expression}	required	The name of a 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 retriving the property value.	Default is "false".
arg-list	expression	optional	An argument list to be used with a formatting string. The argument list is applied to the property value.	Does nothing if the argument list is not found. See the java.text.MessageFormat class for more information.

Note

title	Draft Status

Final draft

Section

Column

width	20%

`<request-parameters-to-list>`

Attributes

Column
Copies request parameters to a list.
Code Block
xml	xml
<request-parameters-to-list list-name="fooList" request-name="fooParameter" />

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

title	Proposed Changes

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

width	20%

`<request-parameters-to-`

field>

`list>`

Column

Copies

Appends a

Servlet

servlet request

attribute to a field

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-fieldlist fieldlist-name="foofooList" request-name="fooAttributefooParameter" />

Attributes

fieldThe name of the field for the new object

Name	Type	Requirements	optional	Description	Note
request-name	constant, ${expression}	requiredoptional	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

title	Proposed 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.

Section

servlet request parameter. All matching parameter values will be added to the list.
list-name	expression	optional	Name of the list. If the list does not exist, one is created.	Defaults to the request-name attribute value.

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<request`

Column

width	20%

<session

`-to-field>`

Column

Copies a

Servlet session

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

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

Attributes

Name	Type	Requirements	Description	Note
field	expression	optionalrequired	The name of the field for the new objectsession-nameto set, the target of the assignment.
request-name	constant, ${expression}	optional	The servlet request attribute name of the session attribute.	Defaults to the value of field attribute.
default	constant, ${expression}default	optional	A default constant value - used to use if the session request attribute does not exist.
map-name	optional	The name of the map containing field

Noteinfo

title	Proposed Changes	Draft Status

Final draft

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

width	20%

<set>

`<session-to-field>`

Column

Copies a servlet session attribute to a field.

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

Assigns a field from an expression or script, or from a constant value

.

Code Block

	xml
	xml

<set<session-to-field field="foo" value="bar" />
<set field="baz" from="foo" />
<!-- Field "baz" contains the string "bar" --session-name="fooAttribute" />

Attributes

Name	Type	Requirements	Description	NotesNote
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"
session-name	constant, ${expression}	optional	The servlet session attribute name.	Defaults to the value of field attribute.
default	constant, ${expression}	default	constant+expr, expression	optional	A default value - used if from evaluates to null	Expressions must be enclosed in ${}
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`
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"

Note

title	Draft Status

Final draft.

to use if the session attribute does not exist.

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<set>`

Column

Assigns a field from an expression or script, or from a constant value.

Code Block

	xml
	xml


<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

Section

Column

width	20%

`<set-calendar>`

Attributes

Column
Performs a Timestamp adjustment operation.
Code Block
xml	xml
<set-calendar field="tomorrowStamp" from-field="nowTimestamp" day="1" /> <set-calendar field="yesterdayStamp" from-field="nowTimestamp" day="-1" />

field	optional	The name of the field to set (the l-value)
from-field	optional	The name of a field to copy from (the r-value)
value	optional	A constant value
, 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}default-value	optional	A default constant value - used if from-field evaluates to null.
type	constant	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

Info

title	Proposed 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.
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.

.	"NewList" will create a new `java.util.List`, "NewMap" will create a new `java.util.Map`.
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".

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<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 - used if from evaluates to null.
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`.
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".
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 start of a period: "day", "week", "month", "year"
locale	constant, ${expression}	optional	The locale (calendar) to be used for the operation
time-zone	constant, ${expression}	optional	The time zone to be used for the operation

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<set-service-fields>`

Column

Copies elements from a source map that match a service's IN attributes to a target map.

Code Block

	xml
	xml


<set-service-fields service-name="fooService" map="barMap" to-map="fooServiceAttributes" />

Attributes

Name	Type	Requirements	Description	Notes
service-name	constant, ${expression}	required	The name of the service.
map	expression	required	The name of the map to copy the matching IN attributes from.	The operation does nothing if the map does not exist.
to-map	expression	required	The name of the map to copy the matching IN attributes to.	If the map does not exist, a new one is created.

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<string-append>`

Column

Performs string concatenation and formatting.

The operation starts by applying an argument list (if found) to the string attribute value, the result is prepended by the prefix attribute value, and the suffix attribute value is appended to the result. If the string specified in the field attribute exists, the final result is appended to it, else the field is set to the final result.
Attributes

Name	Type	Requirements	Description	Notes
field	expression	required	The name of the field to set, the target of the assignment.
string	constant, ${expression}	required	The string to append to the field named in the field attribute.	This can be a formatting string that is used with the argument list specified in the arg-list attribute.
arg-list	expression	optional	An argument list to be used with a formatting string. The argument list is applied to the string attribute value.	Does nothing if the argument list is not found. See the java.text.MessageFormat class for more information.
prefix	constant, ${expression}	optional	A string that will be prepended to the string attribute value.
suffix	constant, ${expression}	optional	A string that will be appended to the string attribute value.

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<string-to-list>`

Column

Adds a string to a list of strings.

Attributes

Name	Type	Requirements	Description	Notes
string	constant, ${expression}	required	The string to add to the list specified in the list attribute.
list	expression	required	List to add the string to.	If the list does not exist, one will be created.
arg-list	expression	optional	An argument list to be used with a formatting string. The argument list is applied to the string attribute value.	Does nothing if the argument list is not found. See the java.text.MessageFormat class for more information.
message-field	constant	optional	Inserts a message above a field (used in conjunction with @fieldErrors FTL macro).

Warning
Deprecated - use the `<set>` element.

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<set-service-fields>`

Attributes

Column
Copies map entries that match a service definition to another map. If the target map is not found, a new map is created.
Code Block
xml	xml
<set-service-fields service-name="fooService" map="barMap" to-map="fooServiceAttributes" />

service-name	optional	The name of the service
map	optional	The name of the map to copy from
to-map	optional	The name of the map to copy to
error-list	optional	The name of a list to copy error messages to

Info

title	Proposed Changes

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

width	20%

<string

`<to-`

append>

`string>`

Column

Info

title	Proposed Changes

Deprecate and replace with <set>

Section

Column

width	20%

`<string-to-field>`

Column

Info

title	Proposed Changes

Deprecate and replace with <set>

Section

Column

width	20%

`<string-to-list>`

Column

Info

title	Proposed Changes

Deprecate and replace with <set>

Converts an object to a string.

Attributes

Name	Type	Requirements	Description	Notes
field	expression	required	The name of the field containing the object to convert.	The operation does nothing if the object is not found.
format	constant	optional	Format to use for the conversion.
numeric-padding	constant	optional	Left-pad the string with the specified number of zeroes.

Warning
Deprecated - use the `<set>` element.

Note

title	Draft Status

Final draft.

Section

Column

width	20%

`<to-string>`

Column

Info

title	Proposed Changes

Deprecate and replace with <set>

Section

Column

width	20%

`<webapp-property-to-field>`

Column

Copies a property value from a properties file in a ServletContext resource

property

to a field.

Code Block

	xml
	xml

<webapp-property-to-field field="foo" resource="fooResource/WEB-INF/foo.properties" property="fooKey" />

Attributes

Name	Type	Requirements	Description	Notes
field	expression	optionalrequired	The name of the field for the new object
resource	optional	The resource that contains the property
to set, the target of the assignment.
resource	constant, ${expression}	required	The resource location of the properties file inside the webapp, and relative to the root of the webapp (can be inside a war file).	Example: "/WEB-INF/myprops.properties".
property	constant, ${expression}	required	property	optional	The property key.
default	constant, ${expression}	optional	A default value to be used when use if the property is not found
map-name	optional	The name of the map containing field
value is null or empty.

Note

title	Draft Status

Final draft

Info

title	Proposed Changes

Currently, the field, resource and property attributes are optional. Require all three attributes.

Eliminate the map-name attribute

.

Conditional/Looping Statements

...

Space shortcuts

Child pages

Page History

Versions Compared

Old Version 70

New Version 71

Key

<first-from-list>

Assigns the first

(lowest order) entry in a list to a

field

.

<list-to-list>

Copies list elements to another list.

<map-to-map>

Copies a map

to another map.

<now>

Sets a field to the current system time.

<now-date-to-env>

Deprecated - use <now>.

Sets a field to a java.sql.Date object initialized to the current system time.

<now-timestamp>

<order-by>

<now-timestamp>

Sets a

field to a java.sql.Timestamp object initialized to the current system time.

<order-

by>

Defines a field or map key to sort on.

<order-

map-

list>

Sorts a list of maps.

Assigns a resource property to a field.

<property-to-field>

Assigns a resource property value to a field.

<request-parameters-to-list>

Copies request parameters to a list.

<request-parameters-to-

list>

Appends a

servlet request

parameter list to a list.

<request

-to-field>

Copies a

servlet request attribute to a field.

<session-to-field>

Copies a servlet session attribute to a field.

<set>

Assigns a field from an expression or script, or from a constant value.

<set-calendar>

Performs a Timestamp adjustment operation.

<set-calendar>

Adjusts a Timestamp by a specified time duration.

<set-service-fields>

Copies elements from a source map that match a service's IN attributes to a target map.

<string-append>

Performs string concatenation and formatting.

<string-to-list>

Adds a string to a list of strings.

<set-service-fields>

Copies map entries that match a service definition to another map. If the target map is not found, a new map is created.

<to-

string>

<string-to-field>

<string-to-list>

Converts an object to a string.

<to-string>

<webapp-property-to-field>

Copies a property value from a properties file in a ServletContext resource

to a field.

Conditional/Looping Statements

`<first-from-list>`

`<list-to-list>`

`<map-to-map>`

`<now>`

`<now-date-to-env>`

Deprecated - use `<now>`.

Sets a field to a `java.sql.Date` object initialized to the current system time.

`<now-timestamp>`

`<order-by>`

`<now-timestamp>`

field to a `java.sql.Timestamp` object initialized to the current system time.

`<order-`

`by>`

`<order-`

`map-`

`list>`

`<property-to-field>`

`<request-parameters-to-list>`

`<request-parameters-to-`

`list>`

`<request`

`-to-field>`

`<session-to-field>`

`<set>`

`<set-calendar>`

`<set-calendar>`

`<set-service-fields>`

`<string-append>`

`<string-to-list>`

`<set-service-fields>`

`<to-`

`string>`

`<string-to-field>`

`<string-to-list>`

`<to-string>`

`<webapp-property-to-field>`