Show TOC

 Creating Elementary Search HelpsLocate this document in the navigation structure

Procedure
  1. Open the Repository Browser (transaction code SE80) and navigate to the package in which you want to create the search help.
  2. In the context menu of the package, choose Create → Dictionary Object → Search Help.

    A dialog box appears in which you must enter the name of the search help.

  3. Select the Elementary search help radio button and choose  with the quick info text Continue.

    The maintenance screen for elementary search helps appears.

  4. Enter an explanatory text in the Short description field.

    For example, you can find the search help at a later time using this short text.

  5. On the Definition tab page, enter the selection method of the search help.

    You can enter the name of a table or a view (database view, projection view or help view). If you enter a table that has a text table , the system automatically enters the name of the text table in the corresponding field.

  6. In the Search help parameter area, select fields of the selection method as the parameter. To do this, use the input help (F4 help). Select the fields that must be used in the dialog box for value selection or in the hit list.

    If the selection method is a table that has a text table, both the fields of the table and the fields of the text table are offered in the input help.

    The data element of the parameter is automatically copied from the selection method. The data element defines the output attributes and the F1 help of the parameter in the hit list and in the dialog box for value selection.

    You can assign the another data element to the parameter. To do so, perform the following steps:

    1. On the Definition tab page, select the appropriate indicator in the Modified column.

      The Data element field is now ready for input.

    2. Select a data element with the input help (F4 help).
      Caution

      Only data elements whose data type, length and number of decimal places is the same as those of the previous data element can be assigned.

      If you assign a new data element to the parameter, the system removes the link between the data element of the search help parameter and the data element of the selection method field having the same name. If you deselect the indicator in the Modified column, the system uses again the data element of the assigned table field.

  7. Define the attributes of the search help parameters.
    1. Select the IMP indicator if it is an import parameter. Select the EXP indicator if it is an export parameter.
    2. Define the dialog(optionally) for the input help with the fields LPos, SPos and SDis.
      1. Enter the parameter position in the hit list in LPos. If you enter nothing or the value 0 here, the system does not display the parameter in the hit list.

        The following figure illustrates the functionality of field LPos.

    1. Enter the parameter position in the dialog box for value selection in SPos. If you enter nothing or the value 0 here, the system does not display the parameter in the dialog box for value selection.

      The following figure illustrates the functionality of field SPos.

    1. Set the SDis indicator if the parameter must be a pure display field in the dialog box for value selection. The user is informed that the contents of the parameter restrict the value, but he or she cannot change this restriction. This is rational for example when the parameter is an import parameter or if it has a default value.
    2. In the Default value field, you can assign a default value to the parameter.
  8. Select the dialog type of the search help.

    The dialog type defines how the hit list is displayed in the input help.

  9. Choose  with the quick info text Save.

    A dialog box appears in which you are asked to assign the search help to a package. You can change this package later, using Goto → Object Directory Entry.

  10. Choose  with the quick info text Activate.
    Caution

    Do not forget to link the search help to a screen field . The search help attachment is not part of the search help definition; it is part of the object definition to which the search help is attached.

Result

The search help is activated. You can find information about the activation flow in the activation log, which you can display by choosing Utilities → Activation log. If errors occur during activation, the system automatically displays the activation log.

Additional Options

  • Assign a hot key:

    If the search help is to be accessed with a hot key , you must enter a one-digit ID in the Hot key field. All the elementary search helps contained in a collective search help must have different shortcuts.

  • Assign a search help exit:

    In exceptions, you have to change the standard flow defined by the search help with a search help exit . In this case, enter the name of the search help exit in the corresponding field.

  • Test the search help:

    To test the flow of an input help defined by the elementary search help, choose  with the quick info text Test. A dialog box appears in which you can simulate the behavior of the search help under different conditions. You can obtain information about the options provided in this window with .

See also:

Structure of an Elementary Search Help