Describing global functions in a .xml file

A global function must be described in a .xml file for the function to be displayed in the WebSphere® Multichannel Bank Transformation Toolkit visual editors. This topic provides a description of the tags that must be used to describe a global function.

Figure 1 is an example of a global function definition. For detailed descriptions of the tags in a global function definition, refer to the following sections in this topic:
Figure 1. Example of a global function definition.

The <functions> tag

The <functions> tag contains one or more <function> tags.

The <function> tag

The <function> tag describes a function. It may contain 0 or 1 <parameters> tags. The following is list of attributes of Function tag.
Table 1. Attributes of the <function> tag.
Attribute Description
name The name of the function. It should be unique in a file.
return type The return type of the function such as String, Date, Number and Boolean.
description The description of this function. The description will be shown in visual editor tool when mouse hovers on the function. The field supports NLS when it starts with %.
isServer Specifies whether the function can be used on the server side. If set to false, the function is not displayed in transaction editors. The default value is true.
isClient Specifies whether the function can be used on client side. If set to false, the function is not displayed on the XUI editor. The default value is true.

The <parameters> tag

The <parameters> tag contains one or more <parameter> tag to describe parameters of a function.

The <parameter> tag

The <parameter> tag describes a parameter of a function. The following is list of attributes of a <parameter> tag.
Table 2.
Attribute Description
name The name of the parameter that is displayed in visual editors.
description The description of the parameter. It supports NLS when it starts with %.
type The data type of the parameter such as String, Date, Number and Boolean