Connect to SAP systems from Azure Logic Apps

This article explains how you can access your SAP resources from Logic Apps using the SAP connector.

Prerequisites

SAP compatibility

The SAP connector is compatible with the following types of SAP systems:

  • On-premises and cloud-based HANA-based SAP systems, such as S/4 HANA.

  • Classic on-premises SAP systems, such as R/3 and ECC.

The SAP connector supports the following message and data integration types from SAP NetWeaver-based systems:

  • Intermediate Document (IDoc)

  • Business Application Programming Interface (BAPI)

  • Remote Function Call (RFC) and Transactional RFC (tRFC)

The SAP connector uses the SAP .NET Connector (NCo) library. You can use the following SAP actions and trigger with the connector:

  • Send message to SAP to send IDocs over tRFC action, which you can use to:

    • Call BAPI functions over RFC

    • Call RFC/tRFC in SAP systems

    • Create or close stateful sessions

    • Commit or roll back BAPI transactions

    • Confirm a transaction identifier

    • Send IDocs, get an IDoc's status from its number, and get a list of IDocs for a transaction

    • Read an SAP table

  • When a message is received from SAP trigger, which you can use to:

    • Receive IDocs over tRFC

    • Call BAPI functions over tRFC

    • Call RFC/tRFC in SAP systems

  • Generate schemas action, which you can use to generate schemas for the SAP artifacts for IDoc, BAPI, or RFC.

To use these SAP actions, you need to first authenticate your connection with a username and password. The SAP connector also supports Secure Network Communications (SNC). You can use SNC for SAP NetWeaver single sign-on (SSO), or for additional security capabilities from external products. If you use SNC, see the SNC prerequisites.

Migrate to current connector

The previous SAP Application Server and SAP Message server connectors were deprecated February 29, 2020. To migrate to the current SAP connector, follow these steps:

  1. Update your on-premises data gateway to the current version. For more information, see Install an on-premises data gateway for Azure Logic Apps.

  2. In your logic app that uses the deprecated SAP connector, delete the Send to SAP action.

  3. Add the Send message to SAP action from the current SAP connector.

  4. Reconnect to your SAP system in the new action.

  5. Save your logic app.

Multi-tenant Azure prerequisites

These prerequisites apply if your logic app runs in multi-tenant Azure. The managed SAP connector doesn't run natively in an ISE.

Tip

If you're using a Premium-level ISE, you can use the SAP ISE connector instead of the managed SAP connector. For more information, see the ISE prerequisites.

The managed SAP connector integrates with SAP systems through your on-premises data gateway. For example, in send message scenarios, when a message is sent from a logic app to an SAP system, the data gateway acts as an RFC client and forwards the requests received from the logic app to SAP. Likewise, in receive message scenarios, the data gateway acts as an RFC server that receives requests from SAP and forwards them to the logic app.

ISE prerequisites

These prerequisites apply if you're running your logic app in a Premium-level ISE. However, they don't apply to logic apps running in a Developer-level ISE. An ISE provides access to resources that are protected by an Azure virtual network and offers other ISE-native connectors that let logic apps directly access on-premises resources without using on-premises data gateway.

  1. If you don't already have an Azure Storage account with a blob container, create a container using either the Azure portal or Azure Storage Explorer.

  2. Download and install the latest SAP client library on your local computer. You should have the following assembly files:

    • libicudecnumber.dll

    • rscp4n.dll

    • sapnco.dll

    • sapnco_utils.dll

  3. Create a .zip file that includes these assembly files. Upload the package to your blob container in Azure Storage.

  4. In either the Azure portal or Azure Storage Explorer, browse to the container location where you uploaded the .zip file.

  5. Copy the URL of the container location. Make sure to include the Shared Access Signature (SAS) token, so the SAS token is authorized. Otherwise, deployment for the SAP ISE connector fails.

  6. Install and deploy the SAP connector in your ISE. For more information, see Add ISE connectors.

    1. In the Azure portal, find and open your ISE.

    2. On the ISE menu, select Managed connectors > Add. From the connectors list, find and select SAP.

    3. On the Add a new managed connector pane, in the SAP package box, paste the URL for the .zip file that has the SAP assemblies. Again, make sure to include the SAS token.

  7. Select Create to finish creating your ISE connector.

  8. If your SAP instance and ISE are in different virtual networks, you also need to peer those networks so they are connected.

SAP client library prerequisites

These are the prerequisites for the SAP client library that you're using with the connector.

  • Make sure that you install the latest version, SAP Connector (NCo 3.0) for Microsoft .NET 3.0.22.0 compiled with .NET Framework 4.0 - Windows 64-bit (x64). Earlier versions of SAP NCo might experience issues when more than one IDoc message is sent at the same time. This condition blocks all later messages sent to the SAP destination, which causes the messages to time out.

  • You must have the 64-bit version of the SAP client library installed, because the data gateway only runs on 64-bit systems. Installing the unsupported 32-bit version results in a "bad image" error.

  • Copy the assembly files from the default installation folder to another location, based on your scenario as follows.

    • For logic apps running in an ISE, follow the ISE prerequisites instead.

    • For logic apps running in multi-tenant Azure and using your on-premises data gateway, copy the assembly files to the data gateway installation folder.

      • If your SAP connection fails with the error message, Please check your account info and/or permissions and try again, make sure you copied the assembly files to the data gateway installation folder.

      • Troubleshoot further issues using the .NET assembly binding log viewer. This tool lets you check that your assembly files are in the correct location.

      • Optionally, select the Global Assembly Cache registration option when you install the SAP client library.

Note the following relationships between the SAP client library, the .NET Framework, the .NET runtime, and the gateway:

  • Both the Microsoft SAP Adapter and the gateway host service use .NET Framework 4.7.2.

  • The SAP NCo for .NET Framework 4.0 works with processes that use .NET runtime 4.0 to 4.8.

  • The SAP NCo for .NET Framework 2.0 works with processes that use .NET runtime 2.0 to 3.5, but no longer works with the latest gateway.

SNC prerequisites

If you use an on-premises data gateway with optional SNC, which is only supported in multi-tenant Azure, you must configure these additional settings.

If you're using SNC with SSO, make sure the data gateway service is running as a user who is mapped against the SAP user. To change the default account, select Change account, and enter the user credentials.

Screenshot of On-premises data gateway settings in the Azure Portal, showing Service Settings page with button to change the gateway service account selected.

If you're enabling SNC through an external security product, copy the SNC library or files on the same computer where your data gateway is installed. Some examples of SNC products include sapseculib, Kerberos, and NTLM. For more information about enabling SNC for the data gateway, see Enable Secure Network Communications.

Send IDoc messages to SAP server

Follow these examples to create a logic app that sends an IDoc message to an SAP server and returns a response:

  1. Create a logic app that is triggered by an HTTP request.

  2. Create an action in your workflow to send a message to SAP.

  3. Create an HTTP response action in your workflow.

  4. Create a remote function call (RFC) request-response pattern, if you're using an RFC to receive replies from SAP ABAP.

  5. Test your logic app.

Create HTTP request trigger

Note

When a logic app receives IDocs from SAP, the request trigger now supports the SAP plain XML format. To receive IDocs as plain XML, use the trigger When a message is received from SAP. Set the parameter IDOC Format to SapPlainXml.

First, create a logic app with an endpoint in Azure to send HTTP POST requests to your logic app. When your logic app receives these HTTP requests, the trigger fires and runs the next step in your workflow.

  1. In the Azure portal, create a blank logic app, which opens the Logic Apps Designer.

  2. In the search box, enter http request as your filter. From the Triggers list, select When a HTTP request is received.

    Screenshot of Logic Apps Designer, showing a new HTTP request trigger being added to the logic app.

  3. Save your logic app so that you can generate an endpoint URL for your logic app. On the designer toolbar, select Save. The endpoint URL now appears in your trigger.

    Screenshot of Logic Apps Designer, showing HTTP request trigger with generated POST URL being copied.

Create SAP action to send message

Next, create an action to send your IDoc message to SAP when your HTTP request trigger fires.

  1. In the Logic Apps Designer, under the trigger, select New step.

    Screenshot of Logic Apps Designer, showing logic app being edited to add a new step.

  2. In the search box, enter sap as your filter. From the Actions list, select Send message to SAP.

    Screenshot of Logic Apps Designer, showing selection of "Send message to SAP" action.

    Or, you can select the Enterprise tab, and select the SAP action.

    Screenshot of Logic Apps Designer, showing selection of "Send message to SAP" action under Enterprise tab.

  3. If your connection already exists, continue to the next step. If you're prompted to create a new connection, provide the following information to connect to your on-premises SAP server.

    1. Provide a name for the connection.

    2. If you're using the data gateway, follow these steps:

      1. In the Data Gateway section, under Subscription, first select the Azure subscription for the data gateway resource that you created in the Azure portal for your data gateway installation.

      2. Under Connection Gateway, select your data gateway resource in Azure.

    3. Continue providing connection information. For the Logon Type property, follow the step based on whether the property is set to Application Server or Group:

      • For Application Server, these properties, which usually appear optional, are required:

        Create SAP application server connection

      • For Group, these properties, which usually appear optional, are required:

        Create SAP message server connection

      By default, strong typing is used to check for invalid values by performing XML validation against the schema. This behavior can help you detect issues earlier. The Safe Typing option is available for backward compatibility and only checks the string length. Learn more about the Safe Typing option.

    4. When you're finished, select Create.

      Logic Apps sets up and tests your connection to make sure that the connection works properly.

    Note

    If you receive the following error, there is a problem with your installation of the SAP NCo client library:

    Test connection failed. Error 'Failed to process request. Error details: 'could not load file or assembly 'sapnco, Version=3.0.0.42, Culture=neutral, PublicKeyToken 50436dca5c7f7d23' or one of its dependencies. The system cannot find the file specified.'.'

    Make sure to install the required version of the SAP NCo client library and meet all other prerequisites.

  4. Now find and select an action from your SAP server.

    1. In the SAP Action box, select the folder icon. From the file list, find and select the SAP message you want to use. To navigate the list, use the arrows.

      This example selects an IDoc with the Orders type.

      Find and select IDoc action

      If you can't find the action you want, you can manually enter a path, for example:

      Manually provide path to IDoc action

      Tip

      Provide the value for SAP Action through the expression editor. That way, you can use the same action for different message types.

      For more information about IDoc operations, see Message schemas for IDoc operations.

    2. Click inside the Input Message box so that the dynamic content list appears. From that list, under When a HTTP request is received, select the Body field.

      This step includes the body content from your HTTP Request trigger and sends that output to your SAP server.

      Select the "Body" property from trigger

      When you're finished, your SAP action looks like this example:

      Complete the SAP action

  5. Save your logic app. On the designer toolbar, select Save.

Send flat file IDocs

You can use IDocs with a flat file schema if you wrap them in an XML envelope. To send a flat file IDoc, use the generic instructions to create an SAP action to send your IDoc message with the following changes.

  1. For the Send message to SAP action, use SAP action URI http://microsoft.lobservices.sap/2007/03/Idoc/SendIdoc.

  2. Format your input message with an XML envelope. For an example, see the following example XML payload:

<ReceiveIdoc xmlns="http://Microsoft.LobServices.Sap/2007/03/Idoc/"><idocData>EDI_DC 3000000001017945375750 30INVOIC011BTSVLINV30KUABCABCFPPC LDCA X004010810 4 SAPMSX LSEDI ABCABCFPPC 000d3ae4-723e-1edb-9ca4-cc017365c9fd 20210217054521INVOICINVOIC01ZINVOIC2RE 20210217054520
E2EDK010013000000001017945375000001E2EDK01001000000010 ABCABC1.00000 0060 INVO9988298128 298.000 298.000 LB Z4LR EN 0005065828 L
E2EDKA1 3000000001017945375000002E2EDKA1 000000020 RS ABCABCFPPC 0005065828 ABCABCABC ABCABC Inc. Limited Risk Distributor ABCABC 1950 ABCABCABCA Blvd ABCABAABCAB L5N8L9 CA ABCABC E ON V-ABCABC LDCA
E2EDKA1 3000000001017945375000003E2EDKA1 000000020 AG 0005065828 ABCABCFPPC ABCABC ABCABC ABCABC - FPP ONLY 88 ABCABC Crescent ABCABAABCAB L5R 4A2 CA ABCABC 111 111 1111 E ON ABCABCFPPC EN
E2EDKA1 3000000001017945375000004E2EDKA1 000000020 RE 0005065828 ABCABCFPPC ABCABC ABCABC ABCABC - FPP ONLY 88 ABCABC Crescent ABCABAABCAB L5R 4A2 CA ABCABC 111 111 1111 E ON ABCABCFPPC EN
E2EDKA1 3000000001017945375000005E2EDKA1 000000020 RG 0005065828 ABCABCFPPC ABCABC ABCABC ABCABC - FPP ONLY 88 ABCABC Crescent ABCABAABCAB L5R 4A2 CA ABCABC 111 111 1111 E ON ABCABCFPPC EN
E2EDKA1 3000000001017945375000006E2EDKA1 000000020 WE 0005001847 41 ABCABC ABCABC INC (ABCABC) DC A. ABCABCAB 88 ABCABC CRESCENT ABCABAABCAB L5R 4A2 CA ABCABC 111-111-1111 E ON ABCABCFPPC EN
E2EDKA1 3000000001017945375000007E2EDKA1 000000020 Z3 0005533050 ABCABCABC ABCABC Inc. ABCA Bank Swift Code -ABCABCABCAB Sort Code - 1950 ABCABCABCA Blvd. Acc No -1111111111 ABCABAABCAB L5N8L9 CA ABCABC E ON ABCABCFPPC EN
E2EDKA1 3000000001017945375000008E2EDKA1 000000020 BK 1075 ABCABCABC ABCABC Inc 1950 ABCABCABCA Blvd ABCABAABCAB ON L5N 8L9 CA ABCABC (111) 111-1111 (111) 111-1111 ON
E2EDKA1 3000000001017945375000009E2EDKA1 000000020 CR 1075 CONTACT ABCABCABC 1950 ABCABCABCA Blvd ABCABAABCAB ON L5N 8L9 CA ABCABC (111) 111-1111 (111) 111-1111 ON
E2EDK02 3000000001017945375000010E2EDK02 000000020 0099988298128 20210217
E2EDK02 3000000001017945375000011E2EDK02 000000020 00140-N6260-S 20210205
E2EDK02 3000000001017945375000012E2EDK02 000000020 0026336270425 20210217
E2EDK02 3000000001017945375000013E2EDK02 000000020 0128026580537 20210224
E2EDK02 3000000001017945375000014E2EDK02 000000020 01740-N6260-S
E2EDK02 3000000001017945375000015E2EDK02 000000020 900IAC
E2EDK02 3000000001017945375000016E2EDK02 000000020 901ZSH
E2EDK02 3000000001017945375000017E2EDK02 000000020 9078026580537 20210217
E2EDK03 3000000001017945375000018E2EDK03 000000020 02620210217
E2EDK03 3000000001017945375000019E2EDK03 000000020 00120210224
E2EDK03 3000000001017945375000020E2EDK03 000000020 02220210205
E2EDK03 3000000001017945375000021E2EDK03 000000020 01220210217
E2EDK03 3000000001017945375000022E2EDK03 000000020 01120210217
E2EDK03 3000000001017945375000023E2EDK03 000000020 02420210217
E2EDK03 3000000001017945375000024E2EDK03 000000020 02820210418
E2EDK03 3000000001017945375000025E2EDK03 000000020 04820210217
E2EDK17 3000000001017945375000026E2EDK17 000000020 001DDPDelivered Duty Paid
E2EDK17 3000000001017945375000027E2EDK17 000000020 002DDPdestination
E2EDK18 3000000001017945375000028E2EDK18 000000020 00160 0 Up to 04/18/2021 without deduction
E2EDK28 3000000001017945375000029E2EDK28 000000020 CA BOFACATT Bank of ABCABAB ABCABC ABCABAB 50127217 ABCABCABC ABCABC Inc.
E2EDK28 3000000001017945375000030E2EDK28 000000020 CA 026000082 ABCAbank ABCABC ABCABAB 201456700OLD ABCABCABC ABCABC Inc.
E2EDK28 3000000001017945375000031E2EDK28 000000020 GB ABCAGB2L ABCAbank N.A ABCABA E14, 5LB GB63ABCA18500803115593 ABCABCABC ABCABC Inc. GB63ABCA18500803115593
E2EDK28 3000000001017945375000032E2EDK28 000000020 CA 020012328 ABCABANK ABCABC ABCABAB ON M5J 2M3 2014567007 ABCABCABC ABCABC Inc.
E2EDK28 3000000001017945375000033E2EDK28 000000020 CA 03722010 ABCABABC ABCABABC Bank of Commerce ABCABAABCAB 64-04812 ABCABCABC ABCABC Inc.
E2EDK28 3000000001017945375000034E2EDK28 000000020 IE IHCC In-House Cash Center IHCC1075 ABCABCABC ABCABC Inc.
E2EDK28 3000000001017945375000035E2EDK28 000000020 CA 000300002 ABCAB Bank of ABCABC ABCABAB 0021520584OLD ABCABCABC ABCABC Inc.
E2EDK28 3000000001017945375000036E2EDK28 000000020 US USCC US Cash Center (IHC) city USCC1075 ABCABCABC ABCABC Inc.
E2EDK29 3000000001017945375000037E2EDK29 000000020 0064848944US A CAD CA ABCABC CA United States US CA A Air Air
E2EDKT1 3000000001017945375000038E2EDKT1 000000020 ZJ32E EN
E2EDKT2 3000000001017945375000039E2EDKT2 000038030 GST/HST877845941RT0001 *
E2EDKT2 3000000001017945375000040E2EDKT2 000038030 QST1021036966TQ0001 *
E2EDKT1 3000000001017945375000041E2EDKT1 000000020 Z4VL
E2EDKT2 3000000001017945375000042E2EDKT2 000041030 0.000 *
E2EDKT1 3000000001017945375000043E2EDKT1 000000020 Z4VH
E2EDKT2 3000000001017945375000044E2EDKT2 000043030 *
E2EDK14 3000000001017945375000045E2EDK14 000000020 008LDCA
E2EDK14 3000000001017945375000046E2EDK14 000000020 00710
E2EDK14 3000000001017945375000047E2EDK14 000000020 00610
E2EDK14 3000000001017945375000048E2EDK14 000000020 015Z4F2
E2EDK14 3000000001017945375000049E2EDK14 000000020 0031075
E2EDK14 3000000001017945375000050E2EDK14 000000020 021M
E2EDK14 3000000001017945375000051E2EDK14 000000020 0161075
E2EDK14 3000000001017945375000052E2EDK14 000000020 962M
E2EDP010013000000001017945375000053E2EDP01001000000020 000011 2980.000 EA 298.000 LB MOUSE 298.000 Z4TN 4260
E2EDP02 3000000001017945375000054E2EDP02 000053030 00140-N6260-S 00000120210205 DFUE
E2EDP02 3000000001017945375000055E2EDP02 000053030 0026336270425 00001120210217
E2EDP02 3000000001017945375000056E2EDP02 000053030 0168026580537 00001020210224
E2EDP02 3000000001017945375000057E2EDP02 000053030 9100000 00000120210205 DFUE
E2EDP02 3000000001017945375000058E2EDP02 000053030 911A 00000120210205 DFUE
E2EDP02 3000000001017945375000059E2EDP02 000053030 912PP 00000120210205 DFUE
E2EDP02 3000000001017945375000060E2EDP02 000053030 91300 00000120210205 DFUE
E2EDP02 3000000001017945375000061E2EDP02 000053030 914CONTACT ABCABCABC 00000120210205 DFUE
E2EDP02 3000000001017945375000062E2EDP02 000053030 963 00000120210205 DFUE
E2EDP02 3000000001017945375000063E2EDP02 000053030 965 00000120210205 DFUE
E2EDP02 3000000001017945375000064E2EDP02 000053030 9666336270425 00000120210205 DFUE
E2EDP02 3000000001017945375000065E2EDP02 000053030 9078026580537 00001020210205 DFUE
E2EDP03 3000000001017945375000066E2EDP03 000053030 02920210217
E2EDP03 3000000001017945375000067E2EDP03 000053030 00120210224
E2EDP03 3000000001017945375000068E2EDP03 000053030 01120210217
E2EDP03 3000000001017945375000069E2EDP03 000053030 02520210217
E2EDP03 3000000001017945375000070E2EDP03 000053030 02720210217
E2EDP03 3000000001017945375000071E2EDP03 000053030 02320210217
E2EDP03 3000000001017945375000072E2EDP03 000053030 02220210205
E2EDP19 3000000001017945375000073E2EDP19 000053030 001418VVZ
E2EDP19 3000000001017945375000074E2EDP19 000053030 002RJR-00001 AB ABCABCABC Mouse FORBUS BLUETOOTH
E2EDP19 3000000001017945375000075E2EDP19 000053030 0078471609000
E2EDP19 3000000001017945375000076E2EDP19 000053030 003889842532685
E2EDP19 3000000001017945375000077E2EDP19 000053030 011CN
E2EDP26 3000000001017945375000078E2EDP26 000053030 00459064.20
E2EDP26 3000000001017945375000079E2EDP26 000053030 00352269.20
E2EDP26 3000000001017945375000080E2EDP26 000053030 01052269.20
E2EDP26 3000000001017945375000081E2EDP26 000053030 01152269.20
E2EDP26 3000000001017945375000082E2EDP26 000053030 0126795.00
E2EDP26 3000000001017945375000083E2EDP26 000053030 01552269.20
E2EDP26 3000000001017945375000084E2EDP26 000053030 00117.54
E2EDP26 3000000001017945375000085E2EDP26 000053030 00252269.20
E2EDP26 3000000001017945375000086E2EDP26 000053030 940 2980.000
E2EDP26 3000000001017945375000087E2EDP26 000053030 939 2980.000
E2EDP05 3000000001017945375000088E2EDP05 000053030 + Z400MS List Price 52269.20 17.54 1 EA CAD 2980
E2EDP05 3000000001017945375000089E2EDP05 000053030 + XR1 Tax Jur Code Level 6795.00 13.000 52269.20
E2EDP05 3000000001017945375000090E2EDP05 000053030 + Tax Subtotal1 6795.00 2.28 1 EA CAD 2980
E2EDP05 3000000001017945375000091E2EDP05 000053030 + Taxable Amount + TaxSubtotal1 59064.20 19.82 1 EA CAD 2980
E2EDP04 3000000001017945375000092E2EDP04 000053030 CX 13.000 6795.00 7000000000
E2EDP04 3000000001017945375000093E2EDP04 000053030 CX 0 0 7001500000
E2EDP04 3000000001017945375000094E2EDP04 000053030 CX 0 0 7001505690
E2EDP28 3000000001017945375000095E2EDP28 000053030 00648489440000108471609000 CN CN ABCAB ZZ 298.000 298.000 LB US 400 United Stat KY
E2EDPT1 3000000001017945375000096E2EDPT1 000053030 0001E EN
E2EDPT2 3000000001017945375000097E2EDPT2 000096040 AB ABCABCABC Mouse forBus Bluetooth EN/XC/XD/XX Hdwr Black For Bsnss *
E2EDS01 3000000001017945375000098E2EDS01 000000020 0011
E2EDS01 3000000001017945375000099E2EDS01 000000020 01259064.20 CAD
E2EDS01 3000000001017945375000100E2EDS01 000000020 0056795.00 CAD
E2EDS01 3000000001017945375000101E2EDS01 000000020 01159064.20 CAD
E2EDS01 3000000001017945375000102E2EDS01 000000020 01052269.20 CAD
E2EDS01 3000000001017945375000103E2EDS01 000000020 94200000 CAD
E2EDS01 3000000001017945375000104E2EDS01 000000020 9440.00 CAD
E2EDS01 3000000001017945375000105E2EDS01 000000020 9450.00 CAD
E2EDS01 3000000001017945375000106E2EDS01 000000020 94659064.20 CAD
E2EDS01 3000000001017945375000107E2EDS01 000000020 94752269.20 CAD
E2EDS01 3000000001017945375000108E2EDS01 000000020 EXT
Z2XSK010003000000001017945375000109Z2XSK01000000108030 Z400 52269.20
Z2XSK010003000000001017945375000110Z2XSK01000000108030 XR1 13.000 6795.00 CX
</idocData></ReceiveIdoc>

Create HTTP response action

Now add a response action to your logic app's workflow and include the output from the SAP action. That way, your logic app returns the results from your SAP server to the original requestor.

  1. In the Logic Apps Designer, under the SAP action, select New step.

  2. In the search box, enter response as your filter. From the Actions list, select Response.

  3. Click inside the Body box so that the dynamic content list appears. From that list, under Send message to SAP, select the Body field.

    Complete SAP action

  4. Save your logic app.

Create RFC request-response

Note

The SAP trigger receives IDocs over tRFC, which doesn't have a response parameter by design.

You must create a request and response pattern if you need to receive replies by using a remote function call (RFC) to Logic Apps from SAP ABAP. To receive IDocs in your logic app, you should make its first action an HTTP request with a status code of 200 OK and no content. This recommended step completes the SAP LUW asynchronous transfer over tRFC immediately, which leaves the SAP CPIC conversation available again. You can then add further actions in your logic app to process the received IDoc without blocking further transfers.

To implement a request and response pattern, you must first discover the RFC schema using the generate schema command. The generated schema has two possible root nodes:

  1. The request node, which is the call that you receive from SAP.

  2. The response node, which is your reply back to SAP.

In the following example, a request and response pattern is generated from the STFC_CONNECTION RFC module. The request XML is parsed to extract a node value in which SAP requests <ECHOTEXT>. The response inserts the current timestamp as a dynamic value. You receive a similar response when you send a STFC_CONNECTION RFC from a logic app to SAP.


<STFC_CONNECTIONResponse xmlns="http://Microsoft.LobServices.Sap/2007/03/Rfc/">
  <ECHOTEXT>@{first(xpath(xml(triggerBody()?['Content']), '/*[local-name()="STFC_CONNECTION"]/*[local-name()="REQUTEXT"]/text()'))}</ECHOTEXT>
  <RESPTEXT>Azure Logic Apps @{utcNow()}</RESPTEXT>


Test logic app

  1. If your logic app isn't already enabled, on your logic app menu, select Overview. On the toolbar, select Enable.

  2. On the designer toolbar, select Run. This step manually starts your logic app.

  3. Trigger your logic app by sending an HTTP POST request to the URL in your HTTP Request trigger. Include your message content with your request. To the send the request, you can use a tool such as Postman.

    For this article, the request sends an IDoc file, which must be in XML format and include the namespace for the SAP action you're using, for example:

    <?xml version="1.0" encoding="UTF-8" ?>
    <Send xmlns="http://Microsoft.LobServices.Sap/2007/03/Idoc/2/ORDERS05//720/Send">
       <idocData>
          <...>
       </idocData>
    </Send>
    
  4. After you send your HTTP request, wait for the response from your logic app.

    Note

    Your logic app might time out if all the steps required for the response don't finish within the request timeout limit. If this condition happens, requests might get blocked. To help you diagnose problems, learn how you can check and monitor your logic apps.

You've now created a logic app that can communicate with your SAP server. Now that you've set up an SAP connection for your logic app, you can explore other available SAP actions, such as BAPI and RFC.

Receive message from SAP

This example uses a logic app that triggers when the app receives a message from an SAP system.

Add an SAP trigger

  1. In the Azure portal, create a blank logic app, which opens the Logic Apps Designer.

  2. In the search box, enter sap as your filter. From the Triggers list, select When a message is received from SAP.

    Add SAP trigger

    Or, you can select the Enterprise tab, and then select the trigger:

    Add SAP trigger from Enterprise tab

  3. If your connection already exists, continue with the next step so you can set up your SAP action. However, if you're prompted for connection details, provide the information so that you can create a connection to your on-premises SAP server now.

    1. Provide a name for the connection.

    2. If you're using the data gateway, follow these steps:

      1. In the Data Gateway section, under Subscription, first select the Azure subscription for the data gateway resource that you created in the Azure portal for your data gateway installation.

      2. Under Connection Gateway, select your data gateway resource in Azure.

    3. Continue providing information about the connection. For the Logon Type property, follow the step based on whether the property is set to Application Server or Group:

      • For Application Server, these properties, which usually appear optional, are required:

        Create SAP application server connection

      • For Group, these properties, which usually appear optional, are required:

        Create SAP message server connection

      By default, strong typing is used to check for invalid values by performing XML validation against the schema. This behavior can help you detect issues earlier. The Safe Typing option is available for backward compatibility and only checks the string length. Learn more about the Safe Typing option.

    4. When you're finished, select Create.

      Logic Apps sets up and tests your connection to make sure that the connection works properly.

  4. Provide the required parameters based on your SAP system configuration.

    You can filter the messages that you receive from your SAP server by specifying a list of SAP actions.

    You can select an SAP action from the file picker:

    Add SAP action to logic app

    Or, you can manually specify an action:

    Manually enter SAP action that you want to use

    Here's an example that shows how the action appears when you set up the trigger to receive more than one message.

    Trigger example that receives multiple messages

    For more information about the SAP action, see Message schemas for IDoc operations

  5. Now save your logic app so you can start receiving messages from your SAP system. On the designer toolbar, select Save.

Your logic app is now ready to receive messages from your SAP system.

Note

The SAP trigger isn't a polling trigger but is a webhook-based trigger instead. If you're using the data gateway, the trigger is called from the data gateway only when a message exists, so no polling is necessary.

If you receive a 500 Bad Gateway error with a message similar to service 'sapgw00' unknown, replace your gateway service name in your API connection and trigger configuration with its port number. In the following example error, sapgw00 needs to be replaced with a real port number, for example, 3300.

{
	"body": {
		"error": {
			"code": 500,
			"source": "EXAMPLE-FLOW-NAME.eastus.environments.microsoftazurelogicapps.net",
			"clientRequestId": "00000000-0000-0000-0000-000000000000",
			"message": "BadGateway",
			"innerError": {
				"error": {
					"code": "UnhandledException",
					"message": "\nERROR service 'sapgw00' unknown\nTIME Wed Nov 11 19:37:50 2020\nRELEASE 721\nCOMPONENT NI (network interface)\nVERSION 40\nRC -3\nMODULE ninti.c\nLINE 933\nDETAIL NiPGetServByName: 'sapgw00' not found\nSYSTEM CALL getaddrinfo\nCOUNTER 1\n\nRETURN CODE: 20"
				}
			}
		}
	}
}

Parameters

Along with simple string and number inputs, the SAP connector accepts the following table parameters (Type=ITAB inputs):

  • Table direction parameters, both input and output, for older SAP releases.

  • Changing parameters, which replace the table direction parameters for newer SAP releases.

  • Hierarchical table parameters

Filter with SAP actions

You can optionally filter the messages that your logic app receives from your SAP server by providing a list, or array, with a single or multiple SAP actions. By default, this array is empty, which means that your logic app receives all the messages from your SAP server without filtering.

When you set up the array filter, the trigger only receives messages from the specified SAP action types and rejects all other messages from your SAP server. However, this filter doesn't affect whether the typing of the received payload is weak or strong.

Any SAP action filtering happens at the level of the SAP adapter for your on-premises data gateway. For more information, see how to send test IDocs to Logic Apps from SAP.

If you can't send IDoc packets from SAP to your logic app's trigger, see the Transactional RFC (tRFC) call rejection message in the SAP tRFC dialog box (T-code SM58). In the SAP interface, you might get the following error messages, which are clipped due to the substring limits on the Status Text field.

The RequestContext on the IReplyChannel was closed without a reply being sent

This error message means unexpected failures happen when the catch-all handler for the channel terminates the channel due to an error, and rebuilds the channel to process other messages.

To acknowledge that your logic app received the IDoc, add a Response action that returns a 200 OK status code. Leave the body empty and don't change or add to the headers. The IDoc is transported through tRFC, which doesn't allow for a response payload.

To reject the IDoc instead, respond with any HTTP status code other than 200 OK. The SAP Adapter then returns an exception back to SAP on your behalf. You should only reject the IDoc to signal transport errors back to SAP, such as a misrouted IDoc that your application can't process. You shouldn't reject an IDoc for application-level errors, such as issues with the data contained in the IDoc. If you delay transport acceptance for application-level validation, you might experience negative performance due to blocking your connection from transporting other IDocs.

If you're receiving this error message and experience systemic failures calling Logic Apps, check that you've configured the network settings for your on-premises data gateway service for your specific environment. For example, if your network environment requires the use of a proxy to call Azure endpoints, you need to configure your on-premises data gateway service to use your proxy. For more information, see Proxy Configuration.

If you're receiving this error message and experience intermittent failures calling Logic Apps, you might need to increase your retry count and/or retry interval.

  1. Check SAP settings in your on-premises data gateway service configuration file, Microsoft.PowerBI.EnterpriseGateway.exe.config. The retry count setting looks like WebhookRetryMaximumCount="2". The retry interval setting looks like WebhookRetryDefaultDelay="00:00:00.10" and the timespan format is HH:mm:ss.ff.

  2. Save your changes and restart your on-premises data gateway.

The segment or group definition E2EDK36001 was not found in the IDoc meta

This error message means expected failures happen with other errors. For example, the failure to generate an IDoc XML payload because its segments are not released by SAP. As a result, the segment type metadata required for conversion is missing.

To have these segments released by SAP, contact the ABAP engineer for your SAP system.

Asynchronous request-reply for triggers

The SAP connector supports Azure's asynchronous request-reply pattern for Logic Apps triggers. You can use this pattern to create successful requests that would have otherwise failed with the default synchronous request-reply pattern.

Tip

In logic apps with multiple response actions, all response actions must use the same request-reply pattern. For example, if your logic app uses a switch control with multiple possible response actions, you must configure all the response actions to use the same request-reply pattern, either synchronous or asynchronous.

Enabling asynchronous response for your response action allows your logic app to respond with a 202 Accepted reply when a request has been accepted for processing. The reply contains a location header that you can use to retrieve the final state of your request.

To configure an asynchronous request-reply pattern for your logic app using the SAP connector:

  1. Open your logic app in the Logic Apps Designer.

  2. Confirm that the SAP connector is the trigger for your logic app.

  3. Open your logic app's Response action. In the action's title bar, select the menu (...) > Settings.

  4. In the Settings for your response action, turn on the toggle under Asynchronous Response. Select done.

  5. Save the changes to your logic app.

Find extended error logs

For full error messages, check your SAP adapter's extended logs. You can also enable an extended log file for the SAP connector.

For on-premises data gateway releases from June 2020 and later, you can enable gateway logs in the app settings.

  • The default logging level is Warning.

  • If you enable Additional logging in the Diagnostics settings of the on-premises data gateway app, the logging level is increased to Informational.

  • To increase the logging level to Verbose, update the following setting in your configuration file. Typically, the configuration file is located at C:\Program Files\On-premises data gateway\Microsoft.PowerBI.DataMovement.Pipeline.GatewayCore.dll.config.

<setting name="SapTraceLevel" serializeAs="String">
   <value>Verbose</value>
</setting>

For on-premises data gateway releases from April 2020 and earlier, logs are disabled by default.

Extended SAP logging in on-premises data gateway

If you use an on-premises data gateway for Logic Apps, you can configure an extended log file for the SAP connector. You can use your on-premises data gateway to redirect Event Tracing for Windows (ETW) events into rotating log files that are included in your gateway's logging .zip files.

You can export all of your gateway's configuration and service logs to a .zip file in from the gateway app's settings.

Note

Extended logging might affect your logic apps' performance when always enabled. It's a best practice to turn off extended log files after you're finished with analyzing and troubleshooting an issue.

Capture ETW events

Optionally, advanced users can capture ETW events directly. You can then consume your data in Azure Diagnostics in Event Hubs or collect your data to Azure Monitor Logs. For more information, see the best practices for collecting and storing data. You can use PerfView to work with the resulting ETL files, or you can write your own program. This walkthrough uses PerfView:

  1. In the PerfView menu, select Collect > Collect to capture the events.

  2. In the Additional Provider field, enter *Microsoft-LobAdapter to specify the SAP provider to capture SAP adapter events. If you don't specify this information, your trace only includes general ETW events.

  3. Keep the other default settings. If you want, you can change the file name or location in the Data File field.

  4. Select Start Collection to begin your trace.

  5. After you've reproduced your issue or collected enough analysis data, select Stop Collection.

To share your data with another party, such as Azure support engineers, compress the ETL file.

To view the content of your trace:

  1. In PerfView, select File > Open and select the ETL file you just generated.

  2. In the PerfView sidebar, the Events section under your ETL file.

  3. Under Filter, filter by Microsoft-LobAdapter to only see relevant events and gateway processes.

Test your logic app

  1. To trigger your logic app, send a message from your SAP system.

  2. On the logic app menu, select Overview. Review the Runs history for any new runs for your logic app.

  3. Open the most recent run, which shows the message sent from your SAP system in the trigger outputs section.

Test sending IDocs from SAP

To send IDocs from SAP to your logic app, you need the following minimum configuration:

Important

Use these steps only when you test your SAP configuration with your logic app. Production environments require additional configuration.

  1. Configure an RFC destination in SAP

  2. Create an ABAP connection to your RFC destination

  3. Create a receiver port

  4. Create a sender port

  5. Create a logical system partner

  6. Create a partner profile

  7. Test sending messages

Create RFC destination

  1. To open the Configuration of RFC Connections settings, in your SAP interface, use the sm59 transaction code (T-code) with the /n prefix.

  2. Select TCP/IP Connections > Create.

  3. Create a new RFC destination with the following settings:

    • For your RFC Destination, enter a name.

    • On the Technical Settings tab, for Activation Type, select Registered Server Program. For your Program ID, enter a value. In SAP, your logic app's trigger will be registered by using this identifier.

    Important

    The SAP Program ID is case-sensitive. Make sure you consistently use the same case format for your Program ID when you configure your logic app and SAP server. Otherwise, you might receive the following errors in the tRFC Monitor (T-Code SM58) when you attempt to send an IDoc to SAP:

    • Function IDOC_INBOUND_ASYNCHRONOUS not found
    • Non-ABAP RFC client (partner type) not supported

    For more information from SAP, see the following notes (login required) https://launchpad.support.sap.com/#/notes/2399329 and https://launchpad.support.sap.com/#/notes/353597.

    • On the Unicode tab, for Communication Type with Target System, select Unicode.
  4. Save your changes.

  5. Register your new Program ID with Azure Logic Apps.

  6. To test your connection, in the SAP interface, under your new RFC Destination, select Connection Test.

Create ABAP connection

  1. To open the Configuration of RFC Connections settings, in your SAP interface, use the sm59* transaction code (T-code) with the /n prefix.

  2. Select ABAP Connections > Create.

  3. For RFC Destination, enter the identifier for your test SAP system.

  4. Save your changes.

  5. To test your connection, select Connection Test.

Create receiver port

  1. To open the Ports In IDOC processing settings, in your SAP interface, use the we21 transaction code (T-code) with the /n prefix.

  2. Select Ports > Transactional RFC > Create.

  3. In the settings box that opens, select own port name. For your test port, enter a Name. Save your changes.

  4. In the settings for your new receiver port, for RFC destination, enter the identifier for your test RFC destination.

  5. Save your changes.

Create sender port

  1. To open the Ports In IDOC processing settings, in your SAP interface, use the we21 transaction code (T-code) with the /n prefix.

  2. Select Ports > Transactional RFC > Create.

  3. In the settings box that opens, select own port name. For your test port, enter a Name that starts with SAP. All sender port names must start with the letters SAP, for example, SAPTEST. Save your changes.

  4. In the settings for your new sender port, for RFC destination, enter the identifier for your ABAP connection.

  5. Save your changes.

Create logical system partner

  1. To open the Change View "Logical Systems": Overview settings, in your SAP interface, use the bd54 transaction code (T-code).

  2. Accept the warning message that appears: Caution: The table is cross-client

  3. Above the list that shows your existing logical systems, select New Entries.

  4. For your new logical system, enter a Log.System identifier and a short Name description. Save your changes.

  5. When the Prompt for Workbench appears, create a new request by providing a description, or if you already created a request, skip this step.

  6. After you create the workbench request, link that request to the table update request. To confirm that your table was updated, save your changes.

Create partner profiles

For production environments, you must create two partner profiles. The first profile is for the sender, which is your organization and SAP system. The second profile is for the receiver, which is your logic app.

  1. To open the Partner profiles settings, in your SAP interface, use the we20 transaction code (T-code) with the /n prefix.

  2. Under Partner Profiles, select Partner Type LS > Create.

  3. Create a new partner profile with the following settings:

    • For Partner No., enter your logical system partner's identifier.

    • For Partn. Type, enter LS.

    • For Agent, enter the identifier for the SAP user account to use when you register program identifiers for Azure Logic Apps or other non-SAP systems.

  4. Save your changes. If you haven't created the logical system partner, you get the error, Enter a valid partner number.

  5. In your partner profile's settings, under Outbound parmtrs., select Create outbound parameter.

  6. Create a new outbound parameter with the following settings:

  7. Save your changes.

Test sending messages

  1. To open the Test Tool for IDoc Processing settings, in your SAP interface, use the we19 transaction code (T-code) with the /n prefix.

  2. Under Template for test, select Via message type, and enter your message type, for example, CREMAS. Select Create.

  3. Confirm the Which IDoc type? message by selecting Continue.

  4. Select the EDIDC node. Enter the appropriate values for your receiver and sender ports. Select Continue.

  5. Select Standard Outbound Processing.

  6. To start outbound IDoc processing, select Continue. When processing finishes, the IDoc sent to SAP system or external program message appears.

  7. To check for processing errors, use the sm58 transaction code (T-code) with the /n prefix.

Receive IDoc packets from SAP

You can set up SAP to send IDocs in packets, which are batches or groups of IDocs. To receive IDoc packets, the SAP connector, and specifically the trigger, doesn't need extra configuration. However, to process each item in an IDoc packet after the trigger receives the packet, some additional steps are required to split the packet into individual IDocs.

Here's an example that shows how to extract individual IDocs from a packet by using the xpath() function:

  1. Before you start, you need a logic app with an SAP trigger. If you don't already have this in your logic app, follow the previous steps in this topic to set up a logic app with an SAP trigger.

    Important

    The SAP Program ID is case-sensitive. Make sure you consistently use the same case format for your Program ID when you configure your logic app and SAP server. Otherwise, you might receive the following errors in the tRFC Monitor (T-Code SM58) when you attempt to send an IDoc to SAP:

    • Function IDOC_INBOUND_ASYNCHRONOUS not found
    • Non-ABAP RFC client (partner type) not supported

    For more information from SAP, see the following notes (login required) https://launchpad.support.sap.com/#/notes/2399329 and https://launchpad.support.sap.com/#/notes/353597.

    For example:

    Add SAP trigger to logic app

  2. Add a response action to your logic app to reply immediately with the status of your SAP request. It's a best practice to add this action immediately after your trigger, to free up the communication channel with your SAP server. Choose one of the following status codes (statusCode) to use in your response action:

    • 202 Accepted, which means the request has been accepted for processing but the processing isn't complete yet.

    • 204 No Content, which means the server has successfully fulfilled the request and there is no additional content to send in the response payload body.

    • 200 OK. This status code always contains a payload, even if the server generates a payload body of zero length.

  3. Get the root namespace from the XML IDoc that your logic app receives from SAP. To extract this namespace from the XML document, add a step that creates a local string variable and stores that namespace by using an xpath() expression:

    xpath(xml(triggerBody()?['Content']), 'namespace-uri(/*)')

    Get root namespace from IDoc

  4. To extract an individual IDoc, add a step that creates an array variable and stores the IDoc collection by using another xpath() expression:

    xpath(xml(triggerBody()?['Content']), '/*[local-name()="Receive"]/*[local-name()="idocData"]')

    Get array of items

    The array variable makes each IDoc available for your logic app to process individually by enumerating over the collection. In this example, the logic app transfers each IDoc to an SFTP server by using a loop:

    Send IDoc to SFTP server

    Each IDoc must include the root namespace, which is the reason why the file content is wrapped inside a <Receive></Receive element along with the root namespace before sending the IDoc to the downstream app, or SFTP server in this case.

You can use the quickstart template for this pattern by selecting this template in the Logic Apps Designer when you create a new logic app.

Select batch logic app template

Generate schemas for artifacts in SAP

This example uses a logic app that you can trigger with an HTTP request. To generate the schemas for the specified IDoc and BAPI, the SAP action Generate schema sends a request to an SAP system.

This SAP action returns an XML schema, not the contents or data of the XML document itself. Schemas returned in the response are uploaded to an integration account by using the Azure Resource Manager connector. Schemas contain the following parts:

  • The request message's structure. Use this information to form your BAPI get list.

  • The response message's structure. Use this information to parse the response.

To send the request message, use the generic SAP action Send message to SAP, or the targeted Call BAPI actions.

Sample XML schemas

If you're learning how to generate an XML schema for use in creating a sample document, see the following samples. These examples show how you can work with many types of payloads, including:

You can begin your XML schema with an optional XML prolog. The SAP connector works with or without the XML prolog.


<?xml version="1.0" encoding="utf-8">

XML samples for RFC requests

The following example is a basic RFC call. The RFC name is STFC_CONNECTION. This request uses the default namespace xmlns=, however, you can assign and use namespace aliases such as xmmlns:exampleAlias=. The namespace value is the namespace for all RFCs in SAP for Microsoft services. There is a simple input parameter in the request, <REQUTEXT>.


<STFC_CONNECTION xmlns="http://Microsoft.LobServices.Sap/2007/03/Rfc/">
  <REQUTEXT>exampleInput</REQUTEXT>
</STFC_CONNECTION>

The following example is an RFC call with a table parameter. This example call and its group of test RFCs are available as part of all SAP systems. The table parameter's name is TCPICDAT. The table line type is ABAPTEXT, and this element repeats for each row in the table. This example contains a single line, called LINE. Requests with a table parameter can contain any number of fields, where the number is a positive integer (n).


<STFC_WRITE_TO_TCPIC xmlns="http://Microsoft.LobServices.Sap/2007/03/Rfc/">
  <RESTART_QNAME>exampleQName</RESTART_QNAME>
    <TCPICDAT>
      <ABAPTEXT xmlns="http://Microsoft.LobServices.Sap/2007/03/Rfc/">
        <LINE>exampleFieldInput1</LINE>
      <ABAPTEXT xmlns="http://Microsoft.LobServices.Sap/2007/03/Rfc/">
        <LINE>exampleFieldInput2</LINE>
      <ABAPTEXT xmlns="http://Microsoft.LobServices.Sap/2007/03/Rfc/">
        <LINE>exampleFieldInput3</LINE>
      </ABAPTEXT>
    </TCPICDAT>
</STFC_WRITE_TO_TCPIC>

The following example is an RFC call with a table parameter that has an anonymous field. An anonymous field is when the field has no name assigned. Complex types are declared under a separate namespace, in which the declaration sets a new default for the current node and all its child elements. The example uses the hex codex002F as an escape character for the symbol /, because this symbol is reserved in the SAP field name.


<RFC_XML_TEST_1 xmlns="http://Microsoft.LobServices.Sap/2007/03/Rfc/">
  <IM_XML_TABLE>
    <RFC_XMLCNT xmlns="http://Microsoft.LobServices.Sap/2007/03/Rfc/">
      <_x002F_AnonymousField>exampleFieldInput</_x002F_AnonymousField>
    </RFC_XMLCNT>
  </IM_XML_TABLE>
</RFC_XML_TEST_1>

The following example includes prefixes for the namespaces. You can declare all prefixes at once, or you can declare any number of prefixes as attributes of a node. The RFC namespace alias ns0 is used as the root and parameters for the basic type.

Note

complex types are declared under a different namespace for RFC types with the alias ns3 instead of the regular RFC namespace with the alias ns0.


<ns0:BBP_RFC_READ_TABLE xmlns:ns0="http://Microsoft.LobServices.Sap/2007/03/Rfc/" xmlns:ns3="http://Microsoft.LobServices.Sap/2007/03/Types/Rfc/">
  <ns0:DELIMITER>0</ns0:DELIMITER>
  <ns0:QUERY_TABLE>KNA1</ns0:QUERY_TABLE>
  <ns0:ROWCOUNT>250</ns0:ROWCOUNT>
  <ns0:ROWSKIPS>0</ns0:ROWSKIPS>
  <ns0:FIELDS>
    <ns3:RFC_DB_FLD>
      <ns3:FIELDNAME>KUNNR</ns3:FIELDNAME>
    </ns3:RFC_DB_FLD>
  </ns0:FIELDS>
</ns0:BBP_RFC_READ_TABLE>

XML samples for BAPI requests

The following XML samples are example requests to call the BAPI method.

Note

SAP makes business objects available to external systems by describing them in response to RFC RPY_BOR_TREE_INIT, which Logic Apps issues with no input filter. Logic Apps inspects the output table BOR_TREE. The SHORT_TEXT field is used for names of business objects. Business objects not returned by SAP in the output table aren't accessible to Logic Apps.

If you use custom business objects, you must make sure to publish and release these business objects in SAP. Otherwise, SAP doesn't list your custom business objects in the output table BOR_TREE. You can't access your custom business objects in Logic Apps until you expose the business objects from SAP.

The following example gets a list of banks using the BAPI method GETLIST. This sample contains the business object for a bank, BUS1011.


<GETLIST xmlns="http://Microsoft.LobServices.Sap/2007/03/Bapi/BUS1011">
  <BANK_CTRY>US</BANK_CTRY>
  <MAX_ROWS>10</MAX_ROWS>
</GETLIST>

The following example creates a bank object using the CREATE method. This example uses the same business object as the previous example, BUS1011. When you use the CREATE method to create a bank, be sure to commit your changes because this method isn't committed by default.

Tip

Be sure that your XML document follows any validation rules configured in your SAP system. For example, in this sample document, the bank key (<BANK_KEY>) needs to be a bank routing number, also known as an ABA number, in the USA.


<CREATE xmlns="http://Microsoft.LobServices.Sap/2007/03/Bapi/BUS1011">
  <BANK_ADDRESS>
    <BANK_NAME xmlns="http://Microsoft.LobServices.Sap/2007/03/Types/Rfc">ExampleBankName</BANK_NAME>
    <REGION xmlns="http://Microsoft.LobServices.Sap/2007/03/Types/Rfc">ExampleRegionName</REGION>
    <STREET xmlns="http://Microsoft.LobServices.Sap/2007/03/Types/Rfc">ExampleStreetAddress</STREET>
    <CITY xmlns="http://Microsoft.LobServices.Sap/2007/03/Types/Rfc">Redmond</CITY>
  </BANK_ADDRESS>
  <BANK_COUNTRY>US</BANK_COUNTRY>
  <BANK_KEY>123456789</BANK_KEY>
</CREATE>

The following example gets details for a bank using the bank routing number, the value for<BANK_KEY>.


<GETDETAIL xmlns="http://Microsoft.LobServices.Sap/2007/03/Bapi/BUS1011">
  <BANK_COUNTRY>US</BANK_COUNTRY>
  <BANK_KEY>123456789</BANK_KEY>
</GETDETAIL>

XML samples for IDoc requests

To generate a plain SAP IDoc XML schema, use the SAP Logon application and the T-code WE-60. Access the SAP documentation through the GUI and generate XML schemas in XSD format for your IDoc types and extensions. For an explanation of generic SAP formats and payloads, and their built-in dialogs, see the SAP documentation.

This example declares the root node and namespaces. The URI in the sample code, http://Microsoft.LobServices.Sap/2007/03/Idoc/3/ORDERS05//700/Send, declares the following configuration:

  • /IDoc is the root note for all IDocs
  • /3 is the record types version for common segment definitions
  • /ORDERS05 is the IDoc type
  • // is an empty segment, because there's no IDoc extension
  • /700 is the SAP version
  • /Send is the action to send the information to SAP

<ns0:Send xmlns:ns0="http://Microsoft.LobServices.Sap/2007/03/Idoc/3/ORDERS05//700/Send" xmlns:ns3="http://schemas.microsoft.com/2003/10/Serialization" xmlns:ns1="http://Microsoft.LobServices.Sap/2007/03/Types/Idoc/Common/" xmlns:ns2="http://Microsoft.LobServices.Sap/2007/03/Idoc/3/ORDERS05//700">
  <ns0:idocData>

You can repeat the idocData node to send a batch of IDocs in a single call. In the example below, there is one control record, EDI_DC40, and multiple data records.


<...>
  <ns0:idocData>
    <ns2:EDI_DC40>
      <ns1:TABNAM>EDI_DC40</ns1:TABNAM>
<...>
      <ns1:ARCKEY>Cor1908207-5</ns1:ARCKEY>
    </ns2:EDI_DC40>
    <ns2:E2EDK01005>
      <ns2:DATAHEADERCOLUMN_SEGNAM>E23DK01005</ns2:DATAHEADERCOLUMN_SEGNAM>
      <ns2:CURCY>USD</ns2:CURCY>
    </ns2:E2EDK01005>
    <ns2:E2EDK03>
<...>
  </ns0:idocData>

The following example is a sample IDoc control record, which uses the prefix EDI_DC. You must update the values to match your SAP installation and IDoc type. For example, your IDoc client code may not be 800. Contact your SAP team to make sure you're using the correct values for your SAP installation.


<ns2:EDI_DC40>
  <ns:TABNAM>EDI_DC40</ns1:TABNAM>
  <ns:MANDT>800</ns1:MANDT>
  <ns:DIRECT>2</ns1:DIRECT>
  <ns:IDOCTYP>ORDERS05</ns1:IDOCTYP>
  <ns:CIMTYP></ns1:CIMTYP>
  <ns:MESTYP>ORDERS</ns1:MESTYP>
  <ns:STD>X</ns1:STD>
  <ns:STDVRS>004010</ns1:STDVRS>
  <ns:STDMES></ns1:STDMES>
  <ns:SNDPOR>SAPENI</ns1:SNDPOR>
  <ns:SNDPRT>LS</ns1:SNDPRT>
  <ns:SNDPFC>AG</ns1:SNDPFC>
  <ns:SNDPRN>ABAP1PXP1</ns1:SNDPRN>
  <ns:SNDLAD></ns1:SNDLAD>
  <ns:RCVPOR>BTSFILE</ns1:RCVPOR>
  <ns:RCVPRT>LI</ns1:RCVPRT>

The following example is a sample data record with plain segments. This example uses the SAP date format. Strong-typed documents can use native XML date formats, such as 2020-12-31 23:59:59.


<ns2:E2EDK01005>
  <ns2:DATAHEADERCOLUMN_SEGNAM>E2EDK01005</ns2:DATAHEADERCOLUMN_SEGNAM>
    <ns2:CURCY>USD</ns2:CURCY>
    <ns2:BSART>OR</ns2:BSART>
    <ns2:BELNR>1908207-5</ns2:BELNR>
    <ns2:ABLAD>CC</ns2:ABLAD>
  </ns2>
  <ns2:E2EDK03>
    <ns2:DATAHEADERCOLUMN_SEGNAM>E2EDK03</ns2:DATAHEADERCOLUMN_SEGNAM>
      <ns2:IDDAT>002</ns2:IDDAT>
      <ns2:DATUM>20160611</ns2:DATUM>
  </ns2:E2EDK03>

The following example is a data record with grouped segments. The record includes a group parent node, E2EDKT1002GRP, and multiple child nodes, including E2EDKT1002 and E2EDKT2001.


<ns2:E2EDKT1002GRP>
  <ns2:E2EDKT1002>
    <ns2:DATAHEADERCOLUMN_SEGNAM>E2EDKT1002</ns2:DATAHEADERCOLUMN_SEGNAM>
      <ns2:TDID>ZONE</ns2:TDID>
  </ns2:E2EDKT1002>
  <ns2:E2EDKT2001>
    <ns2:DATAHEADERCOLUMN_SEGNAM>E2EDKT2001</ns2:DATAHEADERCOLUMN_SEGNAM>
      <ns2:TDLINE>CRSD</ns2:TDLINE>
  </ns2:E2EDKT2001>
</ns2:E2EDKT1002GRP>

The recommended method is to create an IDoc identifier for use with tRFC. You can set this transaction identifier, tid, using the Send IDoc operation in the SAP connector API.

The following example is an alternative method to set the transaction identifier, or tid. In this example, the last data record segment node and the IDoc data node are closed. Then, the GUID, guid, is used as the tRFC identifier to detect duplicates.


    </E2STZUM002GRP>
  </idocData>
  <guid>8820ea40-5825-4b2f-ac3c-b83adc34321c</guid>
</Send>

Add an HTTP Request trigger

  1. In the Azure portal, create a blank logic app, which opens the Logic Apps Designer.

  2. In the search box, enter http request as your filter. From the Triggers list, select When a HTTP request is received.

    Add HTTP Request trigger

  3. Now save your logic app so you can generate an endpoint URL for your logic app. On the designer toolbar, select Save.

    The endpoint URL now appears in your trigger, for example:

    Generate URL for endpoint

Add an SAP action to generate schemas

  1. In the Logic Apps Designer, under the trigger, select New step.

    Add new step to logic app

  2. In the search box, enter sap as your filter. From the Actions list, select Generate schemas.

    Add "Generate schemas" action to logic app

    Or, you can select the Enterprise tab, and select the SAP action.

    Select SAP send action from Enterprise tab

  3. If your connection already exists, continue with the next step so you can set up your SAP action. However, if you're prompted for connection details, provide the information so that you can create a connection to your on-premises SAP server now.

    1. Provide a name for the connection.

    2. In the Data Gateway section, under Subscription, first select the Azure subscription for the data gateway resource that you created in the Azure portal for your data gateway installation.

    3. Under Connection Gateway, select your data gateway resource in Azure.

    4. Continue providing information about the connection. For the Logon Type property, follow the step based on whether the property is set to Application Server or Group:

      • For Application Server, these properties, which usually appear optional, are required:

        Create SAP application server connection

      • For Group, these properties, which usually appear optional, are required:

        Create SAP message server connection

      By default, strong typing is used to check for invalid values by performing XML validation against the schema. This behavior can help you detect issues earlier. The Safe Typing option is available for backward compatibility and only checks the string length. Learn more about the Safe Typing option.

    5. When you're finished, select Create.

      Logic Apps sets up and tests your connection to make sure that the connection works properly.

  4. Provide the path to the artifact for which you want to generate the schema.

    You can select the SAP action from the file picker:

    Select SAP action

    Or, you can manually enter the action:

    Manually enter SAP action

    To generate schemas for more than one artifact, provide the SAP action details for each artifact, for example:

    Select Add new item

    Show two items

    For more information about the SAP action, see Message schemas for IDoc operations.

  5. Save your logic app. On the designer toolbar, select Save.

Test your logic app

  1. On the designer toolbar, select Run to trigger a run for your logic app.

  2. Open the run, and check the outputs for the Generate schemas action.

    The outputs show the generated schemas for the specified list of messages.

Upload schemas to an integration account

Optionally, you can download or store the generated schemas in repositories, such as a blob, storage, or integration account. Integration accounts provide a first-class experience with other XML actions, so this example shows how to upload schemas to an integration account for the same logic app by using the Azure Resource Manager connector.

  1. In the Logic Apps Designer, under the trigger, select New step.

  2. In the search box, enter Resource Manager as your filter. Select Create or update a resource.

    Select Azure Resource Manager action

  3. Enter the details for the action, including your Azure subscription, Azure resource group, and integration account. To add SAP tokens to the fields, click inside the boxes for those fields, and select from the dynamic content list that appears.

    1. Open the Add new parameter list, and select the Location and Properties fields.

    2. Provide details for these new fields as shown in this example.

      Enter details for Azure Resource Manager action

    The SAP Generate schemas action generates schemas as a collection, so the designer automatically adds a For each loop to the action. Here's an example that shows how this action appears:

    Azure Resource Manager action with "for each" loop

    Note

    The schemas use base64-encoded format. To upload the schemas to an integration account, they must be decoded by using the base64ToString() function. Here's an example that shows the code for the "properties" element:

    "properties": {
       "Content": "@base64ToString(items('For_each')?['Content'])",
       "ContentType": "application/xml",
       "SchemaType": "Xml"
    }
    
  4. Save your logic app. On the designer toolbar, select Save.

Test your logic app

  1. On the designer toolbar, select Run to manually trigger your logic app.

  2. After a successful run, go to the integration account, and check that the generated schemas exist.

Enable Secure Network Communications

Before you start, make sure that you met the previously listed prerequisites, which apply only when you use the data gateway and your logic apps run in multi-tenant Azure:

  • Make sure the on-premises data gateway is installed on a computer that's in the same network as your SAP system.

  • For SSO, the data gateway is running as a user that's mapped to an SAP user.

  • The SNC library that provides the additional security functions is installed on the same machine as the data gateway. Some examples include sapseculib, Kerberos, and NTLM.

    To enable SNC for your requests to or from the SAP system, select the Use SNC check box in the SAP connection and provide these properties:

    Configure SAP SNC in connection

    Property Description
    SNC Library Path The SNC library name or path relative to NCo installation location or absolute path. Examples are sapsnc.dll or .\security\sapsnc.dll or c:\security\sapsnc.dll.
    SNC SSO When you connect through SNC, the SNC identity is typically used for authenticating the caller. Another option is to override so that user and password information can be used for authenticating the caller, but the line is still encrypted.
    SNC My Name In most cases, this property can be omitted. The installed SNC solution usually knows its own SNC name. Only for solutions that support multiple identities, you might need to specify the identity to be used for this particular destination or server.
    SNC Partner Name The name for the back-end SNC.
    SNC Quality of Protection The quality of service to be used for SNC communication of this particular destination or server. The default value is defined by the back-end system. The maximum value is defined by the security product used for SNC.

    Note

    Don't set the environment variables SNC_LIB and SNC_LIB_64 on the machine where you have the data gateway and the SNC library. If set, they take precedence over the SNC library value passed through the connector.

Safe typing

By default, when you create your SAP connection, strong typing is used to check for invalid values by performing XML validation against the schema. This behavior can help you detect issues earlier. The Safe Typing option is available for backward compatibility and only checks the string length. If you choose Safe Typing, the DATS type and TIMS type in SAP are treated as strings rather than as their XML equivalents, xs:date and xs:time, where xmlns:xs="http://www.w3.org/2001/XMLSchema". Safe typing affects the behavior for all schema generation, the send message for both the "been sent" payload and the "been received" response, and the trigger.

When strong typing is used (Safe Typing isn't enabled), the schema maps the DATS and TIMS types to more straightforward XML types:

<xs:element minOccurs="0" maxOccurs="1" name="UPDDAT" nillable="true" type="xs:date"/>
<xs:element minOccurs="0" maxOccurs="1" name="UPDTIM" nillable="true" type="xs:time"/>

When you send messages using strong typing, the DATS and TIMS response complies to the matching XML type format:

<DATE>9999-12-31</DATE>
<TIME>23:59:59</TIME>

When Safe Typing is enabled, the schema maps the DATS and TIMS types to XML string fields with length restrictions only, for example:

<xs:element minOccurs="0" maxOccurs="1" name="UPDDAT" nillable="true">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:maxLength value="8" />
    </xs:restriction>
  </xs:simpleType>
</xs:element>
<xs:element minOccurs="0" maxOccurs="1" name="UPDTIM" nillable="true">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:maxLength value="6" />
    </xs:restriction>
  </xs:simpleType>
</xs:element>

When messages are sent with Safe Typing enabled, the DATS and TIMS response looks like this example:

<DATE>99991231</DATE>
<TIME>235959</TIME>

Advanced scenarios

Change language headers

When you connect to SAP from Logic Apps, the default language for the connection is English. You can set the language for your connection by using the standard HTTP header Accept-Language with your inbound requests.

Tip

Most web browsers add an Accept-Language header based on the user's settings. The web browser applies this header when you create a new SAP connection in the Logic Apps designer. If you don't want to create SAP connections in your web browser's preferred language, either update your web browser's settings to use your preferred language, or create your SAP connection using Azure Resource Manager instead of the Logic Apps designer.

For example, you can send a request with the Accept-Language header to your logic app by using the HTTP Request trigger. All the actions in your logic app receive the header. Then, SAP uses the specified languages in its system messages, such as BAPI error messages.

The SAP connection parameters for a logic app don't have a language property. So, if you use the Accept-Language header, you might get the following error: Please check your account info and/or permissions and try again. In this case, check the SAP component's error logs instead. The error actually happens in the SAP component that uses the header, so you might get one of these error messages:

  • "SAP.Middleware.Connector.RfcLogonException: Select one of the installed languages"
  • "SAP.Middleware.Connector.RfcAbapMessageException: Select one of the installed languages"

Confirm transaction explicitly

When you send transactions to SAP from Logic Apps, this exchange happens in two steps as described in the SAP document, Transactional RFC Server Programs. By default, the Send to SAP action handles both the steps for the function transfer and for the transaction confirmation in a single call. The SAP connector gives you the option to decouple these steps. You can send an IDoc and rather than automatically confirm the transaction, you can use the explicit Confirm transaction ID action.

This capability to decouple the transaction ID confirmation is useful when you don't want to duplicate transactions in SAP, for example, in scenarios where failures might happen due to causes such as network issues. By confirming the transaction ID separately, the transaction is only completed one time in your SAP system.

Here is an example that shows this pattern:

  1. Create a blank logic app and add an HTTP trigger.

  2. From the SAP connector, add the Send IDOC action. Provide the details for the IDoc that you send to your SAP system.

  3. To explicitly confirm the transaction ID in a separate step, in the Confirm TID field, select No. For the optional Transaction ID GUID field, you can either manually specify the value or have the connector automatically generate and return this GUID in the response from the Send IDOC action.

    Send IDOC action properties

  4. To explicitly confirm the transaction ID, add the Confirm transaction ID action, making sure to avoid sending duplicate IDocs to SAP. Click inside the Transaction ID box so that the dynamic content list appears. From that list, select the Transaction ID value that's returned from the Send IDOC action.

    Confirm transaction ID action

    After this step runs, the current transaction is marked complete at both ends, on the SAP connector side and on SAP system side.

Avoid sending duplicate IDocs

If you experience an issue with duplicate IDocs being sent to SAP from your logic app, follow these steps to create a string variable to serve as your IDoc transaction identifier. Creating this transaction identifier helps prevent duplicate network transmissions when there are issues such as temporary outages, network issues, or lost acknowledgments.

Note

SAP systems forget a transaction identifier after a specified time, or 24 hours by default. As a result, SAP never fails to confirm a transaction identifier if the ID or GUID is unknown. If confirmation for a transaction identifier fails, this failure indicates that communcation with the SAP system failed before SAP was able to acknowledge the confirmation.

  1. In the Logic Apps designer, add the action Initialize variable to your logic app.

  2. In the editor for the action Initialize variable, configure the following settings. Then, save your changes.

    1. For Name, enter a name for your variable. For example, IDOCtransferID.

    2. For Type, select String as the variable type.

    3. For Value, select the text box Enter initial value to open the dynamic content menu. Select the Expressions tab. In the list of functions, enter the function guid(). Then, select OK to save your changes. The Value field is now set to the guid() function, which generates a GUID.

  3. After the Initialize variable action, add the action Send IDOC.

  4. In the editor for the action Send IDOC, configure the following settings. Then, save your changes.

    1. For IDOC type select your message type, and for Input IDOC message, specify your message.

    2. For SAP release version, select your SAP configuration's values.

    3. For Record types version, select your SAP configuration's values.

    4. For Confirm TID, select No.

    5. Select Add new parameter list > Transaction ID GUID. Select the text box to open the dynamic content menu. Under the Variables tab, select the name of the variable that you created. For example, IDOCtransferID.

  5. On the title bar of the action Send IDOC, select ... > Settings. For Retry Policy, it's recommended to select Default > Done. However, you can instead configure a custom policy for your specific needs. For custom policies, it's recommended to configure at least one retry to overcome temporary network outages.

  6. After the action Send IDOC, add the action Confirm transaction ID.

  7. In the editor for the action Confirm transaction ID, configure the following settings. Then, save your changes.

    1. For Transaction ID, enter the name of your variable again. For example, IDOCtransferID.
  8. Optionally, validate the deduplication in your test environment. Repeat the Send IDOC action with the same Transaction ID GUID that you used in the previous step. When you send the same IDoc twice, you can validate that SAP is able to identify the duplication of the tRFC call and resolve the two calls to a single inbound IDoc message.

Known issues and limitations

Here are the currently known issues and limitations for the managed (non-ISE) SAP connector:

  • In general, the SAP trigger doesn't support data gateway clusters. In some failover cases, the data gateway node that communicates with the SAP system might differ from the active node, which results in unexpected behavior.

    • For send scenarios, data gateway clusters in failover mode are supported.

    • Data gateway clusters in load balancing mode aren't supported by stateful SAP actions. These actions include Create stateful session, Commit BAPI transaction, Rollback BAPI transaction, Close stateful session, and all actions that specify a Session ID value. Stateful communications must remain on the same data gateway cluster node.

    • For stateful SAP actions, use the data gateway either in non-cluster mode or in a cluster that's set up for failover only.

  • The SAP connector currently doesn't support SAP router strings. The on-premises data gateway must exist on the same LAN as the SAP system you want to connect.

Connector reference

For more technical details about this connector, such as triggers, actions, and limits as described by the connector's Swagger file, see the connector's reference page. Additional documentation for Logic Apps is provided for the following actions:

Note

For logic apps in an integration service environment (ISE), this connector's ISE-labeled version uses the ISE message limits instead.

Call BAPI action

The Call BAPI (CallBapi) action calls the BAPI method on your SAP server.

You must use the following parameters with your call:

  • Business Object (businessObject), which is a searchable drop-down menu.

  • Method (method), which populates the available methods after you've selected a Business Object. The available methods vary depending on the selected Business Object.

  • Input BAPI parameters (body), in which you call the XML document that contains the BAPI method input parameter values for the call, or the URI of the storage blob that contains your BAPI parameters.

For detailed examples of how to use the Call BAPI action, see the XML samples of BAPI requests.

Tip

If you're using the Logic Apps designer to edit your BAPI request, you can use the following search functions:

  • Select an object in the designer to see a drop-down menu of available methods.
  • Filter business object types by keyword using the searchable list provided by the BAPI API call.

Send IDoc action

The Send IDoc (SendIDoc) action sends the IDoc message to your SAP server.

You must use the following parameters with your call:

  • IDOC type with optional extension (idocType), which is a searchable drop-down menu.

    • The optional parameter SAP release version (releaseVersion) populates values after you select the IDoc type, and depends on the selected IDoc type.
  • Input IDOC message (body), in which you call the XML document containing the IDoc payload, or the URI of the storage blob that contains your IDoc XML document. This document must comply with either the SAP IDOC XML schema according to the WE60 IDoc Documentation, or the generated schema for the matching SAP IDoc action URI.

For detailed examples of how to use the Send IDoc action, see the walkthrough for sending IDoc messages to your SAP server.

For how to use optional parameter Confirm TID (confirmTid), see the walkthrough for confirming the transaction explicitly.

Next steps