Definition
Web item that allows you to display and select contents in a dropdown box.
Use
You can specify the content of the dropdown box as follows:
● Characteristic values for filtering
Using the Dropdown Box Web item, you can easily filter one or more connected data providers by a characteristic value. When you select an entry from the dropdown box, the connected data provider is filtered according to this value. If a different method is used to select a filter value for the characteristic in the dropdown box, the current filter value appears in the dropdown box.
● Selection of query views
By selecting an entry from the dropdown box, you can switch, in one step, from a data provider and its display (in a table, for example) to another data provider that may be displayed in a different way (in a chart, for example).
● Fixed options list
When you select an entry from the dropdown box, an associated command from the Web Design API is executed.
● Fixed option list with manual update
When you select an entry from the dropdown box, an associated command from the Web Design API is executed. It is also possible to trigger a manual update (of data).
Structure
The following tables list the parameters for the Dropdown Box Web item, arranged according to the various parameter groupings.
Display
Parameter Description Width in Pixels (WIDTH) You use this parameter to specify the width of
the Web item.
Height in Pixels (HEIGHT) You use this parameter to specify the height of the Web item.
Visibility (VISIBILITY) You use this parameter to specify whether the Web item is to be visible in the Web
application.
With Tray (WITH_TRAY) You use this parameter to specify whether the Web item is to have a symbol that allows it to be expanded and collapsed in the Web application. For more information about this parameter, see Parameter Tray [Page 174].
Internal Display
Parameter Description Maximum Length of the Text
(TEXT_MAXLENGTH)
You use this parameter to specify the maximum text length for the values.
Maximum Number of Displayed Values (ENTRIES_MAXCOUNT)
You use this parameter to specify the
maximum number of values to be displayed in the dropdown box.
Behavior
Parameter Description Allow Navigation (INTERACTION_ALLOWED) You use this parameter to specify whether
navigation and other interactions, such as in the Web application, are to be possible.
Data Binding
Parameter Description Data Binding Type (DATA_BINDING_TYPE)
The default value is:
“CHARACTERISTIC_SELECTION”
Char/Structure Member:
CHARACTERISTIC_SELECTION Query View Selection:
QUERY_VIEW_SELECTION Fixed List of Options:
STATIC_OPTION_LIST
Fixed List of Options: Manual Update:
STATIC_OPTION_LIST_MANUAL
You use this parameter to specify the content of the entries in the dropdown box: In the dropdown box, you can display characteristic values for filtering, a selection of query views and their graphical presentation, a fixed list of options that you have defined, or a fixed list of options with manual update.
Additional parameters must be set, depending on the data binding type. See the subsequent tables.
Additional parameters must be set, depending on the selected data binding type. For more information about each of the data binding types, see:
Data Binding Type CHARACTERISTIC_SELECTION [Page 77]
Data Binding Type QUERY_VIEW_SELECTION [Page 79]
Data Binding Type STATIC_OPTION_LIST [Page 81]
Data Binding Type STATIC_OPTION_LIST_MANUAL [Page 82]
4.1.1.4.1.1.7.1 Data Binding Type CHARACTERISTIC_SELECTION
If you select Characteristic Value/Structure Element (CHARACTERISTIC_SELECTION) for Data Binding Type in the dropdown box Web item, you must set the following parameters:
Parameter Description Data Provider (DATA_PROVIDER_REF) You use this parameter to assign a data
provider to the Web item. The Web item gets the data and metadata that it needs to generate the output and commands from this data provider.
We recommend that you keep to the
conventions supported by the Web Application Designer when specifying names: Names can be a maximum of 30 characters and consist of characters “A-Z”, “0-9” and “_”, but cannot start or end with “_”. Adhering to these conventions simplifies the upgrade to subsequent SAP releases.
Characteristic (CHARACTERISTIC) You use this parameter to select the
characteristic according to its technical name.
Read Mode (DATA_READ_MODE)
You use this parameter to specify which values from the master data table are to be used as filter values in the dropdown box Web item.
(M): All values from the master data table.
In some circumstances, values that do not appear in the data provider under the current filter conditions and that produce the result "No Suitable Data Found" when filtered, might also be displayed. However, under certain
conditions this process is the fastest.
(D): Values that are posted, whereby the current drilldown status is not fully taken into consideration.
(Q): Only those values that are also posted in the data provider within the current filter conditions are displayed. This can take a long time in some instances.
Read mode for Web items to set filter values:
The “master data” read mode may result in many unposted values being displayed; the
“posted values” read mode may be slow.
Label Visible (LABEL_VISIBLE) You use this parameter to specify whether the long text of the characteristic is to be written as a label beside the dropdown box.
Display ALL Entry
(ALL_VALUES_ENTRY_INCLUDED)
You use this parameter to specify whether the All entry is to be displayed as a selection option in the dropdown box.
Affected Data Providers
(LINKED_DATA_PROVIDER_REF_LIST)
Using this parameter, you create a list of data providers to which all commands are sent.
For each entry in the data provider list, you select a data provider in the Affected Data Provider parameter
(LINKED_DATA_PROVIDER_REF).
Note that you cannot create data providers in the parameter dialog box - you have to create them beforehand.
Additional Action (ACTION_WITH_DEFAULT) You use this parameter to specify the standard behavior of the Web item. In this way, in addition to setting a filter value (characteristic value or structure element), you can execute an additional command by changing an entry in the dropdown box. You first specify the type of additional action. You can include the following additional actions as follows:
● Command Via Command Wizard (INSTRUCTION_WITH_DEFAULT) If you choose this option, you can include an additional action using the command wizard. For more information, see the detailed table.
● Script Function
(SCRIPT_FUNCTION)
If you choose this option, you can include an additional script function. For more information, see the detailed table.
Depending on the additional action you choose to include, you need to set additional parameters. For more information, see the following table.
Parameters for Command via Command Wizard (INSTRUCTION_WITH_DEFAULT) Parameter Description
Execution Time (EXECUTION_TIME)
You use this parameter to specify the time of the execution for the command:
● Before (BEFORE)
If you choose this option, the additional command is executed before filtering.
● After (AFTER)
If you choose this option, the additional command is executed after filtering.
● Instead (INSTEAD)
If you choose this option, the additional command is executed instead of filtering.
Command (INSTRUCTION) Using the pushbutton to the right of Command (INSTRUCTION), you call the command wizard [Page 222] to include an additional command.
Parameters for Script Function (SCRIPT_FUNCTION)
Parameter Description Script Function (SCRIPT_FUNCTION) You can enter an additional script function to
be executed.
You generate the script function using the script [Page 173] Web item that you previously added and set in the Web template.
For more information about the use and functions of the Web item for selecting characteristic values, see Web Items for Setting Filter Values and Hierarchical Filter Selection Web Item [External].
4.1.1.4.1.1.7.2 Data Binding Type QUERY_VIEW_SELECTION
If you select Query View Selection (QUERY_VIEW_SELECTION) for Data Binding Type in the dropdown box Web item, you must set the following parameters:
Parameter Description Data Provider (DATA_PROVIDER_REF)
You use this parameter to assign a data provider to the Web item. The Web item gets the data and metadata that it needs to generate the output and commands from this data provider.
Specific List of Query Views
(SPECIFIC_LIST_OF_QUERY_VIEWS)
You use this parameter to specify whether a
specific list of query views or a list of all query views is to be displayed for the assigned query.
You have to set the following parameters for each entry in the dropdown box:
Initial State (INITIAL_STATE) Query (QUERY)
Query View (QUERY_VIEW) InfoProvider (INFOPROVIDER)
You specify the initial state by using the open dialog to select a query, a query view, or an InfoProvider and the relevant technical name of the object.
Reusable Web Item (REUSABLE_WEB_ITEM) You also specify the Web item with which the data provider is to be displayed. To do this, you must have saved the required Web item as a reusable Web item. If you do not specify a value, the target Web item (TARGET_ITEM_REF) is used for the display (see below).
Description of Selection (SELECTION_TEXT) Using the text input dialog, you specify the text that is to appear on the entry in the dropdown box. See Text Input Dialog [Page 40].
Command (INSTRUCTION)
Using the command wizard, you specify whether and with which command from the Web Design API the entry in the dropdown box is to be additionally linked. See also Command Wizard [Page 222].
Target Web Item (TARGET_ITEM_REF) You use this parameter to specify the Web item to be initially used for displaying data, and that you previously inserted in the Web template.
Listed Alphabetically
(ORDERED_ALPHABETICALLY)
You use this parameter to specify whether the dropdown box entries are to appear in alphabetical order.
Keep Filter Values (FILTERS_RETAINED) You use this parameter to specify whether filter values are to be retained in the dropdown box when the query view is changed.
Command (INSTRUCTION) Using the command wizard, you specify whether and with which command from the Web Design API the entry in the dropdown box is to be additionally linked.
Note that when you select a query view from the dropdown box, the following command sequence takes effect:
...
1. Switching of the Web item and the data provider.
2. Execution of the Web API command specified in the Command (INSTRUCTION) parameter for selection of the query view.
3. Execution of the Web API command specified in the Command (INSTRUCTION) parameter for an entry from the dropdown box (see parameters for Specific List of Query Views (SPECIFIC_LIST_OF_QUERY_VIEWS)).
For more information about the use and function of the Web item for the query view selection, see Query View Selection with a Dropdown Box [External].
4.1.1.4.1.1.7.3 Data Binding Type STATIC_OPTION_LIST
If you select Fixed List of Options (STATIC_OPTION_LIST) for Data Binding Type in the dropdown box Web item, you must set the following parameters:
Parameter Description
Fixed List of Options (STATIC_OPTION)
You use this parameter to set the entries for the list of fixed options. You need to set the following parameters for each entry in the list:
Description of Selection (SELECTION_TEXT)
Using the text input dialog, you specify the text that is to appear on the entry in the dropdown box. See Text Input Dialog [Page 40].
Action (Command Triggered) (ACTION)
● Command via Command Wizard (INSTRUCTION)
Using the command wizard [Page 222], which you can call by choosing the pushbutton for Command, you specify whether and with which command from the Web Design API the entry in the dropdown box is to be linked.
● Script Function (SCRIPT_FUNCTION) In the Script Function field, specify a script function to be executed.
You generate the script function using the script [Page 173] Web item that you previously added and set in the Web template.
4.1.1.4.1.1.7.4 Data Binding Type STATIC_OPTION_LIST_MANUAL
If you select Fixed List of Options: Manual Update (STATIC_OPTION_LIST_MANUAL) for Data Binding Type in the dropdown box Web item, you must set the following parameters:
Parameter Description
Fixed List of Options: Manual Update (STATIC_OPTION_LIST_MANUAL)
You use this parameter to set the entries for the list of fixed options with manual update. To do this the following parameters must be set:
Description of Selection (SELECTION_TEXT)
Using the text input dialog, you specify the text that is to appear on the entry in the dropdown box. See Text Input Dialog [Page 40].
Command (INSTRUCTION)
Using the command wizard, you specify whether and with which command from the Web Design API the entry in the dropdown box is to be linked. See also Command Wizard [Page 222].