Display Macro

View a list of custom-defined macros available globally or to an application. Minimum permission required: read. If MaxL shows no application name next to a macro in the display output, then that macro is global (system-wide).

Syntax

Examples

display macro on application sample;

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

Descriptions

You can display custom-defined macros in the following ways using display macro.

Key Phrase Explanation
all Display all custom-defined macros, including those registered on the application level (local) or on the system level (global).
on system Display all custom-defined macros registered on the system (global). Does not include locally defined macros.
on application Display all custom-defined macros registered with the specified application (local). Does not include globally defined macros.
<macro-name> Display a custom-defined macro by name.

Output Columns

The columns returned for this statement are described as follows:

Column Name Contents
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.

©2004 Hyperion Solutions Corporation. All Rights Reserved.
http://www.hyperion.com