1. Scripting Reference for Oracle Essbase
  2. MaxL
  3. MaxL Statements
  4. MaxL Statement Reference
  5. Display Macro

Display Macro

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

Syntax


Description of dispmacr.gif follows
Description of the illustration dispmacr.gif

Keywords

You can display custom-defined macros in the following ways using MaxL display macro. The application must be loaded (started).

display macro [all]

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

Example:

display macro;
display macro on system

Display all custom-defined macros registered on the Essbase Server (globally). Does not include locally defined macros.

Example:

display macro on system;
display macro on application APP-NAME

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

Example:

display macro on application Sample;
display macro MACRO-NAME

Display a custom-defined macro by name.

Example:

display macro Sample.'@COUNTRANGE';

Output Columns Returned for MaxL Display Macro

The columns returned for this statement are described as follows:

application

Application name(s).

macro

Macro name(s), as defined by MACRO-NAME in the create macro statement.

signature

Macro signature, as defined by the custom-defined macro input parameters in the create macro statement.

expansion

Macro expansion, as defined by MACRO-EXPANSION in the create macro statement.

spec

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

comment

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

state

The current state of the registered custom-defined macro.

Values:

  • 0 = UNKNOWN. It is unknown whether the macro is loaded into any application process.

  • 1 = NOT_LOADED. The macro is not loaded into any application process. You may have to refresh or restart the application in order to use this macro.

  • 2 = LOADED.

    The macro is loaded into at least one application process.

  • 3 = OVERRIDDEN. The local (application) macro is overridden by a global (system-wide) macro of the same name.