|
&FUNCTIONALITY&
This method determines the valid help values (F4) for a parameter orfield of a structured BAPI parameter. Example Notes
The help values are based on check tables, fixed domain values, or valuehelps defined in a data element. If no search help of this type isdefined, no help values can be specified.
This method can only be used for BAPI parameters. A check is made to seewhether the field exists in the named parameter, in the method, and inthe business object.
You must send the name or object type name of the business object, themethod, and the parameter with the name defined in the BOR, to theHelpvalues.GetList method. If you have a field from a structuredparameter, you also need to specify its name. You cannot obtain thetotal value help for all fields of a structure by not explicitlyspecifying a field when calling the method.
As an alternative, you can use details in the parameterExplicitShlp tosend specific search helps. The parameters ObjType, ObjName
, Method, Parameter and Field must still befilled, so that the BAPI authorization checks can be made.
Note that this method only takes elementary search helps into account.For collective search helps, read the documentation on the methodHelpvalues.GetSearchHelp.
The help values - together with other useful information - are returnedin the parameter Helpvalues. The data is arranged in the leftcolumn by default.
The Description4HV parameter contains meta information thatdescribes the column contents sent in the Helpvalues parameter.Note that SAP does not guarantee the stability of search helps. You mustuse the Description4HV parameter to correctly interpret thevalues sent in the Helpvalues parameter.
The Values4Field parameter only contains help values withoutshort texts.
You can assign an authorization check to value helps. For dataprotection reasons, tables of type A (master data and transaction data)and tables of type L (temporary data) cannot be read.
Exceptions for master data can be defined with explicit authorizationchecks on the data element of the parameter or the parameter field. Thevalues are only returned if the caller has the correct authorizations.Otherwise, an error message is triggered (see the Returnparameter). The authorization required is documented in each individualBAPI.Example
You want to determine the valid help values for the Nationalfield (country code). The field is in the BAPI Employee.GetListin the PersonalData parameter.
If you call the method with the following parameters:
ObjType
ObjName 'Employee'
Method 'GetList'
Parameter 'PersonalData'
Field 'National'
MaxOfRows '0'
DescriptionOnly 'X'
the Description4HV parameter contains:
TABNAME (Table) FIELDNAME (Field) ... FIELDTEXT (Description)
-----------------------------------------------------------------------
H_T005 LAND1 Country code
H_T005 LANDX Country
H_T005 NATIO Nationality
Note: If you use the test environment of the Function Builder fortesting, you must select case-sensitive.
The help values are sent in the Helpvalues parameter. Thisparameter also usually contains other useful information, such as texts.This texts are in the logon language. The following values are in theHelpvalues parameter:
...
AT Austria Austrian
AU Australia Australian
...
The Values4Field parameter only contains the input values for theNational field:
...
AT
AU
...
The information from the Helpvalues parameter can be offered bythe application in a dialog. A line of the Helpvalues parametercan be selected to access the correct help value in the Values4Field
parameter.
If you only want to select the countries that start with 'A', thefollowing data must be in the Selection4Helpvalues parameter:
SELECT_FLD SIGN OPTION LOW HIGH
---------------------------------------------------------------------
LANDX I CP A*
Messages are returned in the Return parameter. The documentationfor this parameter contains the return codes and their meanings.Further information
For more information, see the BAPI Programming Guide in the SAP Libraryunder CA-BFA. Description
If a processing error occurs, this parameter contains an error messagedescribing the reason why the processing was cancelled. If theparameter is initial after the processing has finished, all internalprocessing steps have run without serious errors. Value range
If an error occurs, the following messages are returned: Input Check Messages
Type Code Message
E S&001 Object type is not available in the BOR
E S&002 Method is not available for the object type
E S&003 Parameter of object method is not available
E S&004 Field of method parameter does not exist
E S&005 SELECTION_FOR_HELPVALUES-SIGN unequal to I,E
E S&006 Invalid relational operator inSELECTION_FOR_HELPVALUES-OPTION (Allowed: =, <>, <=, >=, EQ, ,,,,NE,LE,LT, GE, GT)
E S&007 Invalid value for SELECTION_FOR_HELPVALUES-OPTION inlimitation of the value range in ,,,,SELECTION_FOR_HELPVALUES-LOW andSELECTION_FOR_HELPVALUES-HIGH (valid values: ,,,,BT, NB)
E OL852 Object name is not available in the BOR Input Help Messages E,,S&13,,No possible values for the parameter in consistent search help
E S&033 No search help found for the parameter to determine possiblevalues
E,,S&038,,Collective search help for the parameter not processed
E,,S&39,,search help for determining a possible value for the parameteris inconsistent Authorization Messages
E S&024 You are not authorized to access data for the possible values
E,,S&034,,An error has occured while checking the data type (masterdata, transaction data etc.)
E,,S&035,,Display of temporary and transaction data not permitted E,,S
037,,no authorization check available for master data Messages for Internal Error Scenarios
No search help defined for transferring the entry values for BAPIparameters Default Description
If the parameter contains the value 'X', only the description of thehelp values is retrieved and returned in parameter Description4HV. Default
BLANK. Description
In the fields of this parameter, you can transfer unique search helpfor a field. However, this is only
possible for basic search help. Collective search help cannot beprocessed by the method Helpvalues.GetList.
You can fill this parameter using the function moduleBAPI_HELPVALUES_GET_SEARCHHELP
.Description
Name of the field of a method parameter for which you want to outputthe valid value ranges.
To find a field name, find the reference structure of the parameter inthe Business Object Repository. You can use the reference structure inthe ABAP Dictionary to display information about the individual fieldsof the parameter.
If the method parameter that contains the field does not consist of astructure or table (which means it is a field) you must make sure ofthe following:
- the name of the field is specified in the Parameter parameter of
the Helpvalues.GetList method.
- the Field parameter of the Helpvalues.GetList method is
set to BLANK.Description
Maximum number of input values (F4) for the selected field. Default
0 = All available input values (F4) are returned. Description
Name of the business object method, for example "GetList", containingthe parameter and the field for which input help (F4 help) has beenrequested. Description
The name of the object type in the Business Object Repository.
The object type name is the business description of the object type.Like the object type ID, the name is unique.
Keep in mind that the object name is case-sensitive and enter the nameexactly as it appears in the BOR. To identify the business object youmust either specify the object name in the parameter ObjName or theobject type ID in the parameter ObjType, when the method is called.
An example of an object name is "Employee" with its object type"BUS1065".
For information about the meaning of the object name, see the relevantdata element documentation: Object NameDescription
The ID of the object type. This is the technical key of the object typein the Business Object Repository.
To identify the business object either the object type ID must bespecified in the parameter ObjType or the object name must be specifiedin the parameter ObjName, when the method is called.
An example of an object type is "BUS1065" with its object name"Employee".
For information about the meaning of the object type, see the relevantdata element documentation: Object TypeDescription
Name of the parameter of a method, for example "PERSONALDATA",containing the field for which input help (F4 help) is requested.
If the parameter does not consist of a structure or a table (it'sactually a field), you must:
- Enter the name of the field in the parameter Parameter of the method
Helpvalues.GetList.
- Set the parameter Field of the method Helpvalues.GetList to BLANK.
Description
This parameter contains the meta data (description) of the values inthe parameter Helpvalues. This data is used to define the selectionconditions in the parameter Selection4Helpvalues.
The contents of Description4HV corresponds to the description of theunderlying search help for the data element of the field. As searchhelp cannot be frozen, the contents of this parameter can also change.SAP does not guarantee the stability of search help. For this reasonyou must not program any hard code in this parameter.
The contents of this parameter can be provided dynamically, ifindividual fields of search help are to be selected. If the parameterDescriptionOnly has been set, only this parameter is returned. Example
When the method and following parameter settings are called:
ObjType
ObjName 'Employee'
Method 'GetList'
Parameter 'PersonalData'
Field 'National'
MaxOfRows '5'
DescriptionOnly
Description4HV receives the contents:
TABNAME FIELDNAME POSI OFFSET LENG ... SCRTEXT_M
---------------------------------------------------------
T005 LAND1 1 0 000003 Country
T005T LANDX 2 3 000015 Description
T005T NATIO 3 18 000015 Nationality
The contents of Helpvalues is:
AD Andorra Andorran
AE United Arab Emirates United Arab Emirate
AF Afghanistan Afghan
AG Antigua/Barbuda Antiguan
AI Anguilla Anguillan
For example, the second column in the parameter Helpvalues can bedetermined using the offset values in Description4HV.
Offset 0 is the first character in a Helpvalue line.
Description
This table returns the number of hits based on the search help for thefield whereby selection criteria are taken into account in theparameter Selection4Helpvalues.
Descriptions of the columns contained in this parameter are located inthe parameter Description4HV. Note:
You can access individual items of information indirectly in thisparameter via the parameter Description4HV. This parameter contains thecorrect offset entries.
This is because the underlying search help is not frozen and thereforethe output of this parameter can change.
SAP cannot guarantee the stability of the contents of this parameter.For more information, see to the documentation for the parameterDescription4HV. Description
You can use this parameter to restrict the hit list by specifyingselection conditions. You can also make foreign key checks (see'Foreign Key Checks' below). Value range
The table consists of the following fields:
SELECT_FLD
Name of the field whose values you want to restrict. The valid fieldsdepend on the search help and its fields. These fields are listed inthe Description4HV parameter in the Fieldname field. If themethod is called with the DescriptionOnly parameter and thevalue 'X', then only the Description4HV parameter is filled. Inthis way you can find out which selection fields are filled. See alsothe documentation on the Description4HV paramter.
SIGN
Inclusive or exclusive set of values.
Possible values:
I = Inclusive
E = Exclusive
OPTION
Specifies the comparison operator.
Possible values:
EQ Equal
NE Not equal
GT Greater than
GE Greater than or equal (>=LOW)
LE Less than or equal
LT Less than
CP Contains pattern
NP No pattern
BT Between
NB Not between
LOW
Lower limit of the range of values. You can use placeholders, such asF*.
HIGH
Upper limit of the range of values. You can use placeholders, such asA*.Foreign Key Checks
Foreign keys are defined with the BAPI structures in the ABAPDictionary. They are used to show dependencies between fields and todefine the valid values of a dependent field. The fields appear in theDescription4HV parameter. You can find out which fields haveforeign key relationships in the ABAP Dictionary entries for the BAPIstructures. To find the BAPI structures, access the ABAP Dictionaryfrom a BAPI parameter in the BOR.Example
You want to restrict the values for the "National" field (country code)to those countries that start with 'A'.
If you call the method with the following parameters:
ObjType
ObjName 'Employee'
Method 'GetList'
Parameter 'PersonalData'
Field 'National'
MaxOfRows '0'
DescriptionOnly 'X'
the Description4HV parameter contains the following:
TABNAME (Table) FIELDNAME (Field) ... FIELDTEXT (Name)
-----------------------------------------------------------------------
H_T005 LAND1 .... Country code
H_T005 LANDX .... Country
H_T005 NATIO .... Nationality
The Selection4Helpvalues parameter must contain the followingdata:
SELECT_FLD SIGN OPTION LOW HIGH
---------------------------------------------------------------------
LANDX I CP ANote
For more information on the search helps that give you help values, seethe ABAP Dictionary. Description
This parameter contains the number of hits for the field for whichinput help has been requested.
The number of lines is the same as the number in the parameterHelpvalues so that possible values can be displayed via Helpvalues toascertain the number of lines. The information on the lines enables thevalue to be selected from the correct line in the parameterValues4Field and assigned to the parameterized field at the interface.
|