Файл: BC430_EN_Col62_FV_Part_A4_-_ABAP_Dictionary.pdf

BC430

Lesson: Search Helps

The

interface

of the search help controls the data transfer from the input template

to the F4 help and back. The interface defines the context data to be used and the
data to be returned to the input template when a value is selected.

The

internal behavior

of the search help describes the F4 process itself. This

includes the

selection method

with which the values to be displayed should be

determined as well as the

dialog behavior

describing the interaction with the user.

As with a function module, search helps distinguish between the interface with
which it exchanges data with other software components and the internal behavior
(for function modules, the latter is defined by the source text).

It only makes sense to define a search help if there is a mechanism available with
which the search help can be accessed from a screen. This mechanism, called the

search help attachment

, will be described later.

Like the editor for function modules, the editor for search helps also enables you
to test an object. You can thus test the behavior of a search help without assigning
it to a screen field.

Figure 93: Selection Method of a Search Help

The possible values displayed for a field by the input help are determined at
runtime by a selection from the database. When a search help is defined, you must
define the database object from which the data should be selected by specifying a
table or a view as

selection method

.

2006/Q2

© 2007 SAP AG. All rights reserved.

213

Unit 8: Search Helps

BC430

It makes sense to use a view as selectoin method if the data about the possible
values that is relevant for the input help is distributed on several tables. If this data
is all in one table or in the corresponding text table, you can use the table as a
selection method. The system automatically ensures that the text of the text table
is used in the user's logon language.

If there is not yet a view that combines the data that is relevant for an input help,
you must first create it in the ABAP Dictionary.

Maintenance views may not be used as the selection method for search helps.
Normally a database view is used. However, you should note that database views
(in the SAP system) are always created with an inner join. As a result, only those
values having an entry in each of the tables involved are offered in the input help.
Sometimes the values should be determined with an outer join. In this case you
should choose a help view as selection method. You can find more information
about help views in the appendix.

If the selection method of a search help is client-dependent, the possible values are
only selected in the user's logon client.

Figure 94: Description of the Dialog Behavior

The possible values are presented in list format in the

dialog box for displaying

the hit list

and the user can select the required entry from here. If the possible

values are formal keys, further information should also be displayed.

If the hit list is very large, the user should be able to define further restrictions for
the attributes of the entry. Restricting the set of data in this way both increases
the clarity of the list and reduces the system load. Additional conditions can be
entered in a further dialog window, the

dialog box for restricting values

.

214

© 2007 SAP AG. All rights reserved.

2006/Q2

BC430

Lesson: Search Helps

The dialog type of a search help defines whether the dialog box for restricting
values should be displayed before determining the hit list.

You must define the characteristics to appear on either (or both) of the dialog
boxes as

parameters

in the search help. You can use all the fields of the selection

method (with the exception of the client field) and the non-key fields of your
text table as parameters.

You define which parameter should appear in which dialog box (in what order)
by assigning the parameters positions in the two dialog boxes. You can thus use
different parameters (or different orders) in the two dialog boxes.

Types must be defined for search help parameters with data elements. These
define the display in the two dialog boxes. If nothing else is defined, a parameter
uses the data element of the corresponding field of the selection method.

Figure 95: Interface of a Search Help

When you define a parameter of a search help, you must also define whether it
should be used to copy data to the input help (IMPORT parameter) or whether to
return data from the input help (EXPORT parameter).

The IMPORT and EXPORT parameters of a search help together make up your
interface. (This is also analogous to function modules.)

2006/Q2

© 2007 SAP AG. All rights reserved.

215

Unit 8: Search Helps

BC430

You can also define interface parameters that do not appear in either the dialog box
for displaying the hit list or the dialog box for restricting values. This is useful for
example when screen fields that do not appear on either of the two dialog boxes
are to be updated when you select a value.

The location from which the IMPORT parameters of a search help get their values
and the screen fields in which the contents of the EXPORT parameters of the
search help are returned are defined in the search help attachment.

The search field is a special case. Its contents are only used in the input help if it is
a search string (that is, if it contains a * or a +) and the parameter linked with the
search field is an IMPORT parameter.

Parameters that only contain additional information about the search field should
not be defined as IMPORT parameters since the user must otherwise empty the
corresponding screen fields each time before he can define a new value with the
input help.

Figure 96: How do you Use Search Helps?

A search help describes the flow of an input help. The search help can only
take effect using a mechanism that assigns the search help to this field. This
mechanism is called the

search help attachment

to the field.

Attaching a search help to a field has an effect on the field's behavior. It is
therefore considered to be part of the field definition.

The semantic and technical attributes of a screen field (type, length, F1 help, ...)
are not normally defined directly when the input template is defined. On the
contrary, only a reference to an ABAP Dictionary field (usually with the same

216

© 2007 SAP AG. All rights reserved.

2006/Q2

BC430

Lesson: Search Helps

name) is specified in the Screen Painter. The screen field takes on the attributes of
this field from the ABAP Dictionary. The same principle is also used to define
the input help of a screen field. The search help is thus attached to the ABAP
Dictionary search field and not to the screen field.

In the search help attachment, the interface parameters of the search help and the
screen fields providing data for the input help or getting data from the input help
are assigned to one another. The search field must be assigned to an EXPORT
parameter of the search help at this time. This parameter should also be an
IMPORT parameter so that the user can take advantage of search patterns that
are already entered.

Fields that do not have a search help attachment can also have an input help
since further mechanisms (for example, domain fixed values) are also used for
the F4 help.

Figure 97: Search Help Attachment in the ABAP Dictionary

2006/Q2

© 2007 SAP AG. All rights reserved.

217