Chapter 9 Working With Rules and Functions : RuleFunction Resource Reference

RuleFunction Resource Reference
RuleFunction resources enable you to write rule functions that you can use in rules, as startup and shutdown actions, and as event preprocessors.
See also TIBCO BusinessEvents Language Reference.
Design Panel (Rule Function Editor)
 
Primitive, that is any of: String, int, long, double, boolean, DateTime, Object
The Object data type is used to pass parameters between standard and user-defined functions and external Java sources.
For more details, refer to the Datatypes chapter in TIBCO BusinessEvents Language Reference.
The function registry is on the top right side of the rule editor. As shipped, BusinessEvents includes two catalogs in the function registry: Standard and Ontology. See Understanding and Working With Functions.
You can add more catalogs for custom functions. See TIBCO BusinessEvents Language Reference for details.
Configuration
The Configuration tab has the following fields.
The name to appear as the label for the resource. Names follow Java variable naming restrictions. Do not use any reserved words. Names must be unique within a folder. See Identifiers (Names) in TIBCO BusinessEvents Language Reference.
If set to yes, the rule function is a virtual rule function, for use in Decision Manager (See TIBCO BusinessEvents Decision Manager). Virtual rule functions have arguments but no body. The Body panel is disabled and so is the Return Type field.
Action: Indicates that this rule function can be used only in the Action block of a rule.
Note: Only Action rule functions can be used as start up actions and shutdown actions.
Action and Condition: Indicates that this rule function can be used in the Action and Condition blocks of a rule.
Action, Condition and Query: Indicates that this rule function can be used in the Action and Condition blocks of a rule, and can also be used in the text of a query (The query language features are available only in TIBCO BusinessEvents Enterprise Suite).
If the rule function returns a value, specify the Return Type, otherwise leave set to void.
Extended Properties
The Extended Properties tab is used internally in this release and is reserved for future use.