Display Function

The MaxL display function statement helps you view a list of custom-defined Essbase calculation functions (CDFs) available globally, or for an application. If MaxL shows no application name next to a function in the display output, then that macro is global. The minimum permission required to run this statement is Read.

Syntax

Description of the illustration dispfunc.gif

Keywords

Use the MaxL display function statement to display custom-defined functions (CDFs) in the following ways. The application must be loaded (started).

display function [all]

Display all custom-defined functions, including those registered on the application level (local) or on the system level (global).

Example:

display function;

display function on system

Display all custom-defined functions registered on the system (global). Does not include locally defined functions.

Example:

display function on system;

display function on application APP-NAME

Display all custom-defined functions registered with the specified application (local). Does not include globally defined functions.

Example:

display function on application Sample;

display function FUNC-NAME

Display a custom-defined function by name.

Example:

display function Sample.Basic.'@COVARIANCE';

Output Columns Returned for MaxL Display Function

The columns returned for display function are described as follows:

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.