Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 16 Functions : Function Tooltips and Decorations

Function Tooltips and Decorations
Tool Tips
When you float the curser over a function in the registry, TIBCO BusinessEvents displays the description and syntax in a tool tip next to the curser. Tooltips also form the online reference to the function catalogs. See TIBCO BusinessEvents Functions Reference in the HTML documentation.
Decorations Indicating Where Functions can be Called
Some functions are decorated with small letters that indicate useful information about use of the function. A function can have zero, one, or more decorations. the following figure shows all the available decorations. They are described in the sections after the figure:
Mapper Functions
Functions that bring up the XSLT mapper and XPath builder are identified by a small m at the upper left of the f, for example: . For more on using mapper functions, see Using the Function Argument Mapper.
Functions That Can Be Used in TIBCO BusinessEvents Decision Manager
Functions that can be used in TIBCO BusinessEvents Decision Manager are marked with a small table icon, for example (which is also an action-only function).
Validity Decorations
Some functions can be used only in rule actions, some in rule actions and rule conditions, and some in actions, conditions, and in queries.
Functions that can be used in actions and conditions have no decoration. They are considered to have the default validity.
Action-Only Functions
These functions are for use in rule actions only. Some of these functions have side effects, for example they can change values. Other functions are limited to actions for other reasons. These action-only functions are identified by a small a at the bottom right of the f. For example: .
Functions That Can Be Used in Queries or with Pattern Matcher
Functions that can be used in queries or with Pattern Matcher are marked with a blue q for example, , for example. You can call such functions in a query string.
They are also valid in rule actions and conditions.
See documentation for TIBCO BusinessEvents Event Stream Processing add-on software for details on pattern matcher and query features.

Copyright © TIBCO Software Inc. All Rights Reserved