1. Home
  2. Documentation
  3. Integrations
  4. Management Systems - SAP BAPI

Management Systems - SAP BAPI

Create and configure connectors in the old canvas
  • SAP BAPI

Overview

The SAP BAPI connector allows you to integrate your flow with the SAP ERP through Business Application Programming Interfaces (BAPIs), which are standardized functions to access business processes and data in the SAP system.

In other words, a BAPI is like an "official gateway" that SAP provides so that external systems can query or manipulate data and processes without needing to directly access internal tables or write ABAP code.

What you can do

  • Query data

    • Retrieve information about customers, vendors, materials, sales orders, inventory, etc.

      Example: BAPI_CUSTOMER_GETDETAIL returns complete customer data.

  • Create records

    • Insert new business data into SAP.

      Example: BAPI_SALESORDER_CREATEFROMDAT2 creates a sales order.

  • Update records

    • Modify existing data.

      Example: BAPI_EMPLOYEE_CHANGE updates employee data.

  • Execute business operations

    • Trigger internal SAP processes (release documents, perform calculations, generate accounting entries).

      Example: BAPI_GOODSMVT_CREATE records an inventory movement.

  • Test connection and availability

    • Validate if SAP is responding.

      Example: STFC_CONNECTION (returns system information, client, user, etc.).

Instruction structure (syntax)

Communication with this connector uses a specific key-value structure to map BAPI parameters.

  • Command: always starts with CALL FUNCTION <BAPI_NAME>.

  • Parameters: are defined after the colon ":".

  • Groupings:

    • Parentheses ( ): enclose a single key-value pair or an object.
    • Brackets [ ]: enclose lists of items or multiple parameters.
  • Syntax:

Examples

Check out examples of instructions for the SAP BAPI connector:

Connectivity validation

Instruction:

In the instruction below, the SAP BAPI connector calls the STFC_CONNECTION function in SAP. This function is a standard SAP BAPI, used to test connectivity between the client system (in this case, Sensedia Integrations) and the SAP server.

NOTE

The brackets [] indicate that no additional parameters were passed in the call.

Return (log):

  • The log excerpt shows the successful execution of the SAP BAPI connector when calling the STFC_CONNECTION test function.
  • SAP responded to the request confirming the connection with information about system, client, user, and date/time.
  • HTTP status 200 ensures there was no integration error.
NOTE

Read about log details.

Table reading

Instruction:

The instruction below reads the first 5 rows of table T001 in SAP, returning only the BUKRS and BUTXT fields, separated by semicolons.

Instruction parts:

  • FUNCTION RFC_READ_TABLE: defines that the table reading function will be executed.
  • IMPORTING: contains simple input parameters that configure the function call.
    • QUERY_TABLE: T001: indicates the table to be queried (T001, which contains Company Codes information).
    • DELIMITER: ;: defines that returned fields will be separated by semicolons.
    • ROWCOUNT: 5: limits the return to the first 5 rows of the table.
  • TABLES: defines parameters in table format, used to send or receive lists of records.
    • FIELDS: specifies the table fields that should be returned (if omitted, returns all columns, which may cause slowness or memory overflow).
      • BUKRS: company code (Company Code).
      • BUTXT: company description (Company Name).

Return (log):

Check two excerpts of the response payload recorded in the logs:

INPUT: shows the query parameters: queried table, maximum number of records, delimiter, and additional options.

DATA (excerpt): brings the values returned from the query.

In this example:

  • The WA (Work Area) field brings the data concatenated by the chosen delimiter
  • 300: MANDT (SAP Client)
  • 0001: BUKRS (Company Code)
  • SAP Brazil: BUTXT (Company Name)
  • Sao Paolo: ORT01 (City)
  • BR: LAND1 (Country)
  • BRL: WAERS (Currency)

Possible configuration errors

Below we list some common errors that may occur when using the SAP BAPI connector and recommended solutions.

  • Error calling BAPI function in SAP

    Generic execution error.

    • Check if the configured user has access permission (object S_TABU_DIS) to the requested table or execution permission in the BAPI.
    • Check if the field names in FIELDS exist in the table.
  • Empty return (DATA: [])

    No record matches the criteria defined in OPTIONS.

    • Check if the date is in YYYYMMDD format.
    • Check if the values are in uppercase, as SAP is case-sensitive for data.
  • ROWCOUNT ignored

    SAP returned more rows than requested.

    NOTE

    This occurs in certain versions of the function module when there is no primary index in the filter.

    • Apply a script or filter component in your flow to eliminate excess rows.

Creating and editing a connector

To create a connector, follow the steps below:

Access the Connector Manager screen from the left menu of the product or by clicking the card on the Welcome screen.

Click + NEW CONNECTOR in the upper right corner of the screen.

Select the connector card.

A new screen, Connector Configuration, will open. Fill in the following data in the connector form:

In Name, give the connector a name.

In Version, enter its version.

In Description (optional), add a description.

Select the environment in which you will deploy the connector.

Fill in the values for the required fields for each connector.

Click CREATE.

NOTE

If you select both environments, you must fill in the complete data for both to be able to create the connector.

To edit the connector, follow the steps below:

Click on the connector you want to edit.

You can change:

  • The description in the Description field.
  • The environment selected for deployment: staging or production (there must be at least one environment enabled).
  • The information in the selected environment form, even if the connector is in use in any integration flow.

When you finish your edits, click SAVE.

IMPORTANT

You cannot delete a connector while it is in use in any integration.

Required fields

Field
Description
SAP Application ServerThe hostname or IP address of the SAP application server you want to connect to.
Service Name of the GatewayThe service name identifies the specific service or port on the SAP gateway through which communication will occur.
Logon PasswordThis is the password associated with the SAP user specified in the "Logon User" field. It is required for authentication purposes to establish a connection to the SAP system.
SAP ClientThe client number you want to connect to. Different clients may contain different datasets or configurations.
Hostname of the GatewayThe hostname or IP address of the SAP gateway, through which communication will be routed.
SAP System NumberThe system number uniquely identifies an SAP system within a landscape. It is essential for directing communication to the correct SAP system when multiple systems are running on the same host.
SAP Logon LanguageSpecifies the language in which the SAP system should present messages and user interfaces.
Logon UserThe SAP username with which the connector will authenticate to the SAP system.
NOTE

See more details about SAP BAPI with instruction examples and common configuration issues.

NOTE

For optional fields that are not filled in, the default value will be applied.

Configuring a connector

After creating the connector, you must configure it on the Flow screen. To do this, follow the steps below:

Adding the connector to the canvas

Access the Integration Flows screen and select your integration flow.

If you want to create a new flow, click + NEW FLOW and access the Flow screen.

NOTE

Click the hub icon with plus sign icon in the left editing menu.

Choose the connector you want. You can use the search bar to find it.

Connect it to a previous step if you want to use the properties of other steps.

TIP

To copy the step, click the copy icon button. If the step form is already configured, the settings are copied as well.

To remove the connector from the canvas, select it and click the trash icon button.

Configuring the form

Select the connector on the canvas.

Click the edit icon pencil icon.

Fill in the following form fields:

  • Name: enter the connector name.

  • Connector: select one of the registered connectors.

  • Timeout: enter the request timeout in milliseconds.

    By default, the value will be 3000 milliseconds and the maximum value is 60000 ms.

    NOTE

    By clicking the list icon icon to the right of the Timeout field, you can filter and display environment variables and the payload of previous steps (if the steps are connected) for use in timeout configuration.

  • Properties: use environment variables and properties from previous steps to build your script in Instruction.

  • Instruction: create your script by inserting input attributes or creating an expression by clicking the fx button button to the right. The Concat function is available for creating the expression. This field comprises the native syntax of the protocol to which the connector provides access.

  • Ignore Errors: by default, this button is disabled and you can enable it.

    Check out more details about the Ignore Errors function in the table below:

    Enabled
    Disabled
    Flow execution continues, even if there are errors in the process.Execution will be stopped immediately.
    Logs show the step with error.Logs show execution up to the step with error.
    Following steps will be executed.No following steps will be executed.

Click SAVE.

How happy are you with this page?

We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more