The following very simple example of a custom function illustrates the required structure of a function called add, with the Java annotation that displays the tooltip for the function (beginning at
@FunctionJavadoc in the example below).
synopsis Add the description of the function in the synopsis parameter.
domain Shows where the function can be used. This text is informational only. It does not appear in the tooltip. The code controlling where the function can be used (and the decorations that appear) is in the function catalog. See
<isActionOnly>,
<isValidInQuery>,
<isValidInBUI> in
Table 27, Function Catalog Elements.
version Specify the version of TIBCO BusinessEvents that this function supports. Informational only.
see Provide a URL for additional information.
mapper Set to true if the function uses the XSLT Mapper feature. The Mapper decoration is added if the function catalog has a <mapper> element. In the function catalog file is more detailed code to support use of functions in the XSLT Mapper.