Skip to content

Xtract BAPI

This page shows how to use the Xtract BAPI component.
The Xtract BAPI component can be used to parameterize and execute SAP function modules and BAPIs for automation.

About Function Modules / BAPIs

Function modules are procedures that encapsulate and reuse global functions in the SAP system. SAP systems contain several predefined functions modules that can be called from any ABAP program. A Business Application Programming Interface (BAPI) is a remote function module that can access business data and processes of an SAP system from different systems.

Custom BAPIs

The use of custom BAPIs (Z function modules) is possible. Issues specific to Z function modules are not included in the scope of support provided by Theobald Software.

Prerequisites

Warning

Missing Authorization.
To use the Xtract BAPI component, access to the designated authority objects (RFC) in SAP must be available. Adjust SAP Authority Objects: BAPI accordingly.

Add an Xtract BAPI Component

Follow the steps below to add an Xtract Table component to your SSIS package:

  1. Drag&drop the Xtract BAPI component from the SSIS toolbox into your data flow task.
    New

  2. Double-click the component. A connection manager is automatically assigned to the component and the main window of the component opens.

    Note

    If there are multiple connection managers, the window "Select Connection Manager" opens, see SAP Connection. Once a connection manager is selected, the main window of the component opens.

The majority of the functions of the component can be accessed in the main window.

Look up a Function Module / BAPI

  1. In the main window of the component, click [ ] to look up a Function Module / BAPI. The window "Function Module Lookup" opens.
    bapi_main-window_add
  2. In the window "Function Module Lookup" enter the name of the function module or BAPI . Use wildcards (*) if needed.
    Look-Up-BAPIs
  3. Click [ ] . Search results are displayed.
  4. Select a Function Module / BAPI and click [OK].

The application returns to the main window of the component.

Define the Xtract BAPI Component

The Xtract BAPI component offers the following options for defining parameters of a Function Module / BAPI:

  1. Add input parameters (data you want to send to SAP) in Imports, see Import Parameters.
    You can enter scalar values or structures .
    import-parameters
  2. Add output parameters (data you want to receive from SAP) in Exports, see Export Parameters.
    Select output by activating the checkbox next to the items.
    BAPI export parameters
  3. Optional: If available, define input and output parameters in Changings, see Changings Parameters.

  4. Add tables to the output of the component or add table parameters to the input of the component in Tables, see Table Parameters.

    • Click [ ] to check the names and data types of the table fields .
    • Activate the checkbox in the output column to add items to the output .
    • Click [ ] to edit the content of the table .

    BAPI table parameters

  5. Optional: If available, define which exceptions thrown by the Function Module / BAPI are ignored during runtime, see Exceptions.

  6. Click [OK] to save the component.

You can now run the SSIS package.

Custom Properties of Xtract BAPI

The Custom Properties are properties that are unique to the component. When parameterizing the component using SSIS variables, the Custom Properties are overwritten.

The Custom Properties of the Xtract BAPI component are displayed in the "Properties" window.

BAPI Properties

Commit Transaction

Some SAP Function Modules require calling the function module BAPI_TRANSACTION_COMMIT to successfully update data in the database, e.g., BAI_PO_CREATE. To automatically call BAPI_TRANSACTION_COMMIT after the selected Function Module / BAPI is processed, aset this option to true.

Last update: July 6, 2024