BapiService

The business object BAPIService is a service object, whose
methods provide basic BAPI services, such as data conversion.

Available Methods

• ChangeStatus : Enter count quantity and change item status from A to B or C [ BAPI_SVCHANGE_CHANGE_STATUS ]
  
• GetItems : Read retail revaluation document for store, key date, item status [ BAPI_SVCHANGE_GET_ITEMS ]
  

ApplicationLogGetDetail

This method reads the details of entries in the application log. In theparameter 'Logkeys' of this method you can specify which entries are tobe read out. The entries in question are identified in the parameter bythe application log number (LOGNUMBER field) and the message number within the application log (MSGNUMBER field).

If only the application log number is given, all the messages from this application log are read out.

Example

1. Message number 7 in application log 98 is to be read out:

LOGNUMBER = 00000000000000000098
MSGNUMBER = 000007

2. All the messages in application log 97 are to be read out:

LOGNUMBER = 00000000000000000097
MSGNUMBER = ''

Notes

Error messages are returned in the parameter 'Return'.

The documentation on this parameter contains the return codes and their descriptions.

DataConversionExt2Int

This method converts the data in method parameters from the externalformat into the internal format (domain conversion). This type ofconversion is required to prepare data for further processing in the R/3 System.

With this method, you can, for example, convert data from its format
displayed on the screen into the R/3 internal data format. The data tobe formatted is specified and transferred in the "data" parameter. Oncethe method has been called, the converted data is also stored in this parameter.

If no conversion routine for a parameter has been specified in the ABAP
Dictionary, the external data format will be returned unconverted.

Notes

This method is obsolete as of Release 4.5B and should no longer be used. Instead you should use method BapiService.DataConversionExt2Int1. .

Error messages arising from calling the method or converting the data are returned in the parameter RETURN.

The documentation on this parameter contains the return codes and their descriptions.

The method BapiService.DataConversionInt2Ext converts data from the internal format to the external format.

DataConversionExt2Int1

This method converts the data in method parameters from the externalformat into the internal format (domain conversion). This type ofconversion is required to prepare data for further processing in the R/3 System.

With this method, you can, for example, convert data from its format displayed on the screen into the R/3 internal data format.

The data to be formatted is specified and transferred in the "data"parameter. Once the method has been called, the converted data is also stored in this parameter.

If no conversion routine for a parameter has been specified in the ABAPDictionary, the external data format will be returned unconverted.

Notes

Messages for errors when calling the method call or converting the dataare reported in the return parameter. This parameter documentation contains the return values and their meanings.

The method BapiService.DataConversionInt2Ext1 converts data from the internal format to the external format.

The old method BapiService.DataConversionInt2Ext is obsolete and has been replaced by the above method.

DataConversionInt2Ext

This method converts the data in method parameters from the internaldata format into the external data format (domain conversion).

This type of conversion is required to prepare data for the external

format, for example, to display it on the screen. The data to be
converted is specified and transferred in the parameter DATA. After themethod has been called, the converted data is also stored in this structure.

If no conversion routine is specified in the ABAP Dictionary for a parameter, the internal format is returned unconverted.

Notes

This method is obsolete as of Release 4.5B and should no longer be used. Instead use the method:

BapiService.DataConversionInt2Ext1.

Error messages occuring when the method is called or when the data is
converted are returned in the parameter RETURN. The documentation onthis parameter contains the return codes and their descriptions.

The method BapiService.DataConversionExt2Int converts data from the external format into the internal format.

DataConversionInt2Ext1

This method converts the data in method parameters from the internalformat into the external format (domain conversion). This type ofconversion is required to prepare data for external use, for example, to display on the screen.

The data to be formatted is specified and transferred in the "data"
parameter. Once the method has been called, the converted data is also stored in this structure.

If no conversion routine for a parameter has been specified in the ABAPDictionary, the internal data format will be returned unconverted.

Notes

Messages for errors when calling the method call or converting the dataare reported in the return parameter. This parameter documentation contains the return values and their meanings.

The method BapiService.DataConversionExt2Int converts data from the external format to the internal format.

FieldhelpGetDocu

This method reads the documentation (F1 help) for the fields in a BAPI parameter.

With this parameter you can provide end users with information on aspecific field in a BAPI parameter. For example, you can help them to enter a correct value in an input field.

One function of this method's parameters is to identify the field forwhich the documentation is to be displayed. They delimit the businessobject, method and parameter containing the field in question and specify the field.

Example

In this example the F1 help for the field "National" in the parameter
"PersonalData" of the BAPI "Employee.GetList" is to be displayed in RTF format and in English.

Import Parameter Value

OBJTYPE
OBJNAME "Employee"
METHOD "GetList"
PARAMETER
"PersonalData"
FIELD "National"
LANGUAGE "EN"
TEXTFORMAT "RTF"

Notes

Messages are returned in the parameter RETURN. The documentation onthis parameter contains the return codes and their descriptions.

Use this method together with the method HelpValues.GetList. You will find details of this method in its documentation.

HyperLinkGetText

This method reads the documentation for an R/3 object that is linked to in a document and that was created with the methodBapiService.InterfaceGetDocu or the method BapiService.HyperLinkGetText.

In the parameter LinkPattern you can convert the SAPscript hyperlinks into HTML hyperlinks.

InterfaceGetDocu

This method reads the interface documentation for a BAPI.

The method enables you to read out and make available to developers the information they need to implement BAPIs correctly.

The parameters of this method delimit the documentation to be
displayed. With these parameters you can specify whether you want todisplay the documentation on a business object, method, parameter orfield. The BAPI interface documentation below can be accessed with this method:

Example

In this example the documentaion on the BAPI "Employee.GetList" isretrieved without the parameter documentation. It is displayed in English (EN) in RTF text format.

Import Parameter Value

OBJTYPE
OBJNAME "Employee"
METHOD "GetList"
PARAMETER
FIELD
LANGUAGE
"EN"
TEXTFORMAT "RTF"

Notes

Messages are returned in the parameter RETURN. This parameter documentation contains the return codes and their descriptions.

MessageGetDetail

This method returns the short and long texts of BAPI error messages. Inthe parameters of this method you can specify the error message for which the short and long texts are to be displayed.

Notes

Messages are returned in the return parameter. The parameter documentation contains the return codes and their descriptions.

TransactionCommit

This method executes a COMMIT WORK command. It is required fortransactions developed externally to the R/3 System that change data in the R/3 System via BAPI calls.

When you call BAPIs in your program that change data in the R/3 System,afterwards you must call this method to write the changes to the database.

Notes

Messages are returned in the parameter 'return'. This parameter documentation contains the return codes and their descriptions.

Further Information

Use the method BapiService.TransactionRollback to prevent changes to the database being committed.

TransactionRollback

This method executes a ROLLBACK WORK command. It is required fortransactions developed externally to the R/3 System that change data in R/3 Systems via BAPI calls.

If you call BAPIs in your program that change data in R/3 Systems, thismethod can prevent these changes being written to the database. The
prerequisite is that these changes have not already been passed to the database with a COMMIT WORK command.

Notes

Messages are returned in the parameter RETURN. The parameter documentation contains the return codes and their descriptions.

Further Information

The method BapiService.TransactionCommit can write changes made via BAPI calls to the database.