Rule Function Resource Reference

Rule Function resources enable you to write rule functions that you can use in rules, as startup and shutdown actions, and as preprocessors.

Virtual rule functions are decorated with a V.

Property Description
Configuration Section
Name 
(Wizard only) 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 Identifier Naming Requirements .
Description

(Editor and Wizard)

Short description of the resource.
Return Type

(Editor and Wizard)

If the rule function returns a value, specify the Return Type, otherwise leave set to void.
Virtual

(Editor and Wizard)

If set to yes, the rule function is a virtual rule function. Virtual rule functions have arguments but no body. The Body section is disabled and so is the Return Type field. The body is provided by a decision table. See TIBCO BusinessEvents Decision Manager User’s Guide.
Alias Optionally, enter an alias for the rule function. Used as a short way to refer to the rule function. You can use the alias, for example, to make query strings shorter (if you have the TIBCO BusinessEvents Event Stream Processing add-on).
Validity Specifies where the rule function can be used. Possible values are as follows:
Action
 Indicates that this rule function can be used only in the Action block of a rule.
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).
Note:
Only Action rule functions can be used as startup rule functions or shutdown rule functions.
Scope Section
Term The type of the argument. Arguments and return type can be any of the following, including arrays of these datatypes:
  • Primitive, that is any of: String, int, long, double, boolean, DateTime, Object
  • Concept
  • Event
  • Specific type of Concept
  • Specific type of Event

The Object data type is used to pass parameters between standard and user-defined functions and external Java sources.

Alias Each argument requires a type and an alias. Names must be valid identifiers.
Body Section
  List of statements that will be executed when the rule function executes.