Edit Macro Dialog Box

You use the Edit Macro dialog box to edit the properties of custom-defined macros that are registered with Essbase at the global (server) level or the local (application) level.

Read-only boxes:

  • Essbase Server—Name of the current Essbase Server instance

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

  • Name—Name of the macro

  • Statement—MaxL statement that would specify the current macro definition

Text boxes in which you enter or modify information:

  • 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

Related Information

Related Commands

create macro (MaxL) in the Oracle Essbase Technical Reference