Show TOC

ButtonLocate this document in the navigation structure

Definition

The Button design item enables you to execute a customized command against the query results.

Use

You use the Button design item to customize a specific command or sequence of commands. In the syntax, which is based on the Web API Reference, all data provider-specific commands and parameters are supported, except for functions to export to Microsoft Excel.

By defining a button, you can customize any steps you take when you manually navigate in a query by using the context menu. When you choose the button, you execute the command or commands and the query results are updated accordingly in the analysis grid.

Structure

You configure the properties for the design item Button using the Command Wizard. The wizard opens if you select the design item Properties after the insertion.

In the first window you select the command type (such as Planning-Specific Command); in the second window you select a command (such as Save); if you choose Finish, you go to the third window, where you can configure the properties of the button.

More information:Command Wizard

Caution

To add a button to the workbook, you must enable Microsoft Excel's Trust access to visual basic project setting (in Tools → Macro → Security → Trusted Sources). If you omit this step, an Access to Visual Basic project failed error is displayed when you attempt to insert the button.

Button Properties

Property Description

Button Name

Displays the name of the button, which is generated automatically and is unique. This name is used in the BEx Analyzer  → Design Toolbar menu to refer to a particular instance of the button.

Area

You manipulate coordinates for a cell or cells in this field to move or resize the button.

SeeMoving and Resizing Design Items.

Button Text

The text (caption) you want to display on the button. You can use this to describe the command the button executes.

Command Range

(Optional) You can specify a three-column range of cells in the worksheet that contains the command parameters. In these cells, you provide the same parameters (Name, Index, and Value) as you do for Static Parameters (see below). But in the worksheet, these can be variable; they can change during navigation based on query results or on a value you manually specify.

When the button is clicked to initiate the command, all values in Static Parameters are evaluated first, then all the parameters in the Command Range are appended.

Shape

You can select an image that should replace the standard formatting of the button.

Static Parameters

You can configure the command or commands to execute by supplying name-value pairs to send to the server. A command can consist of multiple name-value pairs; you configure one for each row in this table. Any data provider-specific command in the Web Design API Reference from SAP BW 3.x (except functions to export to Microsoft Excel) is accepted. For information on this API, see the documentation for Release SAP NetWeaver 2004.

  • Name: The name of the command.
  • Index: The sequence in which the command is to be executed. The start command begins with 0. You can configure as many commands as you want.
  • Value: The value for the command.
Example

You want to create a button that removes the currently configured filter. Enter Remove Filter in the Button Text field and configure the following three rows in the Static Parameters section.

  • Name = DATA_PROVIDER; Index = 0; Value = [name of data provider]
  • Name = CMD, Index = 0; Value=REMOVE_FILTER
  • Name = FILTER_IOBJNM, Index = 0; Value = [name of dimension]

If you want to filter by product, but want to specify which product when you are navigating in analysis mode, use the Command Range field to specify the three-column range in the worksheet in which to look for the parameters. For example, you could configure it in the worksheet as follows:

Column E Column F Column G Column H
Row 8

FILTER_VALUE

0

PROD0001

Filter to the following product:

Set Command Range to F8:H8. You can now provide dynamic input for the value in column H, labeled Filter to the following product: in the worksheet. You can also hide columns F and G so that the static parameters of the command remain hidden.

Buttons can be useful within the context of planning functions, which are not executed in the context of a data provider, but within a workbook. For example, in a re-evaluation scenario, you have created a planning function on the back end in which you get a raise and make your calculations increase by 1%. You can add a button to the worksheet to execute this planning function.

Although planning functions are modeled on the back end, they can have variables; you can also provide these in the worksheet using the Command Range field.

More information:

Inserting Design Items

Creating Planning Applications in the BEx Analyzer

Functions for Manual Planning