SAP ABAP Data Element N2_FHELPF4 (Help F4 Function Module)
Hierarchy
BBPCRM (Software Component) BBPCRM
   CRM (Application Component) Customer Relationship Management
     CRM_APPLICATION (Package) All CRM Components Without Special Structure Packages
       NMED (Package) R/3MED: Medical documentation GSD
Basic Data
Data Element N2_FHELPF4
Short Description Help F4 Function Module  
Data Type
Category of Dictionary Type D   Domain
Type of Object Referenced     No Information
Domain / Name of Reference Type CHAR30    
Data Type CHAR   Character String 
Length 30    
Decimal Places 0    
Output Length 30    
Value Table      
Further Characteristics
Search Help: Name    
Search Help: Parameters    
Parameter ID   
Default Component name    
Change document    
No Input History    
Basic direction is set to LTR    
No BIDI Filtering    
Field Label
  Length  Field Label  
Short 10 HelpF4 
Medium 15 HelpF4 Function 
Long 24 HelpF4 Function Module 
Heading 24 HelpF4 Function Module 
Documentation

Definition

If it has been implemented, the function module, HelpF4 serves to offer possible entries for the documentation element in an external data module to which the external data module has been assigned. A possible entries function can be implemented for simple documentation elements, simple structures and multiple structures.

When requesting the possible entries, the current contents of the documentation element are transferred immediately after calling either of the function modules ConvertFromText or ConvertFromTab. With a simple documentation element, this means the contents of the individual element, with a structure, this means the contents of all documentation elements of the structure, and with a multiple structure this means the contents of the table row where the cursor is currently located. After a successful transfer, the function module HelpF4 will be called. If the function module is exited without an error, then the appropriate values are transported back via the function modules ConvertToText or ConvertToTab.

In the case of an external data module, all documentation elements of the structure can be supplied for simple or multiple structures, using the F4-help function.

The implementation of an external data module with the F4-help function absolutely requires at least the implementation of the function module ConvertToText or ConverToTab according to the type of documentation elements to be supplied. An external data module can generally be implemented in such a way that it exclusively functions to provide an F4-help function.

The generation of processing for the F4-help function of an external data module using the generator can correctly proceed if the option F4-Help is set in the abstract and/or concrete design for the documentation element to which the external data module is assigned. With simple documentation elements, this automatically activates the generation of the selection button and the value-request-processing in the flow logic of the corresponding screen for the appropriate screen field. With F4-help functions of simple and multiple structures, the option F4-help must additionally be set for the documentation element, for which the selection is to be activated and/or where the selection button is to be created. This can be more than one documentation element of a structure.

Interface parameter

  • Importing
    • VALUE(DOK_ID) LIKE N2REFHDR-REFDOK
    • VALUE(DOKELEMENTID) LIKE N2DE-DEID
    • VALUE(TABLINE) LIKE SY-LILLI
    • VALUE(REFKEY) LIKE N2REFHDR-REFKEY
    • VALUE(PARAMSTR) LIKE N2FDBS-PARAMSTR (From interface version 2 on)
    • VALUE(SS_MODE) LIKE SY-TCODE (From interface version 2 on)
  • Exceptions
    • HELP_F4_ERR
    • NO_CHOICE

DOKELEMENTID contains the documentation element. In the case of a multiple structure, TABLINE contains the table row where the cursor was located when the the possible entries function was called.

History
Last changed by/on SAP  20050301 
SAP Release Created in