SAP Function POPUP_GET_VALUES_USER_HELP - Dialog box for requesting values, call of user exits and help

Parameter Reference Type Length Default Optional Text
F1_FORMNAME 0 SPACE X Name of the external subroutine for F1 help
F1_PROGRAMNAME TRDIR-NAME C 40 SPACE X Name of the module pool from F1_FORMNAME
F4_FORMNAME 0 SPACE X Name of the external subroutine for F4 help
F4_PROGRAMNAME TRDIR-NAME C 40 SPACE X Name of the module pool from F4_FORMNAME
FORMNAME 0 SPACE X Name of the external subroutine for processing
NO_CHECK_FOR_FIXED_VALUES 0 SPACE X Flag: Deactivate check on fixed values (X)
POPUP_TITLE 0 Text of title line
PROGRAMNAME TRDIR-NAME C 40 SPACE X Name of the module pool from FORMNAME
START_COLUMN 0 '5' X Start column of the dialog box
START_ROW 0 '5' X Start line of the dialog box

Parameter Reference Type Length Text
RETURNCODE 0 User response

Parameter Reference Length Optional Text
FIELDS SVAL 278 Table fields, values and attributes

Exception Text
ERROR_IN_FIELDS FIELDS were transferred incorrectly


INCLUDE 'DOCU_HAS_TO_BE_ELABORATED' OBJECT DOKU ID TX
Function
INCLUDE 'POPUP_GET_VALUES_BASE' OBJECT DOKU ID TX
The user input is copied and can be sent to an external subroutine (userexit), which can be specified in the interface of this function module.If you do not specify an external subroutine, the data is returnedwithout being checked.
If you specify an external subroutine, then its interface must consistof the table FIELDS and an error structure. The external subroutineanalyzes the data, processes it as required, and, if an error occurs,fills the error structure accordingly. The function module analyzes theerror structure and either stops the processing or sends an errormessage and lets the user enter new data.
You can also specify user exits for F1 help and F4 help, if you do notwant to display standard F1 help and F4 help.
You can use this function module to do the following:
  • Query values for which a check against the database is not enough.

  • Query values to copy objects.

  • Support prototyping.

    • Examples
    For examples, see the program RSSPO440.
    Notes
    • You can define processing of your choice in the user exits. For example,
      • you can display the dialog box for this function group again.
      INCLUDE 'POPUP_GET_VALUES_NOTES_02' OBJECT DOKU ID TX
      The user action is returned in the parameter. Itcan take the following values:
      • " " (Space)

        • The user wants to perform the action, the user exit did notreturn errors, FIELDS contains the input values
        • "A"

          • The user cancelled the action, FIELDS contains theoriginal values
          F1 help external subroutine names, if the standard F1 help is not to bedisplayed. Define the form routine as follows:
          FORM USING TABNAME FIELDNAME.
          * display F1 help for field TABNAME-FIELDNAME
          ENDFORM.
          Name of the program or module pool in which the form routineF1_FORMNAME is defined, if the standard F1 help is not to be displayed.
          Name of the external subroutine for the F4 help , if the standard F4help is not to be displayed. Define the form routine as follows:
          FORM USING TABNAME FIELDNAME DISPLAY
          CHANGING RETURNCODE VALUE.
          * display F4 help for field TABNAME-FIELDNAME
          * if DISPLAY is 'X', values cannot be selected, they are display-only,
          * e.g. for F4 help for fields which are no ready for input.
          * RETURNCODE field specifies whether the user cancelled the action
          * ('A') or selected a field (SPACE).
          * The selected value must be passed in the field VALUE.
          ENDFORM.
          Name of the program or module pool in which the form routineF4_FORMNAME is defined, if the standard F4 help is not to be displayed.
          The specified form routine can check the input values in a user exit.FORMNAME is the name of the external subroutine (user exit) which iscalled at the PAI event after value input. If FORMNAME is SPACE, theinput values are returned to the user unchecked. Otherwise, define theform routine as follows:
          FORM TABLES FIELDS STRUCTURE SVAL
          CHANGING ERROR STRUCTURE SVALE.
          * copy values from FIELDS into an internal structure
          * process the internal structure, call other dialog boxes
          * ir required
          IF error.
          ERROR handling
          ENDIF.
          ENDFORM.
          INCLUDE 'SPO_PAR_NO_CHECK_FOR_FIXED_V' OBJECT DOKU ID TX
          Dialog box title line text. It must be translatable (e.g. use numberedtexts).
          Name of the program or module pool in which the form routine FORMNAMEis defined, if FORMNAME is specified.
          Column in which the dialog box starts. Default value 5.
          Row in which the dialog box starts. Default value 5.
          The table contains the fields, values and attributes for the layout ofthe dialog box. The fields appear in the sequence that they have inthe FIELDS table. One line must be field for each field that is toappear in the dialog box:
          • TABNAME (table name)

            • The table must be active in the Data Dictionary.
            • FIELDNAME (name of the field to be displayed)

              • The field must belong to the table TABNAME. If a field is to appeartwice, the second field must be passed on with '*' before the tablename (for example, *T001).
              • VALUE (field value)

                • VALUE can be assigned a value when the function module is called up.This value is displayed. If the user does not cancel the action, VALUEcontains the value entered by the user.
                INCLUDE 'FU_POPUP_GET_VALUES_1' OBJECT DOKU ID TX
                • FIELD_ATTR (field attribute)

                  • The field attribute determines the layout attribute of the field andmust have one of the following values:
                  " " (Space) normal display, ready for input
                  "01" highlighted, ready for input
                  "02" normal display, protected against input
                  "03" highlighted, protected against input
                  "04" field is not displayed
                  • FIELD_OBL (obligatory)

                    • This indicator determines whether or not the field is obligatory andmust have one of the following values:
                    " " (Space) The field is optional
                    "X" The field is obligatory
                    • FIELDTEXT (keyword)

                      • In FIELDTEXT the keyword of the field can be specified if thedictionary keyword is not to be used.
                      • COMP_CODE

                        • The field is not required for this function module.
                        • COMP_TAB

                          • The field is not required for this function module.
                          • COMP_FIELD

                            • The field is not required for this function module.
                            • NOVALUEHLP

                              • This indicator specifies whether the value help button should bedisplayed, and must have one of the following values.
                              " " = The value help button is permanently displayed
                              "X" = The value help button is not displayed