Display Function

Using this statement, view a list of custom-defined functions available globally or to an application. If MaxL shows no application name next to a function in the display output, then that function is global (system-wide). This statement also returns the validation status of an application's local custom-defined function or functions.

Minimum permission required: Read.

Syntax

Description of the illustration dispfunc.gif

Use display function to display custom-defined functions in the following ways:

Keywords

all: Display all custom-defined functions, including those registered on the application level (local) or on the system level (global).
on system: Display all custom-defined functions registered on the system (global). Does not include locally defined functions.
on application: Display all custom-defined functions registered with the specified application (local). Does not include globally defined functions.
<func-name>: Display a custom-defined function by name.

Output Columns

The columns returned for this statement are described as follows:

Column

Description

application

Application name(s).

function

Registered custom-defined function name(s), as defined by FUNC-NAME in the create function statement.

class

The java class before the method, as defined by JAVACLASS.METHOD in the create function statement.

method

The java method (at the end of the class), as defined by JAVACLASS.METHOD in the create function statement.

spec

Optional Essbase calculator-syntax specification string, as defined by CALC-SPEC-STRING in the create function statement.

comment

String as defined by COMMENT-STRING in the create function statement.

runtime

Values: TRUE or FALSE. Whether or not the custom-defined function was created with the runtime property.

state

The current state of the registered custom-defined function.

Values:

0 = UNKNOWN. It is unknown whether the function is valid Java and is loaded into any application process.
1 = NOT_LOADED. The function is not loaded into any application process. You may have to refresh or restart the application in order to use this function. Or, the function may not be developed validly in Java.
2 = LOADED.

The function is valid Java, and is loaded into at least one application process.
3 = OVERRIDDEN. The local (application) function is overridden by a global (system-wide) function of the same name.

Example

display function on application sample;

Displays all custom-defined functions associated with the application Sample.