About Function rules

Use a function rule to define a Java function that is accessed through rule resolution. You can reference function rules in expressions and directly in Java. Each function belongs to a library (Rule-Utility-Library rule type), indicated by the first key part.

If you are creating a new function rule to be used in an offline-enabled application, you must create the JavaScript equivalent of the Java version. For more information, see How to use a function rule in offline mode.

Note: Users can also create function alias rules to create complex SQL expressions that may be needed in Report Definition rules. See About Function Alias rules for more information about SQL function aliases.

Calling functions in expressions

The following forms call a function:

• The fully qualified syntax for calling a function identifies both the ruleset and the library:

@(RuleSet:libraryname).functionname(arg1, arg2... argn)

• The library qualified syntax for calling a function identifies the library name:

@LibraryName.FunctionName(arg1, arg2... argn)

• The unqualified syntax for calling a function calls a function rule:

@FunctionName(arg1, arg2... argn)

• To call in a function within a Java step of an activity, use standard Java conventions. For example:

myruleset_mygeolibrary.MyGeographicFunction(Latitude, Longitude);

See Methods for calling a function for more information.

Access

Use the Records Explorer to list all function rules available to you.

Category

Function rules are part of the Technical category. A function rule is an instance of the Rule-Utility-Function rule type.

Rule resolution

Function rule resolution is applied at runtime and is based on rule status. When searching for instances of this rule type, the system filters candidate rules based on a requestor's ruleset list of rulesets and versions

Time-qualified resolution features are not available for this rule type. Additionally, the class hierarchy is not searched.

Open topic with navigation