Show TOC

Getting Search Help Data SourceLocate this document in the navigation structure


When a recorded field has search help in the SAP system, Screen Scraping enables those fields in the specific search help.

Search help allows you to provide selections using a variety of criteria, such as, obtaining customer information based on country, or tax code, or company name.

Search help is useful in that, it provides the data source for the Query operation in Screen Scraping.

Defining Search Help Entities as Data Source

You can get search help data source based on the recorded fields for which search help data existed during recording. Where a recorded field does not have search help data, you cannot get the search help data source based on that field.

To get a search help data source:

  1. Open the recorded screen, and select the specific field for which you want the search help data.

  2. Click the New icon, and choose Get Search Help. The Get Search Help window opens.

    A message displays when the selected field does not have search help data from the SAP system.

  3. In Search Help Name, press F4 to select the preset search help entity you want as a data source.

  4. Click the check mark. The search help data source is created in the same recording group as the recorded field on which it is based.

The search help data source you have obtained is no longer dependent on the recorded field on which it is based.

You can map the attributes in the search help data source into the Query operation in your Data Model.

The Data Model Generator automatically proposes the selected field from which you derive the search help data source entity as the designated key.

However, if there is no match for the name of the selected field in the search help, the Data Model Generator does not propose a key and you must manually set a key for the query operation of the model.

Viewing Properties of Search Help

After creating your search help, you can view its properties. The following are the properties of a search help:

  • Search Help:

    Specifies the name of the search help name. It cannot be modified.

  • Transaction:

    Specifies the recorded transaction code. It cannot be modified.

  • Description:

    Specifies the descriptive text. It cannot be modified.

  • Added On:

    Specifies the date on which the search help was added. It cannot be modified.

  • Added By:

    Specifies the name of the user who added the search help. It cannot be modified.

To view the properties:

  1. Select the search help whose properties you want to view.

  2. Right click the selected search help, and choose Search Help Properties or click the magnifying glass icon.

Deleting Search Help

You can delete a search help entity in the Screen Scraping Repository pane.


You cannot delete a search help entity that has already been mapped to a Data Model.

To delete a search help entity:

  1. From the Data Source: Screen Scraping Repository pane, select the search help entity you want to delete.

  2. Click the Delete icon.

    Alternatively, right click the selected search help name and choose Remove from Data Source. A dialog window displays.

  3. Click Yes to delete the search help entity.

Mapping the Search Help and Enabling Query Filters

After you get the search help data source, you can map it to your Data Model. Screen Scraping automatically maps the search help based on the Query operation.

To map your search help:

  1. Select a search help data source from the recording group, and choose Create Mapping.

    The Map Operation screen displays with the operation type automatically set to Query.

    The generator provides a mapping proposal. You can change the proposal according to your needs.

    In the Map Operation screen, a recorded field displays one of three icons, that designates the type of field: Input, Output, and Changing.

    The following table shows the icons and their designations:


    Changing field, it is both an input (import) and an output (export) field.

    Model properties which are assigned to a changing field are filterable and will contain values in the query output.


    Output (export) field, it is for runtime display purposes only.

    Model properties assigned to an export field will not be filterable and will contain only values in the query result.


    Input (import) field.

    Model properties which are assigned to an import field are filterable but no results are returned.

    These icons help you to identify the expected runtime behavior of the field and the search help entity.

  2. Choose the green check mark to map the search help.


If Screen Scraping is your data source, the maximum number of hits it retrieves at runtime is fifty. However, you can use the filter option, $top, to override the default value.

More Information

For information about mapping query operation for BOR and RFC data sources, see Mapping the Query Operation.