Show TOC Start of Content Area

Object documentation Search Bar   Locate the document in its SAP Library structure

Definition

A Web Dynpro-developed user interface component used to execute simple searches based on predefined options.  

Use

You can use the Search Bar simple UI component in combination with other patterns such as the Object Selector and Object Browser to search for and retrieve attributive information of a business object. It is not a stand-alone application and can be embedded into any composite application

Structure

The Search Bar pattern consists of the following parts:

     Search Bar Configurator

     Search Bar User Interface (UI)

Search Bar Configurator

You use the toolbar along the top of the configurator to create a new Search Bar configuration (New), open a previously created one (Open), to save (Save, Save as) or delete (Delete) it, or to preview (Preview) and test your configuration in a separate window.

You generate the input parameters to be used in the search based on the Service Module and Query Name selected or entered. Choosing Retrieve Metadata populates the Select Input Parameters for Search Bar table.

You can also define the following:

Parameter

Description

Set Advanced Search Parameters

Enabling this checkbox allows you to set advanced search properties. For example, you can define additional advanced search input parameters and set them.

Starting Phrase for Search Bar

You can set a text which prefixes the search query in the configured UI.

Column Number

You can set a default value for the number of columns to be displayed after retrieving results.

Search Bar User Interface

The Search Bar UI displays the selected search parameters as defined in the Search Bar configurator. You can toggle Show Filter to view and manage search template attributes.

After the search is completed, you can see the results in the list section of the generated layout. Depending on configuration definitions, you can use search options containing pull-down to refine the search.

Integration

The Search Bar pattern can be used with the Object Browser and Object Selector UI components to browse and select objects to use in business applications. It also supports the hierarchical search of TREX classifications.

End of Content Area