|
Functionality
Function module BS_SOA_SHLP_PROVIDER_SERVICE implements the generatedSearch Help Provider Web service (BSSOAQuerySearchHelp).
The function module allows you to reuse elementary search help objectsthat are defined in the ABAP Dictionary of a (remote) provider system.
Main use case: Composite applicationsAuthorization Object
Function module BS_SOA_SHLP_PROVIDER_SERVICE implements theauthorization object BS_SOA_SPS, which has the authorization fieldSHLP_NAME. In the user profile for a customer system, you can specifythe search help objects for which the user is authorized to execute thefunction module. Example
ABAP Dictionary search help name "DD_DATATYPE". Notes
You cannot reuse ABAP Dictionary search help objects that trigger theirown SAP GUI dialog (for example, DD_SHLP). Further information
For more information about the Search Help Provider Web service(BSSOAQuerySearchHelp), see SAP Note 1278095.Description
Returned error messages in GDT log format. Description
Explanatory text of the search help object or search help name that isdefined in the ABAP Dictionary of the provider system. Description
If the value of this parameter is "X", more entries can be returned thanspecified in IV_MAX_OF_ROWS. Description
The system returns all values. If the value is greater than zero, thenumber of entries returned is limited to this value. Value range Default
The default value is 0. Description
Use Case: ABAP Composite
In the ABAP Dictionary of the consumer system, you can create a searchhelp object, use its generic UI, and program the Search HelpProvider service call in the search help exit. You can specify thename of the search help object in the provider system as a backgroundparameter in the search help object in the consumer system. It can thenbe transferred to the function module in the search help exit.
In this case, the IV_SELFIELDDESC parameter remains blank.
Use Case: Java Composite
If the consumer system is a non-ABAP system, the consumer must enter "X"for the IV_SELFIELDDESC parameter. The Web service then returns only themeta information that is required by the consumer system to create aselection screen. In this way, the customer can implement a genericsearch help consumer UI, such as an object value selector.Description
Name of the elementary search help object in the ABAP Dictionary of the(remote) provider system. Value range Description
This metadata is used in a non-ABAP system to generate a hit list UI.Each table entry represents the metadata of one column in the hit list..
If the IV_SELFIELDDESC parameter is set to "X", this table is returnedwith the metadata for the selection screen. Otherwise, the systemreturns the metadata of the hit list (ABAP Dictionary structureBAPIF4E).
- TABNAME: Table name
- FIELDNAME: Field name
- LANGU: Language key
- POSITION: Position of the field in the table
- OFFSET: Offset for a field
- LENG: Length (number of characters)
- FIELDTEXT: Short description of repository objects
- REPTEXT: Header
- SCRTEXT_S: Field label - short
- SCRTEXT_M: Field label - medium
- SCRTEXT_L: Field label - long
- SHLPNAME: Name of a search help
Description
If the parameter IV_SELFIELDDESC is initial in this table, the systemreturns the hit list in a character field that is 255 characters long. Description
If no entries exist in this table, the search help returns as much dataas is specified in IV_MAX_OF_ROWS. However, the customer can use thetable fields SELECT_FLD, SIGN, OPTION, LOW, and HIGH to search forspecific data.
Possible values for "SIGN":
- I: including
- E: excluding
Possible values for "OPTION" (fixed values of the domainSALV_DO_SELOPT_OPTION):
- EQ: equal to
- NE: not equal to
- GE: greater than/equal to
- GT: greater than
- LE: less than/equal to
- LT: less than
- CP: contains pattern
- NP: does not contain pattern
- BT: between interval
- NB: not between interval
|