Custom-Defined Macro Manager Window

You use custom-defined macros to extend the Essbase calculator language.

The boxes of the Custom-Defined Macro Manager window display information about custom-defined macros.

You do not edit fields in this window. Rather, to operate on a macro, you select a row and click a button, or click New to create a macro.

  • Essbase Server—Name of the current Essbase Server instance

  • Application—Name of the application with which the macro is associated (for local macros) or <all apps> (for global macros)

  • Name—Short way to refer to the macro expansion; for example, @MYMACRO

    Macro names can include alphanumeric characters and the following symbols: @, #, $, _. It is recommended that you start a macro name with @. Within an application, each macro name must be unique. However, a global macro and local macro can use the same name. In this case, the local macro takes precedence.

    Note:

    The names that are displayed in the Name column do not reflect the double-naming convention that is used in MaxL to specify the scope of local macros. For a local macro, the selection in the Application list identifies the relevant application.

  • Signature—Description of the style in which macro arguments are passed

    For example, the following signature passes the macro as two comma-separated arguments followed by a list of arguments: (SINGLE, SINGLE, GROUP)

  • Expansion—A string that determines how the signature is processed

    For example, if you use the following macro, signature, and expansion, @SUM3 (x, y, z) is replaced with @SUM3 (x + y + z):

    • Name—@SUM3

    • Signature—(SINGLE, SINGLE, SINGLE)

    • Expansion—(@@1, @@2, @@3)

  • Spec—Essbase calculator-syntax specification string; for example, @MYMACRO (mbrName, rangeList)

    A specification string is not required. You use a specification string to return the macro and its syntax by the output string of the EssListCalcFunctions API function.

  • Comment—Not required and possible only if a specification string is used

  • State—Status of the macro

    • Loaded—The macro is validly defined in Java and loaded into the application process.

    • Not loaded—The macro is not validly defined, or the application is not started. Therefore, the macro is not loaded into the application process.

    • Unknown—Essbase cannot determine whether the macro is validly defined. You may need to refresh the custom-defined function and macro catalog or restart the applications. Unknown is the default setting.

The buttons of the Custom—Defined Macro Manager window enable you to perform various macro-related actions:

  • Create—Create a macro, which consists of the calculation functions or macros that you select from the Essbase calculator framework

  • Copy—Copy the current macro into another server or application

  • Delete—Delete the current macro

  • Edit—Modify the properties (but not the name) of the current macro (Before you click Edit, select the macro that you want to modify.)

  • Rename—Rename the current macro

  • Refresh—Load a newly created or an edited macro into the custom-defined function and macro catalog

Macros that you create are registered in the custom-defined function and macro catalog. Actions that you perform on existing macros are reflected in the custom-defined function and macro catalog.

Note:

Custom-defined macros do not apply to aggregate storage applications.

Related Information

Related Commands

  • create macro (MaxL) in the Oracle Essbase Technical Reference

  • display macro (MaxL) in the Oracle Essbase Technical Reference

  • drop macro (MaxL) in the Oracle Essbase Technical Reference