In this article

Overview

This Snap executes the configured SAP business API (BAPI) given input data, if any, and returns an output document that contains the results of the execution. The BAPI input schema and output schema are provided to correctly map data into the SAP BAPI.

Expected upstream Snaps: Field can be mapped using an upstream Mapper Snap, which will allow the mapping of fields or values to the field that are available on the selected service object.

Expected downstream Snaps: The Snap will output one document for every BAPI execution, hence any document processing Snap can be used down stream.

Expected input: Document that conforms to the input view schema of the Snap. The input view schema is provided to an upstream Mapper Snap based on the selected service object.

Expected output: Document which represents the record structure of the retrieved BAPI output definition. Each record is represented as one document on the output view.

SAP BAPIs for Integration

Import parameters contain data to be transferred from SnapLogic to the BAPI. Specific values must be provided as import parameters in order for the BAPI to execute and return the desired data.This is the data stream which will be provided in the input view of the SAP Execute Snap. 

Export parameters contain data to be transferred from the BAPI back to SnapLogic, which is returned back in the output view of the SAP Execute Snap. The data returned back can be of the following types:

• S = success message
• E = error message 
• W = warning message 
• I = information message 
• A = termination message (abort)

The list of BAPI's in a particular SAP client will vary depending on the level of customization, however an exhaustive set is delivered as standardized BAPI's which provide basic functions and can be used to read and write or change data for most SAP Business Objects. 

BAPIs for Reading Data

The following BAPIs provide you with read-only access to data in the associated business object:

• GetList - With the BAPI GetList, you can select a range of object key values, for example, company codes and material numbers.
• GetDetail - The BAPI GetDetail uses a key to retrieve details about an instance (one specific occurrence) of a business object and returns this data to the calling program. Then this information is reported back to the calling program.
• GetStatus - The BAPI GetStatus is used to query the status of an SAP Business Object, for example, the processing status of a sales order. This BAPI is used only for displaying the status of an object and does not retrieve full details like the BAPI GetDetail.
• ExistenceCheck - The BAPI ExistenceCheck checks whether an entry exists for an SAP Business Object, for example, whether the customer master has been created.  

BAPIs for Creating or Changing Data

The following BAPIs can create, change or delete instances of a business object:

• Create or CreateFromData - The BAPI Create or CreateFromData creates an instance of an SAP Business Object, for example, a purchase order.
• Change - The BAPI Change changes an existing instance of a SAP Business Object, for example, a purchase order.
• Delete and Undelete - The BAPI Delete deletes an instance of an SAP Business Object from the database, for example, a purchase order. The BAPI Undelete removes a deletion flag. 
• Add<sub-object> and Remove<sub-object> - The BAPI Add<sub-object> adds a sub-object to an existing object instance and the BAPI and Remove<sub-object> removes a sub-object from an object instance.

Have the SAP BASIS administrator setup the user to be used in the appropriate SAP clients with certain set of authorizations. To execute a BAPI as part of your application program, you must have the appropriate authorizations set up in respective master records. The documentation provided with the BAPI contains information about the required authorizations. 

Any attempts to execute a BAPI that fail as a result of insufficient authorization are reported back to the calling application.

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring SAP Accounts for information on setting up this type of account.

This Snap has at most one input view. A provided input view lets you pass data as input to the BAPI call. The document attributes will be matched to the SAP BAPI metadata, any matching attribute will be provided to the BAPI program at execution, any non-matching attribute will be ignored.  The attributes can be tabular and structured or scalar. An SAP Execute API call is made for each document. If SAP Execute has no input document, SAP Execute calls the BAPI with no input data.

This Snap has exactly one document output view. The documents are being populated using the result data of each BAPI call for each document passed into SAP Execute. If SAP Execute has no input document, only one output document result will be created. 

Settings

Label*

You can use this Snap to execute the SAP Business API (BAPI) with the given input data. The BAPI input schema and output schema must correctly map data into the SAP BAPI.
Image Added

Snap Type

SAP Execute Snap is a Write-type Snap.

Prerequisites

Have the SAP BASIS administrator setup the user to be used in the appropriate SAP clients with certain set of authorizations. To execute a BAPI as part of your application program, you must have the appropriate authorizations set up in respective master records. The documentation provided with the BAPI contains information about the required authorizations. Any attempts to execute a BAPI that fail as a result of insufficient authorization are reported back to the calling application.

Limitations and Known Issues

None.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Snap Views

Snap Settings

Examples

The following examples include: one demonstrate how to retrieve data successfully,  one to insert data successfully in SAP using the applicable BAPI, one and how to show display an error.

[
    {
        "ITM_NUMBER": "1",
        "ORDER_HEADER_IN": {
            "SALES_ORG": "3020",
            "DIVISION": "00",
            "DISTR_CHAN": "30",
            "DOC_TYPE": "TA",
            "PURCH_NO_C": "000004454"
        },
        "PARTN_NUMB": "0000003041",
        "PARTN_ROLE": "AG"
    }
]

Expand
title Sequence of BAPI calls in a Pipeline
The following Pipeline demonstrates a sequence of 3 BAPI calls on service notifications using an SAP instance. Download this Pipeline. In this example Pipeline, a Mapper (Feed Notification Data) is used to prepare the sample attributes for the notification. The output displays the notification attributes. We are using three SAP Execute Snaps to call the following BAPI functions in that sequence. BAPI_SERVNOT_CREATE : To create a service notification using Create Svc Notification Snap. BAPI_SERVNOT_SAVE : To save a service notification using SAP Execute Snap. BAPI_TRANSACTION_COMMIT: To execute external commit when using BAPIs using Save Svc Notification Snap. SAP Execute Snap to call BAPI_SERVNOT_CREATE and create an SAP service notification. SAP Execute Snap to call BAPI_SERVNOT_SAVE and save the SAP service notification. Select the Start Stateful Call Sequence check box to indicate the   beginning of the BAPI sequence. Do not select the Commit after BAPI execute check box. Do not select both the checkboxes in this Snap, as this BAPI is an intermediate call in the BAPI sequence. Mapper Snap to extract the notification number from the saved notification. SAP Execute Snap to call BAPI_TRANSACTION_COMMIT and commit  transaction (save service notification). JSON Formatter Snap to format the output after committing the transaction. Do not select the Start Stateful Call Sequence check box. Select the Commit after BAPI execute check box in this Snap to  indicate the end of the BAPI sequence. File Writer Snap to write the formatted output into a file New_BAPI_Seq_PL_Output.JSON Image Removed

Downloads

• http://help.sap.com/saphelp_46c/helpdata/en/a5/3ec8464ac011d1894e0000e829fbbd/content.htm for a description of BAPI.

Related Content

• BAPIs