Show TOC

SAPSetPlanParameterLocate this document in the navigation structure

With this API method, you can define values for input-ready variables of planning objects.

To call the method, use Application.Run and specify the following input parameters:

  • Formula Alias

    Enter the formula alias for the planning object. You can set the alias when configuring the planning object on the Components tab in the design panel.

  • Variable Name

    Name or technical name of the variable to be filtered.

  • Variable Value

    String that represents the value for the variable, for example the key. Note the syntax rules for entering values.

  • Member Format
    • Text

      Single member as text.

    • Key

      Single member as key.

    • INTERNAL_KEY

      Single member with its internal key.

    • INPUT_STRING

      Complex selection of members.

    • LITERAL

      Single member with its internal key.

      With this value format, no immediate validation with the back-end system is executed. This improves the performance.

      This format is only valid if you set the prompt value with its internal key and you use the syntax rule Equal To.

      If the entered member is not valid, a message is displayed.

    This parameter is optional. The default value is INPUT_STRING.

    Note The KEY and INTERNAL_KEY depend on the InfoObject modeling in SAP NetWeaver BW.
The system returns one of the following output parameters for each function execution:
  • 0 = execution failed.
  • 1 = execution successful.

Example

Dim lResult as long

lResult= Application.Run("SAPSetPlanParameter", "PF_1", "0TARGET_YEAR", "2013", "INPUT_STRING")

With this example, you set the variable 0TARGET_YEAR in planning function PF_1 to the year 2013.

Related Information