Types of Search Help in SAP ABAP: Elementary, Collective, and Append Search Help Explained

When creating SAP ABAP applications, one of the most powerful tools available for the developers are search help within SAP ABAP. The Search Help, commonly referred to by the name of F4 search assistance for SAP ABAP offers users with a popup or dropdown list of possible values for input fields which improves accuracy of data as well as user experience and decreasing errors in input.

If you're a beginner trying to figure out how to make search assistance within SAP ABAP or an experienced developer who wants to incorporate advanced patterns such as the append of search assistance and Search Help Exit for SAP ABAP, this thorough guide covers all you need to know about.

This article will look at:

• What exactly is search aid and why is it important?
• All kinds of search support in SAP ABAP.
• How do I use search assistance in SAP ABAP programs
• Step-by-step search aids in the creation of SAP ABAP
• Advanced topics, including fuzzy and binaries search within SAP ABAP

What Is Search Help in SAP ABAP?

Search assistance for SAP The ABAP is an object from the repository that can provide F4 help functions to screen fields. When an individual presses the F4 key in an input field or clicks the search icon -- SAP provides an array of possible options that the user could choose from. This process is known as F4 search assist.

Search help is described by the ABAP Data Dictionary (transaction SE11) and is connected to:

• Data elements
• Table fields
• Screen fields directly within programs

Without help from search users must remember manually or find the correct values. It leads to errors and can slow down data entry. Search help reduces friction.

Types of Search Help in SAP ABAP

Knowing the search help types available in SAP ABAP is crucial prior to deciding which type of search help to use. SAP ABAP provides three main types:

1. Elementary Search Help in SAP ABAP

Basic search assistance is the simplest and popular type. It is one, distinct search path, which means it pulls information from one source (a view, table or function module) and displays the information to the user.

Essential characteristics of basic search assistance:

• Data is retrieved from a single source object (table or database view or projection view)
• The selection method is defined, along with the dialog behavior, as well as the mapping of parameters
• It is possible to directly link the screen or data element field

A typical use case: A field that allows you to enter the customer's number could be linked to an easy search aid that pulls data out of the KNA1 (Customer Master) table and displays customer numbers as well as names.

What is the way that elementary search help functions:

• Users press F4 in the input field.
• SAP implements the search method that is described in the search help
• A popup window appears that displays the matching records.
• The user chooses an entry then SAP fills in the field automatically

Basic search help is the basis of the creation of search help for SAP ABAP and must be understood prior to working with more advanced search kinds.

2. Collective Search Help in SAP ABAP

The collective search feature inside SAP ABAP is an encapsulation or wrapper for many elementary search tools. Users can select among a variety of search options via tabs that appear in the F4 popup dialog.

The key characteristics of the collective search help:

• Multiple elementary search groups work together
• Every search aid for elementary searches is displayed as a tab within the F4 dialog.
• Flexible when data can be accessed using various parameters
• A collective search aid could include elementary search help as well as other search aids for collective use.

A typical use case: The material field may utilize a collaborative search tool with three tabs:

• Tab 1: Search by material number (elementary search help 1)
• Tab 2: Description of the material (elementary assistance with searching)
• Tab 3: Material type and/or class (elementary Search Help 3)

This provides the user with numerous ways to locate the same information, making the app far more user-friendly.

Search for elementary and collaborative are both helpful with SAP ABAP generally work in tandem — The collective is the umbrella. The primary search assists to find the individual search routes underneath it.

3. Append Search Help in SAP ABAP

Append help for search for SAP the ABAP program is a specific mechanism that lets you add additional search routes to an existing collective search aid without altering the object in its original. This is especially useful for SAP upgrades and customization.

Append search assistance:

• Helps to extend the collective search by providing additional elementary search help
• Keeps its original form (no modification required)
• Great for enhancements that are specific to the customer in the standard SAP systems.
• It follows the same principle as append structures for transparent tables.

Example use case: SAP delivers a standard collective search help for vendor numbers. Your business needs an additional tab that allows you to search banks for vendors. Instead of altering SAP's standard object (which could be overwritten during upgrade) make an append to the search help that includes your own basic search assistance to the existing one.

Append search assistance is the preferred method for customers' implementations in which normal SAP objects are not required.

How to Create Search Help in SAP ABAP (Step-by-Step)

Follow these steps to creating search help using SAP ABAP by using the SE11:

Step 1: Open the Data Dictionary

• Go to the transaction SE11
• Choose the Search Help radio button
• Give a name to your search assistance (customer objects should begin by using the letters Z or the letter Y, e.g., ZCUSTOMER_SH)
• Click Create

Step 2: Choose the Search Help Type

SAP will require you to select from:

• Basic search assistance
• Search help for a collective

Select the best kind based on the requirements you have.

Step 3: Define Parameters for Elementary Search Help

To get help with a basic search complete the following information:

Options for Dialog Type:

• Displays values instantly -- Displays the entire list, without filter popup
• Display values upon selection instantly -- Always displays the popup with the selection first
• Only displays values upon demand -- Displays dialog only when the user specifically wants to do so.

Step 4: Map Parameters

Within the Parameters section, you must specify which fields include:

• It was imported via the computer screen (used as a filtering tool)
• Export into screen field (populated following selecting)

Note the fields that are relevant by using IMP (import) as well as (export) flags and then set an LPOS (list location) to determine the columns that appear within the F4 dialog.

Step 5: Activate the Search Help

Click the button to activate the option (or use Ctrl+F3) to enable your search aid object.

Step 6: Attach to a Data Element or Screen Field

You can add the search aid to:

• A Data element within the SE11 (Field tab: Search Help)
• Directly in the Screen Painter (SE51) in order to create fields that are program-specific
• Through ABAP code, using the SET PF-STATUS as well as function module

How to Use Search Help in SAP ABAP Program

To use search help programmatically -- how to use search help in SAP ABAP program -- you can call the function module F4IF_INT_TABLE_VALUE_REQUEST or F4IF_FIELD_VALUE_REQUEST.

Example using F4IF_INT_TABLE_VALUE_REQUEST:

DATA: lt_values    TYPE STANDARD TABLE OF fval,
      lv_selected  TYPE char20.

CALL FUNCTION 'F4IF_INT_TABLE_VALUE_REQUEST'
  EXPORTING
    retfield        = 'MATNR'
    value_org       = 'S'
  TABLES
    value_tab       = lt_values
  CHANGING
    field_value     = lv_selected
  EXCEPTIONS
    parameter_error = 1
    no_values_found = 2
    OTHERS          = 3.

You can also add the search help by directly attaching it to an option, or select-option in a report:

PARAMETERS: p_kunnr TYPE kna1-kunnr.
" Add search help using the data element - no additional code is required
" if KNA1-KUNNR already has search help in SE11

For greater control, make use of the AT SELECTION-SCREEN ON VALUE-REQUEST FOR event:

AT SELECTION-SCREEN ON VALUE-REQUEST FOR p_kunnr.
  CALL FUNCTION 'F4IF_FIELD_VALUE_REQUEST'
    EXPORTING
      tabname    = 'KNA1'
      fieldname  = 'KUNNR'
    IMPORTING
      select_fld = p_kunnr.

Search Help Exit in SAP ABAP

An searching help exit within SAP the ABAP program is function module you can connect to the process of searching help to create specific logic. It's activated at specific occasions in the F4 help lifecycle.

Common usage cases to exit help with search:

• Pre-filtering records on the basis of the context of the user or authorization
• Custom selection conditions are not supported by the standard dialog
• Modifying the result list prior to when it is presented to the user.
• Displaying additional screen fields after the value has been selected

Function modules has to be able to follow the following interface:

FUNCTION z_my_search_help_exit
  CHANGING
    c_callcontrol TYPE ddshf4ctrl.

CALLCONTROL structure controls which step of the F4 process is currently running (e.g., STEP = 'SELONE', 'DISP', 'RETTAB').

To add a search help exit, type in the function module's name in the Search Help Exit field of the basic Search Help definition found in SE11.

Search Help for Date in SAP ABAP

Search help for dates for date fields in SAP ABAP is a typical need. SAP has built-in calendar help for date fields by using the DATS domain. The majority of date fields will automatically receive an option to select a calendar when F4 is hit.

If you're looking for a customized search aid for dates within SAP ABAP -- for example, to limit acceptable dates to a particular period -- you could build an elementary search aid that includes an exit for search that is able to filter the calendar popup, or validates against a customized date table.

Fuzzy Search in SAP ABAP

Fuzzy search within SAP ABAP is available through the SAP HANA systems. It can be used to match strings in an approximate manner which is useful for those who aren't sure of the spelling of the value.

Fuzzy search makes use of HANA's own fuzzy search capabilities. It can be activated through:

• Native SQL with CONTAINS and SCORE() functions
• ABAP SQL employing LIKE with HANA-specific extended options
• SAP HANA Full Text Search indexes on columns

" Example: Fuzzy search via AMDP or native SQL
SELECT matnr, maktx
  FROM makt
  WHERE CONTAINS( maktx, 'Pummp', FUZZY( 0.7 ) )
  INTO TABLE @DATA(lt_results).

Fuzzy search dramatically enhances user experience during search assists in the reference of text-based tables.

Binary Search in SAP ABAP Example

While it's not directly linked to F4 search assistance, binary search in SAP ABAP is a method of performance used to search internal tables that are sorted which is a typical requirement to prepare information for custom search help exits.

DATA: lt_materials TYPE SORTED TABLE OF mara
                   WITH UNIQUE KEY matnr,
      ls_material  TYPE mara.

" Binary search on a table that is sorted or hashed (automatic)
READ TABLE lt_materials
  INTO ls_material
  WITH KEY matnr = '1000001'.

" For tables that are standard, use BINARY SEARCH in addition
READ TABLE lt_materials
  INTO ls_material
  WITH KEY matnr = '1000001'
  BINARY SEARCH.

Binary search can reduce the time to lookup by O(n) up to O(log n) and is therefore essential in exits for search that process large databases before giving results back at the request of users.

Best Practices for Search Help in SAP ABAP

Use these best practices to implement search assistance for search help in SAP ABAP:

• Always make use of a view over an initial table to select the method if possible. Views are able to join multiple tables and offer more extensive results.
• Utilize the collective search feature in situations where users require different criteria within the same area.
• Utilizing append search assistance instead of altering your standard SAP collective search help — this helps protect your changes when you upgrade.
• Implement help exits for search to allow authorization filtering — Never expose any records that users aren't authorized to view.
• Examine F4's behaviour in both the selection screen and dialog applications to verify consistent behavior.
• Limit columns shown on the F4 pop-up by using LPOS settings — displaying too many columns can confuse users.
• Use fuzzy searches using HANA systems to search for fields with text to enhance the usability of your system.

Summary: Search Help Types at a Glance

Conclusion

Help with search within SAP ABAP can be described as a fundamental idea that each ABAP developer should be able to master. From the most basic search aid to the ability to use collective search assistance as well as the non-invasive extension in the form of append search assistance within SAP ABAP, SAP provides a full toolkit for providing top-quality F4 assistance.

Knowing how to design search assistance in SAP ABAP and implement the search help exit or search help configuration to date, and take advantage of advanced capabilities such as fuzzy and binary search can help make your SAP applications more reliable as well as user-friendly and manageable.

We are ERPVITS, we are experts on SAP ABAP training and consultation aiding organizations and professionals develop experts-level SAP capabilities. Explore our classes and resources to enhance your knowledge about ABAP development.