# mulesoft SAP Connector - Full Documentation

<!-- document id=83a54bb304877412959d7be859876aa94231e51e69fefe442fc9598e8de6c868 url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-config-snc.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# Configuring an SAP Secure Network Communication Connection with Certificate

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Configure an SAP Secure Network Communication (SNC) with certificate to take advantage of security
features such as secure data communication between the SAP system client and server,
application-level end-to-end security, and the ability to change security products without impacting
your SAP business applications. Enabling SNC with certificate requires you to configure the client
environment, the SAP server, and Anypoint Connector for SAP (SAP Connector).

## Before You Begin

To configure an SAP SNC with certificate, you must have access to:

- The SAP GUI application. To install this client, Java must already be installed on your machine.
  Then, download the installer for your OS from SAP.

- The SAPCAR utility and SAP Cryptographic Library, which you can download from the SAP Support
  Portal, if you are an S-user

- An SAP ECC instance that can use SNC system variables

- The following transactions:

  - `STRUST` (Trust Manager)

  - `SM30` (Table Maintenance)

## Configure the Client Environment

Configure the system variables that depend on the operating system you are using, and generate the
personal security environment (PSE):

1.  Open the Windows command line or Mac Terminal app.

2.  Use the `SAPCAR` utility to unpack the SAP Cryptographic Library to the specified folder:

    `SAPCAR -xvf <folder-name.SAR>`

3.  Configure the following environment variables:

    - SNC\_LIB: `<path_to_library>\sapcrypto.dll`

    - SECUDIR: `<path_to_library>`

    - LD\_LIBRARY\_PATH: `<path_to_library>\sapcrypto.dll`

    - SSF\_LIBRARY\_PATH: `<path_to_library>\sapcrypto.dll`

      For Windows, the `sapcrypto.dll` 64-bit version must be in a different path and added to a new
      variable called `SNC_LIB_64`:

      ![Windows variable SNC\_LIB\_64](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-windows-variable.png)

4.  Use the `sapgenpse` tool to create the PSE:

    `sapgenpse gen_pse -v -p RFC.pse`

    When you run this command, you must enter a PIN to use later and a distinguished name, which
    must be unique. For example, you can enter a distinguished name like this:

    `CN=RFC, C=AR, O=YourCompany, OU=IT`

    You can use STRUST to see names that are already in use.

5.  Use the `sapgenpse` tool to create the `cred_v2` file, which stores the credentials for
    accessing the PSE:

    `sapgenpse seclogin -p RFC -O <user-credentials>`

6.  Use the `sapgenpse` tool to export the client’s certificate from the PSE:

    `sapgenpse <export_own_cert> -v -p RFC -o RFC_MULE.crt`

## Configure the Client Environment When Deploying in CloudHub 2.0 or Runtime Fabric

In SAP Connector 5.9.5 and later, an application that uses the Certificate connection type can be
deployed in CloudHub 2.0 or Runtime Fabric. SAP Connector has an embedded installer that sets up the
Personal Security Environment (PSE).

You must first create your application:

1.  Open Anypoint Studio.

2.  Navigate to the `src/main/resources` folder of your application.

3.  In the `src/main/resources` folder, create a folder named `sec`.

    ![SAP resources sec folder structure](/mulesoft/current/en-us/sap-connector/latest/_images/sap-resources-sec.png)

4.  Add the following files to the `sec` folder:

    - `libsapcrypto.so`

      Linux version of the SAP CommonCryptoLib

    - `sapgenpse`

      Linux version of the SAP command line tool that manages PSE files

    - `RFC.pse`

      File that you created in the [previous step](#configure-the-client-environment)

5.  Because CloudHub 2.0 runs on Linux machines, ensure that any dependency of the application is
    compiled for Linux, including `com.sap.conn.jco:libsapjco3`.

6.  Save the application and export the `jar` file used for CloudHub 2.0 deployment.

You must then import the created application in CloudHub 2.0 or Runtime Fabric:

1.  Log in to your Anypoint Platform account and navigate to Runtime Manager.

2.  Click **Deploy Application**.

3.  In **Application Name**, enter a name for the application, for example, `cert-ch2`.

4.  In **Deployment Target**, select `CloudHub 2.0` or `Runtime Fabric` if it is not selected
    already.

5.  Click **Choose File** and upload your `jar` file.

6.  In the **Properties** tab, add the following:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Property</th><th>Example Value</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>secFilesCopy</p></div></div></td><td><p><code>true</code></p></td><td><p>If <code>true</code>, triggers the embedded installer.</p></td></tr><tr><td><div><div><p>sourceSecFolder</p></div></div></td><td><p><code>/opt/mule/apps/my-app-name/sec/</code></p></td><td><p>Location of the <code>resources/sec</code> folder in CloudHub 2.0 or Runtime Fabric. Replace the name of the application to match your scenario.</p></td></tr><tr><td><div><div><p>targetSecFolder</p></div></div></td><td><p><code>/tmp/sec/</code></p></td><td><p>Leave this value hardcoded.</p></td></tr><tr><td><div><div><p>pseFile</p></div></div></td><td><p><code>RFC</code></p></td><td><p>Name of the PSE file, without an extension.</p></td></tr><tr><td><div><div><p>psePassword</p></div></div></td><td><p><code>Your PSE file password</code></p></td><td><p>PSE file password. Click the <strong>Protect</strong> button next to this property to hide its content.</p></td></tr><tr><td><div><div><p>osUsername</p></div></div></td><td><p><code>app</code></p></td><td><p>Default CloudHub 2.0 username that is used to create the <code>cred_v2</code> file. You can omit this property, in which case the connector automatically figures it out.</p></td></tr></tbody></table>

    > [!NOTE] When using the embedded installer, you must reference the CommonCryptoLib library in
    > the SAP Connector Config properties with the proper path.

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Property</th><th>Example Value</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>jco.client.snc_lib</p></div></div></td><td><p>${app.home}/sec/libsapcrypto.so</p></td><td><p>Location of the SAP CommonCryptoLib. The library configured through this property is used by the connector operations. Depending on the operating system you may have to use other libraries, for example, the CloudHub 2.0 operating system is Linux based.</p></td></tr><tr><td><div><div><p>jco.server.snc_lib</p></div></div></td><td><p>${app.home}/sec/libsapcrypto.so</p></td><td><p>Location of the SAP CommonCryptoLib. The library configured through this property is used by the connector sources. Depending on the operating system you may have to use other libraries, for example, the CloudHub 2.0 operating system is Linux based.</p></td></tr></tbody></table>

7.  Click **Start** to run the application.

## Configure the SAP Server

Configure the certificates and tables that authorize you to use SNC with your distinguished name. To
configure the SAP server:

1.  View the SAP distinguished name and certificates.

2.  Link the SAP certificate to your certificate.

3.  Authorize the SNC client in SAP.

### View the SAP Distinguished Name and Certificates

View the SAP distinguished name and list of certificates:

1.  Log in to the SAP GUI and enter the `strust` transaction.

2.  Select the **SNC SAPCryptolib** folder in the left pane.

    The SAP distinguished name and certificate list are displayed.

### Link the SAP Certificate to Your Certificate

Download the SAP instance certificate and link it to your certificate:

1.  Click the glasses icon (first icon on the left of the screen) to enable the edition mode, and
    then double click `CN=SL-ABAP-IDP`.

2.  Click the download button at the bottom of the screen and enter the target path for the
    download.

3.  Click the import icon and enter the target path to upload your certificate.

4.  Click **Add to Certificate List** and then click the save icon.

5.  Open a command-line interface or terminal window and use the `sapgenpse` tool to link your
    certificate to your PSE:

    `sapgenpse maintain_pk -v -a <name_of_SAP_Server_Certificate.crt> -p <name_of_your_PSE.pse>`

    The following example links a certificate named `IDE.crt` to a PSE named `RFC.pse`:

    ![Terminal window for linking IDE.crt to RFC.pse](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-import-certificate.png)

### Authorize the SNC Client in SAP

Add a new entry to the `VSNCSYSACL` view to enable your distinguished name to use SNC:

1.  In the SAP GUI, navigate to the **SM30** transaction and enter `VSNCSYSACL` as the view name.

2.  Click **Maintain**.

3.  Select **E** as the work area.

4.  In the **System ID** field, enter the SAP ID.

5.  In the **SNC name** field, enter your distinguished name:

    `p:<your-distinguished-name>`

6.  Select all of the checkboxes to activate the entries.

7.  Click the save icon.

    - If the server accepts the SNC name, it displays a `Canonical Name Determined` message in the
      SNC data box.

    - If the server does not accept the SNC name, check that the name used on the PSE file is the
      same as the name used on the Mule app and the name listed on STRUST.

8.  Enable the SAP user for the Mule app so the app can use the SNC connection type:

    1.  Navigate to the **SM30** transaction, specify the `VUSREXTID` view, and click **Maintain**.

    2.  In the **External ID type** field, select `DN` as the work area.

    3.  In the **External ID** field, enter the distinguished name.

    4.  In the **User** field, enter the SAP username.

    5.  Select **Activated**.

    6.  Click the save icon.

## Configure SAP Connector

Configure SAP Connector to enable SNC with certificate:

1.  Access Anypoint Studio.

2.  Select **SAP** in the Studio canvas.

3.  Click the plus sign (+) next to the **Connector configuration** field to access the global
    element configuration fields.

4.  Configure the X.509 certificate connection:

    1.  In the **Connection** field, select `Certificate`.

    2.  On the **General** tab, configure these fields:

        - **X.509 Certificate** (PEM, for example .pem or .crt)

        - **Sap client ID**

        - **Application server host**

    3.  On the **Advanced** tab, configure the extended properties.

### SAP Server-Side Extended Properties Example:

The following table shows example values for the server-side extended properties:

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Example Value</th></tr></thead><tbody><tr><td><div><div><p>jco.server.snc_mode</p></div></div></td><td><p><code>1</code></p></td></tr><tr><td><div><div><p>jco.server.snc_partnername</p></div></div></td><td><p><code>p:CN=SL-ABAP-IDP</code></p></td></tr><tr><td><div><div><p>jco.server.snc_qop</p></div></div></td><td><p><code>8</code></p></td></tr><tr><td><div><div><p>jco.server.snc_myname</p></div></div></td><td><p><code>p:CN=MVIDP, C=AR, O=MuleSoft, OU=IT</code></p></td></tr><tr><td><div><div><p>jco.server.snc_lib</p></div></div></td><td><p><code>C:/SNC/64bit/sapcrypto.dll</code></p></td></tr></tbody></table>

### SAP Client Side Extended Properties Example

The following table shows example values for the client side extended properties:

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Example Value</th></tr></thead><tbody><tr><td><div><div><p>jco.client.snc_mode</p></div></div></td><td><p><code>1</code></p></td></tr><tr><td><div><div><p>jco.client.snc_partnername</p></div></div></td><td><p><code>p:CN=SL-ABAP-IDP</code></p></td></tr><tr><td><div><div><p>jco.client.snc_qop</p></div></div></td><td><p><code>8</code></p></td></tr><tr><td><div><div><p>jco.client.snc_myname</p></div></div></td><td><p><code>p:CN=MVIDP, C=AR, O=MuleSoft, OU=IT</code></p></td></tr><tr><td><div><div><p>jco.client.snc_lib</p></div></div></td><td><p><code>C:/SNC/64bit/sapcrypto.dll</code></p></td></tr><tr><td><div><div><p>jco.client.x509cert</p></div></div></td><td><p><code>ABCD12EFG</code></p></td></tr></tbody></table>

## See also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=02539e7ccc3ebc44ad3d11a0e0e454bb394d2bc5c63cda0d37cf3d4025d1db16 url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-config-snc-kerberos.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# Configuring an SAP Secure Network Communication Connection with Kerberos

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Configure an SAP Secure Network Communication (SNC) with Kerberos to take advantage of security
features such as secure data communication between the SAP system client and server,
application-level end-to-end security, and the ability to change security products without impacting
your SAP business applications. To enable SNC with Kerberos, configure the client environment, the
SAP server, and Anypoint Connector for SAP (SAP Connector).

> [!NOTE] SAP does not provide support for third-party solutions.

## Before You Begin

To configure an SAP SNC with Kerberos, you must have access to:

- The SAP GUI application

  To install this client, Java must already be installed on your machine. Then, download the
  installer for your operating system from SAP.

- An SAP ECC instance that can use SNC system variables

- The following transactions:

  - `STRUST` (Trust Manager)

  - `SM30` (Table Maintenance)

  - `SNC1` (Generate SNC name for user)

  - `SU01` (User Maintenance)

  - `SM59` (RFC Destinations)

## Configure Active Directory

To configure Active Directory, create a new Service Principal Name (SPN) according to the operating
system you are using and export the keytab.

If you are using Windows, follow these steps:

1.  Create a service user `sidadm` in Active Directory.

2.  Select **Password never expires** and deselect **Use DES encryption types for this account**.

3.  Create a Service Principal Name (SPN) `SAPService/sapdev@SSODOMAIN.LAB` for the `sidadm` user in
    Active Directory.

    `setspn -A SAPService/sapdev@SSODOMAIN.LAB DOMAIN_SHORT\sidadm`

4.  Run the following command to export the keytab for this SPN from Active Directory. The password
    is the password to set for the keytab and the SID is the file name of the keytab.

    `ktpass -princ SAPService/sapdev@SSODOMAIN.LAB -mapuser DOMAIN_SHORT\sidadm -crypto AES256-SHA1 -ptype KRB5_NT_PRINCIPAL -mapop set -pass <*password*> -out <SID>aes.keytab`

## Configure the SAP Server

To configure the SAP server, change the domain and the KDC in the operating system of the SAP server
to set up Kerberos and add the parameters and the library that authorize you to use SNC:

1.  Configure the `krb5.conf` file using the KDC address and the realm information (SSODOMAIN.LAB).
    The `krb5.conf` file is created by default in the `etc` directory.

    \[libdefaults\] # "dns\_canonicalize\_hostname" and "rdns" are better set to false for improved
    security. # If set to true, the canonicalization mechanism performed by Kerberos client may #
    allow service impersonification, the consequence is similar to conducting TLS certificate #
    verification without checking host name. # If left unspecified, the two parameters will have
    default value true, which is less secure. dns\_canonicalize\_hostname = false rdns = false #
    default\_realm = EXAMPLE.COM default\_realm = SSODOMAIN.LAB

    \[realms\] # EXAMPLE.COM = { # kdc = kerberos.example.com # admin\_server =
    kerberos.example.com # } SSODOMAIN.LAB = { kdc = DC.SSODOMAIN.LAB admin\_server =
    dc.SSODOMAIN.LAB } \[domain\_realm\] .ssodomain.lab = SSODOMAIN.LAB ssodomain.lab =
    SSODOMAIN.LAB

    \[logging\] kdc = FILE:/var/log/krb5/krb5kdc.log admin\_server = FILE:/var/log/krb5/kadmind.log
    default = SYSLOG:NOTICE:DAEMON

    \[libdefaults\] default\_ccache\_name = FILE:/tmp/krb5cc\_%{uid}

2.  Run the following commands to import the key to the `etc` directory:

    `ktutil`

    `wkt /etc/krb5.keytab`

    `q`

3.  Obtain a Kerberos Ticket Granting Ticket (TGT):

    `kinit -V SAPService/sapdev@SSODOMAIN.LAB`

4.  Run the following commands to change the permissions for the keytab:

    `chgrp sapsys /etc/krb5.keytab`

    `chmod 640 /etc/krb5.keytab`

5.  Set up automatic renewal for the Kerberos TGT:

    `crontab -e 01 0,6,12,18 * * * /usr/bin/kinit -R SAPService/sapdev@SSODOMAIN.LAB`

6.  Locate the GSS-API library on the SAP server (in this example, it is under the
    `/usr/lib64/libgssapi_krb5.so.2` path), configure the parameters for SNC with Kerberos in the
    default profile, and then restart SAP.

    - `snc/permit_insecure_start = 1`

    - `snc/data_protection/use = 3`

    - `snc/data_protection/max = 3`

    - `snc/data_protection/min = 1`

    - `snc/accept_insecure_r3int_rfc = 1`

    - `snc/accept_insecure_rfc = 1`

    - `snc/accept_insecure_cpic = 1`

    - `snc/accept_insecure_gui = 1`

    - `snc/gssapi_lib = /usr/lib64/libgssapi_krb5.so.2`

    - `snc/enable = 1`

    - `snc/identity/as = p:SAPService/sapdev@SSODOMAIN.LAB`

    - `login/password_change_for_SSO = 0`

7.  Create `sidadm` as a user in SAP and set the SNC name using the transaction `SU01`.

8.  For the RFC destination, use the transaction `SM59`. On the **Logon and Security** tab, enable
    the SNC option and add the SPN name as a partner.

## Configure SAP Connector

To configure SAP Connector, enable SNC with Kerberos:

1.  Access Anypoint Studio.

2.  Select **SAP** in the Studio canvas.

3.  Click the plus sign (+) next to the **Connector configuration** field to access the global
    element configuration fields.

4.  Configure the Kerberos connection:

    1.  In the **Connection** field, select `Kerberos`.

    2.  On the **General** tab, configure these fields:

        - **SAP system number**

        - **SAP client ID**

        - **Application server host**

        - **Kerberos Config File Path**

          Path to the `krb5.conf` file using the KDC address and the realm information
          (SSODOMAIN.LAB)

        - **Keytab File Path**

          Path to the keytab for the SPN from Active Directory.

          The keytab must contain only the entry for the **Principal** (`sidadm`). If you use an
          existing keytab, you must remove the existing entry first. To remove the existing entry,
          run the following command:

          `ktutil -k <replace_with_keytab_name>.keytab remove -p <replace_with_principal_name>@<replace_with_domain>`

          To create a new keytab, run the following command:

          `ktutil --keytab=<replace_with_keytab_name>.keytab add -p <replace_with_principal_name>@<replace_with_domain> -w <replace_with_principal_password> -e aes256-cts-hmac-sha1-96 -V <replace_with_key _version_number>`

        - **GSS Library Path**

          Static value `/usr/lib64/libgssapi_krb5.so.2.2` for CloudHub and CloudHub 2.0 or Runtime
          Fabric when using images published after July 2025. Static value
          `/usr/lib/x86_64-linux-gnu/libgssapi_krb5.so.2.2` for CloudHub 2.0 or Runtime Fabric when
          using images published before July 2025.

        - **Principal**

          Service user name from Active Directory, in this example `sidadm`

        - **Client SNC Partner Name**

          SPN name from Active Directory, in this example `p:SAPService/sapdev@SSODOMAIN.LAB`

        - **Client SNC My Name**

          SNC name that identifies the client in secure network communications, in this example
          `p:sidadm`

    3.  On the **Advanced** tab, you do not need to change the extended properties because the
        Kerberos configuration already sets them.

### SAP Extended Properties for Kerberos

The following tables show the default values for the SAP extended properties for Kerberos.

The connector sets the following common extended properties:

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Default Value</th></tr></thead><tbody><tr><td><div><div><p>jco.server.snc_mode</p></div></div></td><td><p><code>1</code></p></td></tr><tr><td><div><div><p>jco.server.snc_qop</p></div></div></td><td><p><code>3</code></p></td></tr></tbody></table>

The connector sets the following extended properties for operations:

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Default Value</th></tr></thead><tbody><tr><td><div><div><p>jco.client.user</p></div></div></td><td><p>The <strong>Principal</strong> set under <strong>Kerberos Parameters for Operations</strong> in the <strong>General</strong> tab</p></td></tr><tr><td><div><div><p>jco.client.snc_lib</p></div></div></td><td><p>The path from <strong>GSS Library Path</strong> set under <strong>Kerberos Common Parameters</strong> in the <strong>General</strong> tab</p></td></tr><tr><td><div><div><p>jco.client.snc_myname</p></div></div></td><td><p>The <strong>Client SNC My Name</strong> set under <strong>Kerberos Parameters for Operations</strong> in the <strong>General</strong> tab</p></td></tr><tr><td><div><div><p>jco.client.snc_partnername</p></div></div></td><td><p>The <strong>Client SNC Partner Name</strong> set under <strong>Kerberos Parameters for Operations</strong> in the <strong>General</strong> tab</p></td></tr></tbody></table>

The connector sets the following extended properties for sources:

<table><colgroup><col> <col></colgroup><thead><tr><th>Property</th><th>Default Value</th></tr></thead><tbody><tr><td><div><div><p>jco.server.snc_lib</p></div></div></td><td><p>The path from <strong>GSS Library Path</strong> set under <strong>Kerberos Common Parameters</strong> in the <strong>General</strong> tab</p></td></tr><tr><td><div><div><p>jco.server.snc_myname</p></div></div></td><td><p>The <strong>Server SNC My Name</strong> set under <strong>Kerberos Parameters for Sources</strong> in the <strong>General</strong> tab</p></td></tr><tr><td><div><div><p>jco.server.snc_partnername</p></div></div></td><td><p>The <strong>Server SNC Partner Name</strong> set under <strong>Kerberos Parameters for Sources</strong> in the <strong>General</strong> tab</p></td></tr></tbody></table>

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=d434903d1b6a0f5af942de61894ab5092f43c6ff06421c67c91a349e56ff0255 url=/mulesoft/current/en-us/sap-connector/latest/index.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# SAP Connector 5.9

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for SAP (SAP Connector) enables integration of data between external systems and
SAP systems based on SAP NetWeaver.

This connector requires a separate license. Contact MuleSoft to evaluate or use this connector in
production.

Mule runtime engine (Mule) supports SAP integration through Anypoint Connector for SAP, which
leverages the SAP Java Connector (JCo) libraries. SAP JCo facilitates communication between an SAP
backend system and a Java application. It allows Java programs to connect to SAP systems and invoke
Remote Function Modules. It also allows the parsing of IDocs (SAP Intermediate Documents), among
other object types. The SAP configuration supports both inbound and outbound communications.

The SAP JCo libraries enable Mule apps to:

- Execute BAPI functions over the following types of RFC protocols:

  - Synchronous Remote Function Call RFC (sRFC)

  - Asynchronous Remote Function Call RFC (aRFC)

- Act as a JCo server to be called as a BAPI over sRFC and aRFC

- Send IDocs over tRFC and qRFC

- Receive IDocs over tRFC and qRFC

- Transform SAP objects (JCo function for BAPI and IDocs) to and from XML

See [SAP Terminology](https://docs.mulesoft.com/sap-connector/latest/sap-connector-terminology) to understand SAP acronyms.

## Before You Begin

To use this connector, you must be familiar with:

- SAP Connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- Creating a Mule app using Anypoint Studio or Anypoint Code Builder

Before creating an app, you must have:

- Credentials to access the SAP target resource

- SAP libraries for IDoc, JCO, and JCO Native

  To download these libraries, go to the SAP website. Studio 7 can use the library formats directly
  without conversion. To see which libraries are compatible with the connector, see the
  [SAP Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/sap-connector-release-notes-mule-4).

- A service user with the roles or profiles that allow you to use the required RFCs, BAPIs, and
  IDocs

- A working knowledge of the SAP business context and, in particular, the SAP R/3 Business Suite

- A basic understanding of the SAP NetWeaver Platform from an administration point of view

- Knowledge of the ABAP language

- An SAP ID to download the required SAP libraries

- Use of the RFC protocol to connect to NetWeaver Application Servers (NWAS)  
  [ECC](https://www.cipherbsc.com/sap-erp-central-component-erp-ecc/) and
  [CRM](https://help.sap.com/docs/r/p/SAP_CUSTOMER_RELATIONSHIP_MANAGEMENT) run on top of NWAS, as
  other SAP solutions do, so any customer using the connector can access those systems.

- Knowledge of how to create a Mule app using Anypoint Studio

## Common Use Cases for the Connector

Common use cases for SAP Connector include:

- **Unified View of Enterprise Resources**

  Enable real-time integration of digital information across your business from financial
  accounting, materials management, sales and distribution, and customer service to make data-driven
  decisions that optimize core business processes.

- **Data Synchronization**

  Sync SAP data with your business applications, such as Salesforce, Workday, and Marketo. For
  example, you can migrate a large set of accounts from SAP to Salesforce or broadcast changes in
  organizations from SAP to Workday in real-time.

- **Sales Order Automation**

  Automate sales order processing between SAP ERP and a CRM, such as Salesforce.

- **BAPI Support**

  Discover BAPIs, query BAPI/RFM enabled function modules, or execute BAPI functions.

- **IDoc Integration**

  Send and receive IDocs from SAP, import IDocs, or transform SAP objects to and from XML.

For examples of these use cases, refer to [SAP Connector Examples](https://docs.mulesoft.com/sap-connector/latest/sap-connector-examples).

## Authentication Types

SAP Connector connections use the following authentication types:

- Certificate

  Connection provider that relies on an X509 certificate to authenticate the user

- Kerberos

  Connection provider that implements the Kerberos protocol to authenticate and authorize the user

- Simple Connection Provider

  Connection provider that connects using a username and password

## Exchange Templates and Examples

[Anypoint Exchange](https://www.mulesoft.com/exchange/) provides templates that you can use as
starting points for your apps and examples that illustrate a complete solution:

- **General:**
  [Account System API - SAP Implementation Template](https://www.mulesoft.com/exchange/org.mule.templates/template-apiled-system-account-sap/),
  [Salesforce to Salesforce, Workday, SAP, and Database Account Broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sfdc.wday.sap.db-account-broadcast/)

- **Salesforce and SAP:**
  [Account Aggregation](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-account-aggregation/),
  [Account Customer Bidirectional Sync](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-customer-bidirectional-sync/),
  [Opportunity Aggregation](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-opportunity-aggregation/),
  [Product Aggregation](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-product-aggregation/),
  [Product Bidirectional Sync](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-product-bidirectional-sync/)

- **Salesforce to SAP:**
  [Account Broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-account-broadcast/),
  [Account Migration](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-account-migration/),
  [Opportunity Broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-opportunity-broadcast/),
  [Opportunity Migration](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-opportunity-migration/),
  [Product Broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sfdc2sap-product-broadcast/)

- **SAP to Salesforce:**
  [Contact Broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-contact-broadcast/),
  [Contact Migration](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-contact-migration/),
  [Customer Broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-customer-broadcast/),
  [Customer Migration](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-customer-migration/),
  [Product Material Broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-product-broadcast/),
  [Product Material Migration](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2sfdc-material-migration/)

- **SAP to Workday:**
  [Employee Migration](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2wday-employee-migration/),
  [Organization Broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2wday-organization-broadcast/),
  [Organization Migration](https://www.mulesoft.com/exchange/org.mule.templates/template-sap2wday-organization-migration/)

- **Workday and SAP:**
  [Organization Aggregation](https://www.mulesoft.com/exchange/org.mule.templates/template-wday2sap-organization-aggregation/),
  [Worker (Employee) Aggregation](https://www.mulesoft.com/exchange/org.mule.templates/template-wday2sap-worker-aggregation/)

- **Workday to SAP:**
  [Worker (Employee) Migration](https://www.mulesoft.com/exchange/org.mule.templates/template-wday2sap-worker2employee-migration/),
  [Worker Broadcast](https://www.mulesoft.com/exchange/org.mule.templates/template-wday2sap-worker-broadcast/)

## Next

After you complete the prerequisites and experimented with templates and examples, you are ready to
create an app with [Anypoint Studio](https://docs.mulesoft.com/sap-connector/latest/sap-connector-studio).

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [SAP Connector in Anypoint Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-sap-connector/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=7e229ae2c6317fd9361039253cf5fb3f069abb85e9b36788ebf7fec9d5619faa url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-config-topics.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# SAP Connector 5.9 Additional Configuration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

After you complete basic SAP Connector configuration, you can perform additional configuration
tasks, such as changing advanced settings and defining extended properties.

## Configure General Settings

1.  At the bottom of the canvas, click **Global Elements**.

2.  Click **Create**.

3.  Expand **Connector Configuration**, select either **SAP Inbound** or **SAP Outbound**, and click
    **OK**.

4.  Click the **Advanced tab** at the top of the **Global Element Properties** screen:

    ![Advanced tab selected in Global element properties window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-config-adv.png)

5.  In the **General** section, to set the **Max Idle time** parameter:

    1.  Select **Expiration policy**.

    2.  Enter a value in the **Max Idle time**, and then add the **Time Unit**.

    3.  Click **OK**

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th></tr></thead><tbody><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p>ExpirationPolicy</p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when appropriate.</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Idle time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration one of:</p></div><div><ul><li><p>DAYS</p></li><li><p>HOURS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>MINUTES</p></li><li><p>NANOSECONDS SECONDS</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Configure Advanced Settings

![Fields in Advanced tab of global element properties window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-advanced.png)

You can set encoding, version, flag, format, and timeout parameters in Advanced settings.

To change these field values, click the **Advanced tab** at the top of the **Global Element
Properties** screen:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>XML Attribute</th><th>Description</th><th>Default Value</th></tr></thead><tbody><tr><td><p><strong>Display Name</strong></p></td><td><div><div><p>name</p></div></div></td><td><div><div><p>Set a reference name for the endpoint used internally by the Mule configuration.</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p><code>encoding</code></p></div></div></td><td><div><div><p>Set a canonical name for an encoding. See <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Default IDocument Version</strong></p></td><td><div><div><p><code>defaultIdocumentVersion</code></p></div></div></td><td><div><div><p>Set the version when sending an intermediate document (IDoc). Values for the IDoc version correspond to <code>IDOC_VERSION_xxxx</code> constants in <code>com.sap.conn.idoc.IDocFactory</code>.</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Function template cache flag</strong></p></td><td><div><div><p><code>disableFunctionTemplateCacheFlag</code></p></div></div></td><td><div><div><p>Set to disable the function template cache.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><p><strong>Evaluate response flag</strong></p></td><td><div><div><p><code>evaluateResponseFlag</code></p></div></div></td><td><div><div><p>Set if an error response should throw an exception or let the user handle it with another result.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><p><strong>Log trace flag</strong></p></td><td><div><div><p><code>logTraceFlag</code></p></div></div></td><td><div><div><p>Set if the trace should be logged on the Mule server.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><p><strong>Use SAP format</strong></p></td><td><div><div><p><code>useSAPFormat</code></p></div></div></td><td><div><div><p>Set to use the SAP default format when working with business application programming interface (BAPI) functions using a synchronous remote function call (sRFC).</p></div></div></td><td><div><div><p>false</p></div></div></td></tr></tbody></table>

## Define Extended Properties

Extended properties enable you to tune SAP outbound configuration parameters.

To define extended properties for the SAP connector global element:

1.  Navigate to the **Advanced** tab on the **General** pane:

    ![Advanced tab selected in the General tab](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-advanced-tab.png)

2.  Locate the **Extended Properties** section at the top of the window.

3.  Select the **Edit inline** option.

4.  Click **+** to add a new extended property.  
    Use the same property name that SAP uses:

    1.  [Pooling Config](https://help.sap.com/docs/r/b865ed651e414196b39f8922db2122c7/Cloud/en-US/8278bed44893498f95d5d6d5f0a47f35.html)

    2.  [Target System configuration](https://help.sap.com/docs/r/b865ed651e414196b39f8922db2122c7/Cloud/en-US/f8fac995b0144a0b8ec0801b8f7bab3e.html)

### Configure the Client Environment

Configure the system variables that depend on the operating system you are using, and generate the
PSE (personal security environment):

1.  Use the following command to open your cmd or terminal and unpack the SAPCAR and SAP
    Cryptographic Library:

    \`SAPCAR -xvf <name\_of\_the\_file.SAR>

    This extracts files from the folder **(which folder?)**

2.  Configure the following environment variables: **(Do the variables vary by OS or are they the
    same and just configured differently?)** \* For this example, the path to the library is
    “C:\\Users\\Administrator\\Desktop\\SNC”:\*

    - SNC\_LIB

    - SECUDIR = `<Path_to_library>`

    - LD\_LIBRARY\_PATH = `<Path_to_library>\sapcrypto.dll`

    - SSF\_LIBRARY\_PATH = `<Path_to_library>\sapcrypto.dll`

      For Windows, the `sapcrypto.dll` 64bit version must be in another path and added to a new
      variable called SNC\_LIB\_64.

      In your cmd or terminal, use the following command to create the PSE:

      `sapgenpse gen_pse -v -p RFC.pse`

      When you run this command, you must enter a password or PIN to use later and a distinguished
      name, which must be unique. You can check for names that are already used at STRUST.

3.  Add the credentials that your session user needs to access the PSE which will create the file
    cred\_v2 with this command: sapgenpse seclogin -p RFC -O you\_user.

## Next

Now that you have completed configuration, you can experiment with the SAP
[Examples](https://docs.mulesoft.com/sap-connector/latest/sap-connector-examples).

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=041b4d944635795a2cff7538fba02d30e3c0d5dd994d37a0281605cba58e6a5e url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-examples.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# SAP Connector 5.9 Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following examples show several Mule flows for SAP Connector:

- [Send an IDoc to SAP](#send-an-idoc-to-sap)

- [Receive an Incoming IDoc Request](#receive-an-incoming-idoc-request)

- [Receive an SAP Function](#receive-an-sap-function)

- [Manage Transactions](#manage-transactions)

- [Configure Multiple Gateways](#configure-multiple-gateways)

## Send an IDoc to SAP

This example shows you how to create a Mule app that sends an IDoc to SAP. The following screenshot
shows the Studio flow for this example:

![Studio flow for sending an IDoc to SAP](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-example-send-idoc.png)

### Configure HTTP Listener

Configure HTTP Listener to initiate a Mule flow when a call is made to the `/sendIDoc` path on
localhost port `8081`:

1.  In Anypoint Studio, create a new Mule project.

2.  From the **Mule Palette** view, drag the **HTTP > Listener** source to the canvas.

3.  Configure the global element using the default values.

4.  In the **Listener** properties tab, set the path to `/sendIDoc`.

### Add the Transform Message Component

Configure the **Transform Message** component to convert the IDoc input to XML:

1.  From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
    next to the **Listener** source.

2.  After the metadata is retrieved, overlay the text in the **Output** section of the **Transform
    Message** component with the following text:

    ```dataweave
    %dw 2.0
    output application/xml
    <MATMAS01>
    <IDOC BEGIN="1">
      <EDI_DC40 SEGMENT="1">
        <TABNAM>EDI_DC40</TABNAM>
        <MANDT>800</MANDT>
        <DOCNUM>0000000003519646</DOCNUM>
        <DOCREL>740</DOCREL>
        <STATUS>30</STATUS>
        <DIRECT>1</DIRECT>
        <OUTMOD>2</OUTMOD>
        <IDOCTYP>MATMAS01</IDOCTYP>
        <MESTYP>MATMAS</MESTYP>
        <SNDPOR>SAPIDE</SNDPOR>
        <SNDPRT>LS</SNDPRT>
        <SNDPRN>T90CLNT090</SNDPRN>
        <RCVPOR>MULE01_TP</RCVPOR>
        <RCVPRT>LS</RCVPRT>
        <RCVPRN>MULE01_LS</RCVPRN>
        <CREDAT>20180606</CREDAT>
        <CRETIM>133420</CRETIM>
        <SERIAL>20180606133420</SERIAL>
      </EDI_DC40>
      <E1MARAM SEGMENT="1">
        <MSGFN>005</MSGFN>
        <MATNR>000000000000000088</MATNR>
        <ERSDA>19970527</ERSDA>
        <ERNAM>MORLEY</ERNAM>
        <LAEDA>20030122</LAEDA>
        <AENAM>I021066</AENAM>
        <PSTAT>KVB</PSTAT>
        <LVORM>X</LVORM>
        <MTART>FERT</MTART>
        <MBRSH>M</MBRSH>
        <MATKL>02004</MATKL>
        <MEINS>PCE</MEINS>
        <BLANZ>000</BLANZ>
        <BRGEW>0.200</BRGEW>
        <NTGEW>0.200</NTGEW>
        <GEWEI>KGM</GEWEI>
        <VOLUM>0.000</VOLUM>
        <TRAGR>0001</TRAGR>
        <SPART>09</SPART>
        <WESCH>0.000</WESCH>
        <LAENG>0.000</LAENG>
        <BREIT>0.000</BREIT>
        <HOEHE>0.000</HOEHE>
        <ERGEW>0.000</ERGEW>
        <ERVOL>0.000</ERVOL>
        <GEWTO>0.0</GEWTO>
        <VOLTO>0.0</VOLTO>
        <FUELG>0</FUELG>
        <STFAK>0</STFAK>
        <MHDRZ>0</MHDRZ>
        <MHDHB>0</MHDHB>
        <MHDLP>0</MHDLP>
        <VPSTA>KVB</VPSTA>
        <MSTDE>00000000</MSTDE>
        <MSTDV>00000000</MSTDV>
        <COMPL>00</COMPL>
        <GEWTO_NEW>0.0</GEWTO_NEW>
        <VOLTO_NEW>0.0</VOLTO_NEW>
        <ANP>000000000</ANP>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>1</SPRAS>
          <MAKTX>AS-100 T-shirt</MAKTX>
          <SPRAS_ISO>ZH</SPRAS_ISO>
        </E1MAKTM>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>4</SPRAS>
          <MAKTX>AS-100 T-shirt</MAKTX>
          <SPRAS_ISO>RO</SPRAS_ISO>
        </E1MAKTM>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>5</SPRAS>
          <MAKTX>AS-100 T-shirt</MAKTX>
          <SPRAS_ISO>SL</SPRAS_ISO>
        </E1MAKTM>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>6</SPRAS>
          <MAKTX>AS-100 T-shirt</MAKTX>
          <SPRAS_ISO>HR</SPRAS_ISO>
        </E1MAKTM>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>E</SPRAS>
          <MAKTX>AS-100 T-shirt</MAKTX>
          <SPRAS_ISO>EN</SPRAS_ISO>
        </E1MAKTM>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>F</SPRAS>
          <MAKTX>AS-100 T-shirt</MAKTX>
          <SPRAS_ISO>FR</SPRAS_ISO>
        </E1MAKTM>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>G</SPRAS>
          <MAKTX>AS-100 T-shirt</MAKTX>
          <SPRAS_ISO>EL</SPRAS_ISO>
        </E1MAKTM>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>J</SPRAS>
          <MAKTX>AS-100 T ???</MAKTX>
          <SPRAS_ISO>JA</SPRAS_ISO>
        </E1MAKTM>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>W</SPRAS>
          <MAKTX>AS-100 T-shirt</MAKTX>
          <SPRAS_ISO>BG</SPRAS_ISO>
        </E1MAKTM>
        <E1MAKTM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <SPRAS>d</SPRAS>
          <MAKTX>AS-100 T-shirt</MAKTX>
          <SPRAS_ISO>SH</SPRAS_ISO>
        </E1MAKTM>
        <E1MARCM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <WERKS>1000</WERKS>
          <PSTAT>V</PSTAT>
          <LVORM>X</LVORM>
          <PLIFZ>0</PLIFZ>
          <WEBAZ>0</WEBAZ>
          <PERKZ>M</PERKZ>
          <AUSSS>0.00</AUSSS>
          <MINBE>0.000</MINBE>
          <EISBE>0.000</EISBE>
          <BSTMI>0.000</BSTMI>
          <BSTMA>0.000</BSTMA>
          <BSTFE>0.000</BSTFE>
          <BSTRF>0.000</BSTRF>
          <MABST>0.000</MABST>
          <LOSFX>0</LOSFX>
          <AUSDT>00000000</AUSDT>
          <BEARZ>0.00</BEARZ>
          <RUEZT>0.00</RUEZT>
          <TRANZ>0.00</TRANZ>
          <BASMG>0.000</BASMG>
          <DZEIT>0</DZEIT>
          <MAXLZ>0</MAXLZ>
          <UEETO>0.0</UEETO>
          <UNETO>0.0</UNETO>
          <WZEIT>0</WZEIT>
          <VZUSL>0.00</VZUSL>
          <UMLMC>0.000</UMLMC>
          <LGRAD>0.0</LGRAD>
          <OBJID>00000000</OBJID>
          <MTVFP>01</MTVFP>
          <VRVEZ>0.00</VRVEZ>
          <VBAMG>0.000</VBAMG>
          <VBEAZ>0.00</VBEAZ>
          <TRAME>0.000</TRAME>
          <FXHOR>000</FXHOR>
          <VINT1>000</VINT1>
          <VINT2>000</VINT2>
          <LOSGR>0.000</LOSGR>
          <KAUSF>0.00</KAUSF>
          <TAKZT>0</TAKZT>
          <VRBDT>00000000</VRBDT>
          <VRBFK>0.00</VRBFK>
          <PREND>00000000</PREND>
          <PRENG>00000000</PRENG>
          <PRFRQ>0</PRFRQ>
          <SHZET>00</SHZET>
          <MMSTD>00000000</MMSTD>
          <DPLHO>0</DPLHO>
          <MINLS>0.000</MINLS>
          <MAXLS>0.000</MAXLS>
          <FIXLS>0.000</FIXLS>
          <LTINC>0.000</LTINC>
          <COMPL>00</COMPL>
          <EISLO>0.000</EISLO>
        </E1MARCM>
        <E1MARCM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <WERKS>2300</WERKS>
          <PSTAT>VB</PSTAT>
          <LVORM>X</LVORM>
          <PLIFZ>0</PLIFZ>
          <WEBAZ>0</WEBAZ>
          <PERKZ>M</PERKZ>
          <AUSSS>0.00</AUSSS>
          <MINBE>0.000</MINBE>
          <EISBE>0.000</EISBE>
          <BSTMI>0.000</BSTMI>
          <BSTMA>0.000</BSTMA>
          <BSTFE>0.000</BSTFE>
          <BSTRF>0.000</BSTRF>
          <MABST>0.000</MABST>
          <LOSFX>0</LOSFX>
          <AUSDT>00000000</AUSDT>
          <BEARZ>0.00</BEARZ>
          <RUEZT>0.00</RUEZT>
          <TRANZ>0.00</TRANZ>
          <BASMG>0.000</BASMG>
          <DZEIT>0</DZEIT>
          <MAXLZ>0</MAXLZ>
          <UEETO>0.0</UEETO>
          <UNETO>0.0</UNETO>
          <WZEIT>0</WZEIT>
          <VZUSL>0.00</VZUSL>
          <UMLMC>0.000</UMLMC>
          <LADGR>0001</LADGR>
          <LGRAD>0.0</LGRAD>
          <OBJID>00000000</OBJID>
          <MTVFP>01</MTVFP>
          <VRVEZ>0.00</VRVEZ>
          <VBAMG>0.000</VBAMG>
          <VBEAZ>0.00</VBEAZ>
          <TRAME>0.000</TRAME>
          <FXHOR>000</FXHOR>
          <VINT1>000</VINT1>
          <VINT2>000</VINT2>
          <LOSGR>0.000</LOSGR>
          <KAUSF>0.00</KAUSF>
          <TAKZT>0</TAKZT>
          <VRBDT>00000000</VRBDT>
          <VRBFK>0.00</VRBFK>
          <PRENO>00000000</PRENO>
          <PREND>00000000</PREND>
          <PRENG>00000000</PRENG>
          <PRFRQ>0</PRFRQ>
          <SHZET>00</SHZET>
          <MMSTD>00000000</MMSTD>
          <DPLHO>0</DPLHO>
          <MINLS>0.000</MINLS>
          <MAXLS>0.000</MAXLS>
          <FIXLS>0.000</FIXLS>
          <LTINC>0.000</LTINC>
          <COMPL>00</COMPL>
          <EISLO>0.000</EISLO>
        </E1MARCM>
        <E1MARMM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <MEINH>PCE</MEINH>
          <UMREZ>1</UMREZ>
          <UMREN>1</UMREN>
          <LAENG>0.000</LAENG>
          <BREIT>0.000</BREIT>
          <HOEHE>0.000</HOEHE>
          <VOLUM>0.000</VOLUM>
          <BRGEW>0.200</BRGEW>
          <GEWEI>KGM</GEWEI>
          <NEST_FTR>0</NEST_FTR>
          <MAX_STACK>0</MAX_STACK>
          <CAPAUSE>0.000</CAPAUSE>
        </E1MARMM>
        <E1MBEWM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <BWKEY>2300</BWKEY>
          <LVORM>X</LVORM>
          <VPRSV>S</VPRSV>
          <VERPR>0</VERPR>
          <STPRS>0.3</STPRS>
          <PEINH>1</PEINH>
          <BKLAS>7920</BKLAS>
          <VMVPR>S</VMVPR>
          <VMVER>0</VMVER>
          <VMSTP>0.3</VMSTP>
          <VMPEI>1</VMPEI>
          <VMBKL>7920</VMBKL>
          <VJVPR>S</VJVPR>
          <VJVER>0</VJVER>
          <VJSTP>0.3</VJSTP>
          <LFGJA>1998</LFGJA>
          <LFMON>09</LFMON>
          <ZKPRS>0</ZKPRS>
          <ZKDAT>00000000</ZKDAT>
          <BWPRS>0</BWPRS>
          <BWPRH>0</BWPRH>
          <VJBWS>0</VJBWS>
          <VJBWH>0</VJBWH>
          <VVJLB>0.000</VVJLB>
          <VVMLB>0.000</VVMLB>
          <VVSAL>0</VVSAL>
          <ZPLPR>0</ZPLPR>
          <ZPLP1>0</ZPLP1>
          <ZPLP2>0</ZPLP2>
          <ZPLP3>0</ZPLP3>
          <ZPLD1>00000000</ZPLD1>
          <ZPLD2>00000000</ZPLD2>
          <ZPLD3>00000000</ZPLD3>
          <BWPH1>0</BWPH1>
          <BWPS1>0</BWPS1>
          <ABWKZ>00</ABWKZ>
          <PSTAT>B</PSTAT>
          <KALN1>000100014878</KALN1>
          <KALNR>000100014879</KALNR>
          <VERS1>00</VERS1>
          <VERS2>00</VERS2>
          <VERS3>00</VERS3>
          <PPRDZ>000</PPRDZ>
          <PPRDL>000</PPRDL>
          <PPRDV>000</PPRDV>
          <PDATZ>0000</PDATZ>
          <PDATL>0000</PDATL>
          <PDATV>0000</PDATV>
          <VPLPR>0</VPLPR>
          <VJBKL>7920</VJBKL>
          <VJPEI>1</VJPEI>
          <HKMAT>X</HKMAT>
          <BWPEI>0</BWPEI>
        </E1MBEWM>
        <E1MLANM SEGMENT="1">
          <MSGFN>005</MSGFN>
          <ALAND>ES</ALAND>
          <TATY1>MWST</TATY1>
          <TAXM1>0</TAXM1>
        </E1MLANM>
      </E1MARAM>
    </IDOC>
    </MATMAS01>
    ',"application/xml")
    ```

### Add the Send IDoc Operation

The **Send IDoc** operation sends an IDoc to SAP over a remote function call (RFC):

1.  From the **Mule Palette** view, select **SAP** and drag the **Send IDoc** operation next to the
    **Transform Message** component.

2.  Create a global element named `SAP_Outbound` and specify the connection information.

3.  Click **Test Connection** to confirm that Mule runtime engine can connect with the SAP instance.

    - If the connection is successful, save the configuration.

    - Otherwise, review and correct any invalid parameters, and test again.

4.  Configure the **Send IDoc** properties with the following values:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>IDoc Name</strong></p></td><td><div><div><p><code>MATMAS01</code></p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p><code>#[payload]</code></p></div></div></td></tr></tbody></table>

### Add the Logger Component

The **Logger** component displays the connector payload in the Studio console.

1.  From the **Mule Palette** view, select **Core** and drag **Logger** next to the **Send IDoc**
    operation.

2.  Click **File** > **Save** to save the app.

### Run the App

To run the Mule app:

1.  Click **Run** > **Run as** > **Mule Application**.

2.  From a web browser, test the application by entering an employee’s internal ID, first name, and
    last name as query parameters for the following URL:

    `http://localhost:8081/sendIDoc`

    Mule sends the IDoc to SAP.

### XML for Sending an IDoc to SAP

Paste this code into a new Mule app in Studio to quickly load the flow for the sending an IDoc
example. Change the values to reflect your environment.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:sap="http://www.mulesoft.org/schema/mule/sap"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/sap http://www.mulesoft.org/schema/mule/sap/current/mule-sap.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
  <http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="58cb7168-7f00-4b96-977a-31dcc54992dd" >
    <http:listener-connection host="0.0.0.0" port="8081" />
    </http:listener-config>
    <sap:sap-config name="SAP_Outbound" doc:name="SAP Config" doc:id="367ae57d-001b-4d8f-b50f-f6d1d17410a7" >
      <sap:simple-connection-provider-connection username="User1" password="myPassword" systemNumber="00" client="800" applicationServerHost="saptext.net" />
      </sap:sap-config>
      <flow name="sap_send_idocFlow" doc:id="1ee42fb2-8d7d-482d-8f31-095cef12ff08" >
        <http:listener doc:name="Listener" doc:id="a1f287ba-4138-4183-903b-90d34abde5c6" config-ref="HTTP_Listener_config" path="/"/>
        <ee:transform doc:name="Transform Message" doc:id="ae593540-a467-463f-9aae-fbfb781da0cd" >
          <ee:message >
            <ee:set-payload >
              <![CDATA[%dw 2.0
output application/xml
---
read('<MATMAS01>
              <IDOC BEGIN="1">
                <EDI_DC40 SEGMENT="1">
                  <TABNAM>EDI_DC40</TABNAM>
                  <MANDT>800</MANDT>
                  <DOCNUM>0000000003519646</DOCNUM>
                  <DOCREL>740</DOCREL>
                  <STATUS>30</STATUS>
                  <DIRECT>1</DIRECT>
                  <OUTMOD>2</OUTMOD>
                  <IDOCTYP>MATMAS01</IDOCTYP>
                  <MESTYP>MATMAS</MESTYP>
                  <SNDPOR>SAPIDE</SNDPOR>
                  <SNDPRT>LS</SNDPRT>
                  <SNDPRN>T90CLNT090</SNDPRN>
                  <RCVPOR>MULE01_TP</RCVPOR>
                  <RCVPRT>LS</RCVPRT>
                  <RCVPRN>MULE01_LS</RCVPRN>
                  <CREDAT>20180606</CREDAT>
                  <CRETIM>133420</CRETIM>
                  <SERIAL>20180606133420</SERIAL>
                </EDI_DC40>
              </IDOC>
              </MATMAS01>
',"application/xml") ]]>
              </ee:set-payload>
              </ee:message>
              </ee:transform>
              <sap:send doc:name="Send IDoc" doc:id="9d6b0825-7cfb-4c3b-bc6a-b9eae917af9b" config-ref="SAP_Outbound" key="MATMAS01"/>
              <logger level="INFO" doc:name="Logger" doc:id="8fd50dd8-8db4-4271-863b-ef7a463dcaea" />
            </flow>
            </mule>
```

## Receive an Incoming IDoc Request

This example shows you how to create a Mule app that waits for incoming IDoc requests from an
external SAP system. In this example, the app acts like an RFC server and registers itself as an SAP
gateway. When the app receives an IDoc request, it uses a remote function (RFC) call to ask SAP to
create the IDoc. Then it logs the IDoc contents to the Studio console.

The following screenshot shows the Studio flows for this example:

![Studio flow for retrieving an IDoc](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-example-receive-idoc-flow.png)

### Configure the First Flow

The first flow uses a BAPI function to send IDoc requests to an external SAP system. To configure
this flow:

1.  In Anypoint Studio, create a new Mule project.

2.  From the **Mule Palette** view, select **HTTP** and drag the **Listener** source to the canvas.

3.  Configure the global element using the default values.

4.  In the **Listener** properties tab, set the path to `/trigger`.

5.  Drag a **Transform Message** component next to **Listener**.

    The content of this message is the payload of the BAPI function that receives the IDoc requests.

6.  In the **Output** section of the **Transform Message** component, overlay the brackets with this
    text:

    ```dataweave
    %dw 2.0
    output application/xml
    ---
    {
    	ZMMFM_TRIGGER_IDOC_MATMAS: {
    		"import": {
    	IV_MTYP: "MATMAS"
    ,
    IV_OBJ: "23"
    ,
    IV_SYS: "MULE11_LS"
    }
    ,
    export: {
    	EV_RET: "0"
    },export: {
    	EV_OBJ: "0000000003526552"
    },export: null,changing: null,
    tables: {
    	T_MSG: null
    },
    	}
    }
    ```

7.  From the **Mule Palette** view, select **SAP** and Drag the **Synchronous Remote Function Call**
    operation next to the **Transform Message** component.

8.  Create a global element named `SAP_Config` and specify the connection information.

9.  Click **Test Connection** to confirm that Mule runtime engine can connect with the SAP instance.

### Configure the Second Flow

The second flow logs the contents of each new IDoc request to the Studio console. To configure this
flow:

1.  From the **Mule Palette** view, select **SAP** and drag the **Document listener** source to the
    canvas.

2.  Create a new global element for the source and specify the required information.

    Configure the **Document listener** properties with the following values:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Gateway host</strong></p></td><td><div><div><p>Host running the gateway server</p></div></div></td></tr><tr><td><p><strong>Gateway service</strong></p></td><td><div><div><p><code>3200</code></p></div></div></td></tr><tr><td><p><strong>Program id</strong></p></td><td><div><div><p><code>MULE01_PID</code></p></div></div></td></tr><tr><td><p><strong>Connection count</strong></p></td><td><div><div><p><code>1</code></p></div></div></td></tr><tr><td><p><strong>Idoc type filter regex</strong></p></td><td><div><div><p><code>MATMAS01</code></p></div></div></td></tr></tbody></table>

    > [!NOTE] The **Gateway host**, **Gateway service**, and **Program id** must be retrieved from
    > the customer’s SAP team.
    >
    > Anything that relates to the SAP instance, such as configurations or credentials, must be
    > retrieved from the customer’s SAP team.

3.  From the **Mule Palette** view, select **Core** and drag a **Logger** component next to
    **Document listener** on the canvas.

4.  Click **File** > **Save** to save the app.

### Run the App

To run the Mule app:

1.  Click **Run** > **Run as** > **Mule Application**.

2.  From a web browser, test the application by entering the following URL:

    `http://localhost:8081/trigger`

### XML for Receiving an IDoc Request

Paste this code into a new Mule app in Studio to quickly load the flow for the receiving an IDoc
request example. Change the values to reflect your environment.

```dataweave
%dw 2.0
output application/xml
---
<?xml version="1.0" encoding="UTF-8"?>
            <mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:sap="http://www.mulesoft.org/schema/mule/sap"
	xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/sap http://www.mulesoft.org/schema/mule/sap/current/mule-sap.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
              <http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="75b36b20-040b-401f-a65c-f0a966b51190" >
                <http:listener-connection host="0.0.0.0" port="8081" />
                </http:listener-config>
                <sap:sap-config name="SAP_Config" doc:name="SAP Config" doc:id="1f7e7c6e-4bb5-4270-870f-442cda3e3eb8" >
                  <sap:simple-connection-provider-connection username="User1" password="myPassword" systemNumber="00" client="800" applicationServerHost="sap.test.net" />
                  </sap:sap-config>
                  <flow name="sap-receive-idocFlow1" doc:id="bea8cd17-64d9-4f32-8229-d7eb909e8ee1">
                    <http:listener doc:name="Listener" doc:id="448acc4a-0078-485b-bc10-f70d05abf721" config-ref="HTTP_Listener_config" path="/trigger" />
                    <ee:transform doc:name="Transform Message" doc:id="44124bf5-7caf-4050-a3a6-06cfbd37da48">
                      <ee:message>
                        <ee:set-payload>
                          <![CDATA[%dw 2.0
output application/xml
---
{
	ZMMFM_TRIGGER_IDOC_MATMAS: {
		"import": {
	IV_MTYP: "MATMAS"
,
IV_OBJ: "23"
,
IV_SYS: "MULE11_LS"
}
,
export: {
	EV_RET: "0"
},export: {
	EV_OBJ: "0000000003526552"
},export: null,changing: null,
tables: {
	T_MSG: null
},
	}
}]]>
                          </ee:set-payload>
                          </ee:message>
                          </ee:transform>
                          <sap:sync-rfc doc:name="Synchronous Remote Function Call" doc:id="e420d5e1-c436-471e-aa48-59a7d2cee1b9" key="ZCAFM_TRIGGER_IDOC_BY_MSG_TYPE" config-ref="SAP_Config" />
                        </flow>
                        <flow name="sap-receive-idocFlow2" doc:id="4b070ed0-19ac-4899-82ce-275226b08426" >
                          <sap:document-listener doc:name="Document listener" doc:id="a0d3bf88-1bf1-4210-9cf1-5403f30b2d80" gatewayHost="xxx.com" gatewayService="3200" programID="MULE11_IDOC_PID"  config-ref="SAP_Config"/>
                          <logger level="INFO" doc:name="Logger" doc:id="db7ff63b-31b7-48ab-b0ad-73082f4b66c7" message="#[payload]"/>
                        </flow>
                        </mule>
```

Example response on the Studio console:

```dataweave
<MATMAS01>
                        <IDOC BEGIN="1">
                          <EDI_DC40 SEGMENT="1">
                            <TABNAM>EDI_DC40</TABNAM>
                            <MANDT>800</MANDT>
                            <DOCNUM>0000000003572826</DOCNUM>
                            <DOCREL>740</DOCREL>
                            <STATUS>30</STATUS>
                            <DIRECT>1</DIRECT>
                            <OUTMOD>2</OUTMOD>
                            <IDOCTYP>MATMAS01</IDOCTYP>
                            <MESTYP>MATMAS</MESTYP>
                            <SNDPOR>SAPIDE</SNDPOR>
                            <SNDPRT>LS</SNDPRT>
                            <SNDPRN>T90CLNT090</SNDPRN>
                            <RCVPOR>MULE11_TP</RCVPOR>
                            <RCVPRT>LS</RCVPRT>
                            <RCVPRN>MULE11_LS</RCVPRN>
                            <CREDAT>20191004</CREDAT>
                            <CRETIM>050305</CRETIM>
                            <SERIAL>20191004050305</SERIAL>
                            </EDI_DC40>
 		...
```

## Receive an SAP Function

This example shows you how to create a Mule app that receives an SAP function. This example displays
a result when a function is triggered from either another Mule flow or from the SAP GUI. The
following screenshot shows the Studio flow for this example:

![Studio flow for establishing an SAP connection](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-example-establish-connection.png)

To create the flow:

1.  From the Mule Palette view, select **SAP** and drag the **Function listener** source to the
    canvas.

2.  Create a global element named `SAP_Inbound` and specify the connection information.

3.  Configure the required fields in the properties tab.

4.  From the **Mule Palette** view, select **Core** and drag the **Transform Message** component to
    the right of **Function listener**.

5.  Specify the details based on the metadata. For example:

    ![Sample metadata for the SAP\_Inbound global element](/mulesoft/current/en-us/sap-connector/latest/_images/sap-function-return-response.png)

6.  Click **File > Save** to save the app.

7.  Click **Run** > **Run as** > **Mule Application**.

### XML for Receiving an SAP Function

Paste this code into a new Mule app in Studio to quickly load the flow for the receiving a function
example. Change the values to reflect your environment.

```dataweave
%dw 2.0
output application/xml
---

<?xml version="1.0" encoding="UTF-8"?>
                            <mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:sap="http://www.mulesoft.org/schema/mule/sap"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/sap http://www.mulesoft.org/schema/mule/sap/current/mule-sap.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
                              <sap:sap-config name="SAP_Inbound" doc:name="SAP Config" doc:id="9eb4758e-4eb4-4291-9604-84586dda5cd3" >
                                <sap:simple-connection-provider-connection username="User1" password="Password" systemNumber="00" client="800" applicationServerHost="sapdev.muletest.net" />
                                </sap:sap-config>
                                <flow name="receive-a-functionFlow" doc:id="5104aaba-944d-4b8b-ba35-fc210e1f2c4e" >
                                  <sap:function-listener doc:name="Function listener" doc:id="58ee92ea-967f-4a9c-a14d-164032b1b8ee" config-ref="SAP_Inbound" gatewayHost="gateway.host.com" gatewayService="3200" programID="MULE01_API_PID"/>
                                  <ee:transform doc:name="Transform Message" doc:id="59b4c48f-40ca-4587-80e3-f06d895e1c5b" >
                                    <ee:message >
                                      <ee:set-payload >
                                        <![CDATA[%dw 2.0
output application/java
---
{
}]]>
                                        </ee:set-payload>
                                        </ee:message>
                                        </ee:transform>
                                      </flow>
                                      </mule>
```

## Manage Transactions

This example performs two calls on standard BAPIs that handle bank records and manages those
transactions.

The following screenshots show the Studio flows for this example:

![Studio flow for the first flow of Managing Transactions](/mulesoft/current/en-us/sap-connector/latest/_images/managetransactions-flow1.png)

![Studio flow for the second flow of Managing Transactions](/mulesoft/current/en-us/sap-connector/latest/_images/managetransactions-flow2.png)

![Studio flow for the third flow of Managing Transactions](/mulesoft/current/en-us/sap-connector/latest/_images/managetransactions-flow3.png)

### Configure the First Flow

The first flow retrieves a list of available banks in the United States, filters the first result,
and fetches information about the bank. Transactions are not necessary for queries to SAP. To
configure this flow:

1.  In Anypoint Studio, create a new Mule project.

2.  From the **Mule Palette** view, select **HTTP** and drag the **Listener** source to the canvas.

3.  Configure the global element using the default values.

4.  In the **Listener** properties tab, set the path to `/sync-rfc`.

5.  Drag a **Transform Message** component next to **Listener**.

    The content of this message filters the banks by country.

6.  In the **Output** section of the **Transform Message** component, overlay the brackets with this
    text:

    %dw 2.0 output application/xml
    ---

    { BAPI\_BANK\_GETLIST: { "import": { BANK\_CTRY: "US", MAX\_ROWS: 0 } } }

7.  From the **Mule Palette** view, select **SAP** and drag the **Synchronous Remote Function Call**
    operation next to the **Transform Message** component.

8.  Create a global element named `SAP_Config` and specify the connection information.

9.  Click **Test Connection** to confirm that Mule runtime engine can connect with the SAP instance.

10. Enter `BAPI_BANK_GETLIST` for the **Function Name** and `payload` for the **Content**.

11. Drag another **Transform Message** component next to **Synchronous Remote Function Call**.

    The content of this message filters the first result.

12. In the **Output** section of the **Transform Message** component, overlay the brackets with this
    text:

    %dw 2.0 output application/xml
    ---

    { BAPI\_BANK\_GETDETAIL: { "import" : { BANKCOUNTRY:
    payload.BAPI\_BANK\_GETLIST.tables.BANK\_LIST.\*row\[0\].BANK\_CTRY, BANKKEY:
    payload.BAPI\_BANK\_GETLIST.tables.BANK\_LIST.\*row\[0\].BANK\_KEY } } }

13. From the **Mule Palette** view, select **SAP** and drag another **Synchronous Remote Function
    Call** operation next to the **Transform Message** component.

14. Create a global element named `SAP_Config` and specify the connection information.

15. Click **Test Connection** to confirm that Mule runtime engine can connect with the SAP instance.

16. Enter `"BAPI_BANK_GETDETAIL"` for the **Function Name** and `payload` for the **Content**.

17. From the **Mule Palette** view, select **Core** and drag a **Logger** component next to
    **Synchronous Remote Function Call**.

### Configure the Second Flow

The second flow creates a sales order from the data. You must add `try` to the BAPI call to create a
transaction, otherwise the change does not impact SAP. To configure this flow:

1.  From the **Mule Palette** view, select **HTTP** and drag the **Listener** source to the canvas.

2.  Configure the global element using the default values.

3.  In the **Listener** properties tab, set the path to `/sync-mule-transaction`.

4.  Drag a **Transform Message** component next to **Listener**.

    The content of this message creates a sales order from the data.

5.  In the **Output** section of the **Transform Message** component, overlay the brackets with this
    text:

    %dw 2.0 output application/xml
    ---

    { BAPI\_SALESORDER\_CREATEFROMDAT2: { "import": { ORDER\_HEADER\_IN: { DOC\_TYPE: "TA",
    SALES\_ORG: "3000", DISTR\_CHAN: "10", DIVISION: "00" }, ORDER\_HEADER\_INX: { DOC\_TYPE: "X",
    SALES\_ORG: "X", DISTR\_CHAN: "X", DIVISION: "X" } }, tables: { ORDER\_ITEMS\_IN: { row: {
    ITM\_NUMBER: "000010", MATERIAL: "000000000050066128" as Number as String {format:
    "000000000000000000"}, PLANT: "3000", TARGET\_QTY: "1" } }, ORDER\_ITEMS\_INX: { row: {
    ITM\_NUMBER: "000010", MATERIAL: "X", PLANT: "X", TARGET\_QTY: "X" } }, ORDER\_PARTNERS: { row:
    { PARTN\_ROLE: "WE", PARTN\_NUMB: "0000000448" } }, ORDER\_SCHEDULES\_IN: { row: { ITM\_NUMBER:
    "000010", SCHED\_LINE: "0001", REQ\_QTY: "1" } }, ORDER\_SCHEDULES\_INX: { row: { ITM\_NUMBER:
    "000010", SCHED\_LINE: "0001", REQ\_QTY: "X" } } } } }

6.  From the **Mule Palette** view, select **SAP** and drag the **Synchronous Remote Function Call**
    operation next to the **Transform Message** component.

7.  Create a global element named `SAP_Config` and specify the connection information.

8.  Click **Test Connection** to confirm that Mule runtime engine can connect with the SAP instance.

9.  Enter `BAPI_SALESORDER_CREATEFROMDAT2` for the **Function Name** and `payload` for the
    **Content**.

10. From the **Mule Palette** view, select **Core** and drag **On Error Continue** under
    **Synchronous Remote Function Call**.

11. From the **Mule Palette** view, select **Core** and drag a **Logger** component into **On Error
    Continue**.

12. From the **Mule Palette** view, select **Core** and drag another **Logger** component next to
    **Synchronous Remote Function Call**.

13. Enter `payload.BAPI_SALESORDER_CREATEFROMDAT2.export.SALESDOCUMENT` for the **Message**.

### Configure the Third Flow

The third flow creates a transaction ID and gets a list. Asynchronous calls do not expect a response
and require a different way of managing the transaction. Use specific operations to manage
transactions of asynchronous calls. To configure this flow:

1.  From the **Mule Palette** view, select **HTTP** and drag the **Listener** source to the canvas.

2.  Configure the global element using the default values.

3.  In the **Listener** properties tab, set the path to `/async-rfc`.

4.  From the **Mule Palette** view, select **SAP** and drag the **Start SAP transaction** operation
    next to **Listener**.

5.  Create a global element named `SAP_Config` and specify the connection information.

6.  Click **Test Connection** to confirm that Mule runtime engine can connect with the SAP instance.

7.  From the **Mule Palette** view, select **Core** and drag a **Set Variable** transformer next to
    **Start SAP transaction**.

8.  Enter `createdTransactionId` for the **Name** and `payload` for the **Value**.

9.  Drag a **Transform Message** component next to **Set Variable**.

    The content of this message gets a list of banks.

10. In the **Output** section of the **Transform Message** component, overlay the brackets with this
    text:

    %dw 2.0 output application/xml
    ---

    %dw 2.0 output application/xml
    ---

    { BAPI\_BANK\_GETLIST: { "import": { BANK\_CTRY: "US", MAX\_ROWS: 0 } } }

11. From the **Mule Palette** view, select **SAP** and drag the **Asynchronous Remote Function
    Call** operation next to **Transform Message**.

12. Create a global element named `SAP_Config` and specify the connection information.

13. Click **Test Connection** to confirm that Mule runtime engine can connect with the SAP instance.

14. Enter `"BAPI_BANK_GETLIST"` for the **Function Name** and `payload` for the **Content**.

15. From the **Mule Palette** view, select **SAP** and drag the **Confirm transaction** operation
    next to **Asynchronous Remote Function Call**.

16. Create a global element named `SAP_Config` and specify the connection information.

17. Click **Test Connection** to confirm that Mule runtime engine can connect with the SAP instance.

18. Enter `vars.createdTransactionId` for the **Transaction ID (TID)**.

### Run the App

To run the Mule app:

1.  Click **Run** > **Run as** > **Mule Application**.

2.  From a web browser, test the first flow by entering the following URL:

    `http://localhost:8081/sync-rfc`

    You should see the XML output of the request, similar to the following:

    ```dataweave
    <BAPI_BANK_GETDETAIL>
        <import>
            <BANKCOUNTRY>US</BANKCOUNTRY>
            <BANKKEY>021000089</BANKKEY>
        </import>
        <export>
            <BANK_ADDRESS>
                <BANK_NAME>Citibank</BANK_NAME>
                <REGION>NY</REGION>
                <STREET>Park Avenue</STREET>
                <CITY>New York</CITY>
                <SWIFT_CODE>CITIUSXX</SWIFT_CODE>
                <BANK_GROUP/>
                <POBK_CURAC/>
                <BANK_NO>021000089</BANK_NO>
                <POST_BANK/>
                <BANK_BRANCH>Manhattan</BANK_BRANCH>
                <ADDR_NO/>
            </BANK_ADDRESS>
            <BANK_DETAIL>
            <CREAT_DATE>2005-03-11</CREAT_DATE>
            <CREATOR>C5031845</CREATOR>
            <METHOD/>
            <FORMATTING/>
            <BANK_DELETE/>
            <IBAN_RULE/>
            <B2B_SUPPORTED>0</B2B_SUPPORTED>
            <COR1_SUPPORTED>0</COR1_SUPPORTED>
            <R_TRANSACTION_SUPPORTED>0</R_TRANSACTION_SUPPORTED>
            </BANK_DETAIL>
            <RETURN>
                <TYPE/>
                <ID/>
                <NUMBER>000</NUMBER>
                <MESSAGE/>
                <LOG_NO/>
                <LOG_MSG_NO>000000</LOG_MSG_NO>
                <MESSAGE_V1/>
                <MESSAGE_V2/>
                <MESSAGE_V3/>
                <MESSAGE_V4/>
                <PARAMETER/>
                <ROW>0</ROW>
                <FIELD/>
                <SYSTEM/>
            </RETURN>
        </export>
    </BAPI_BANK_GETDETAIL>
    ```

3.  From a web browser, test the second flow by entering the following URL:

    `http://localhost:8081/sync-mule-transaction`

    You should see the XML output of the request, similar to the following:

    ```dataweave
    <BAPI_SALESORDER_CREATEFROMDAT2>
        <import>
        <BEHAVE_WHEN_ERROR/>
        <BINARY_RELATIONSHIPTYPE/>
        <CONVERT/>
        <INT_NUMBER_ASSIGNMENT/>
        <LOGIC_SWITCH>
        <PRICING/>
        <ATP_WRKMOD/>
        <SCHEDULING/>
        <NOSTRUCTURE/>
        <COND_HANDL/>
        <ADDR_CHECK/>
        </LOGIC_SWITCH>
        <ORDER_HEADER_IN>
        <REFOBJTYPE/>
        <REFOBJKEY/>
        <REFDOCTYPE/>
        <DOC_TYPE>TA</DOC_TYPE>
        <COLLECT_NO/>
        <SALES_ORG>3000</SALES_ORG>
        <DISTR_CHAN>10</DISTR_CHAN>
        <DIVISION>00</DIVISION>
        <SALES_GRP/>
        <SALES_OFF/>
        <REQ_DATE_H/>
        ....................

        <row id="2">
        <TYPE>S</TYPE>
        <ID>V1</ID>
        <NUMBER>311</NUMBER>
        <MESSAGE>Standard Order 23669 has been saved</MESSAGE>
        <LOG_NO/>
        <LOG_MSG_NO>000000</LOG_MSG_NO>
        <MESSAGE_V1>Standard Order</MESSAGE_V1>
        <MESSAGE_V2>23669</MESSAGE_V2>
        <MESSAGE_V3/>
        <MESSAGE_V4/>
        <PARAMETER>SALES_HEADER_IN</PARAMETER>
        <ROW>0</ROW>
        <FIELD/>
        <SYSTEM>T90CLNT090</SYSTEM>
        </row>
        </RETURN>
        </tables>
    </BAPI_SALESORDER_CREATEFROMDAT2>
    ```

4.  From a web browser, test the third flow by entering the following URL:

    `http://localhost:8081/async-rfc`

    You should see the XML output of the request, similar to the following:

    ```dataweave
    <BAPI_BANK_GETLIST>
        <import>
            <BANK_CTRY>US</BANK_CTRY>
            <MAX_ROWS>0</MAX_ROWS>
        </import>
    </BAPI_BANK_GETLIST>
    ```

### XML for Managing Transactions

Paste this code into a new Mule app in Studio to quickly load the flow for the managing transactions
example. Change the values to reflect your environment.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:sap="http://www.mulesoft.org/schema/mule/sap" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/sap http://www.mulesoft.org/schema/mule/sap/current/mule-sap.xsd">
	<configuration-properties file="mule-artifact.properties"/>
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="b89c52ef-8c07-4788-b87e-4c698d718341" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	  <sap:sap-config name="SAP_Config" doc:name="SAP Config" doc:id="90c5a950-aefd-4fba-9e28-db3fa29767bb">
        <sap:simple-connection-provider-connection username="${sap.jcoUser}" password="${sap.jcoPasswd}"
                                                   systemNumber="${sap.jcoSysnr}" client="${sap.jcoClient}"
                                                   applicationServerHost="${sap.jcoAsHost}"/>
    </sap:sap-config>
	<flow name="bapi-srfc" doc:id="26ade074-48b4-47bb-a8e9-ca040034dee6" >
		<http:listener doc:name="Listener" doc:id="16a60ec9-f1c9-4a07-9a02-e7fcbb185a12" config-ref="HTTP_Listener_config" path="/sync-rfc"/>
				<ee:transform doc:name="Filter by country" doc:id="f285db36-da88-4e96-b7e6-c92acf4a8e5b" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/xml
---
{
	BAPI_BANK_GETLIST: {
		"import": {
			BANK_CTRY: "US",
			MAX_ROWS: 0
		}
	}
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<sap:sync-rfc doc:name="Synchronous Remote Function Call" doc:id="cd5a8815-c5be-4bcc-aaf5-77c90090d124" config-ref="SAP_Config" key="BAPI_BANK_GETLIST"/>
		<ee:transform doc:name="Filter first result" doc:id="55eecae1-4e9a-4e5b-93f2-1633bf14dbc9" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/xml
---
{
	BAPI_BANK_GETDETAIL: {
		"import" : {
			BANKCOUNTRY: payload.BAPI_BANK_GETLIST.tables.BANK_LIST.*row[0].BANK_CTRY,
			BANKKEY: payload.BAPI_BANK_GETLIST.tables.BANK_LIST.*row[0].BANK_KEY
		}
	}
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<sap:sync-rfc doc:name="Synchronous Remote Function Call" doc:id="10404fb9-f887-4cea-9a64-32f8559814d2" config-ref="SAP_Config" key='#["BAPI_BANK_GETDETAIL"]'/>
		<logger level="INFO" doc:name="Logger" doc:id="f65b06a8-ff33-4906-9bd0-6c3895e5e0cf" message="#[payload]"/>
		</flow>
		<flow name="bapi-mule-transaction" doc:id="f47687b3-6e2b-4c22-b4b1-900f9ac5a078" >
		<http:listener doc:name="Listener" doc:id="c16d6ef3-4601-4260-b82f-37f35540fdd3" config-ref="HTTP_Listener_config" path="/sync-mule-transaction"/>
		<ee:transform doc:name="Transform Message" doc:id="5b07e4f5-12bb-4ed2-941f-599789e5e04f">
			<ee:message>
				<ee:set-payload><![CDATA[%dw 2.0
output application/xml
---
{
	BAPI_SALESORDER_CREATEFROMDAT2: {
		"import": {
			ORDER_HEADER_IN: {
				DOC_TYPE: "TA",
				SALES_ORG: "3000",
				DISTR_CHAN: "10",
				DIVISION: "00"
			},
			ORDER_HEADER_INX: {
				DOC_TYPE: "X",
				SALES_ORG: "X",
				DISTR_CHAN: "X",
				DIVISION: "X"
			}
		},
		tables: {
			ORDER_ITEMS_IN: {
				row: {
					ITM_NUMBER: "000010",
					MATERIAL: "000000000050066128" as Number as String {format: "000000000000000000"},
					PLANT: "3000",
					TARGET_QTY: "1"
				}
			},
			ORDER_ITEMS_INX: {
				row: {
					ITM_NUMBER: "000010",
					MATERIAL: "X",
					PLANT: "X",
					TARGET_QTY: "X"
				}
			},
			ORDER_PARTNERS: {
				row: {
					PARTN_ROLE: "WE",
					PARTN_NUMB: "0000000448"
				}
			},
			ORDER_SCHEDULES_IN: {
				row: {
					ITM_NUMBER: "000010",
					SCHED_LINE: "0001",
					REQ_QTY: "1"
				}
			},
			ORDER_SCHEDULES_INX: {
				row: {
					ITM_NUMBER: "000010",
					SCHED_LINE: "0001",
					REQ_QTY: "X"
				}
			}
		}
	}
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<try doc:name="Try" doc:id="a5e37154-87b2-495a-9576-509d21d2d234" transactionalAction="ALWAYS_BEGIN">
			<sap:sync-rfc doc:name="Synchronous Remote Function Call" doc:id="8af8b804-57d2-4b44-a0d2-7a50d7018573" config-ref="SAP_Config" key="BAPI_SALESORDER_CREATEFROMDAT2"/>
			<error-handler>
				<on-error-continue enableNotifications="true" logException="true" doc:name="On Error Continue" doc:id="144141a8-7941-41f3-837b-40a2e25905be">
					<logger level="INFO" doc:name="Logger" doc:id="50a3d4c1-1a01-4a8b-ac9d-cdb354ec8ddb" message="Bapi Error" />
				</on-error-continue>
			</error-handler>
		</try>
		<logger level="INFO" doc:name="Logger" doc:id="36097fa1-0a5d-44fc-9432-b0ef048a85c7" message="#[payload.BAPI_SALESORDER_CREATEFROMDAT2.export.SALESDOCUMENT]"/>
	</flow>
	<flow name="async-rfc" doc:id="ba757987-1e8c-47d5-8168-23043948ae8f" >
		<http:listener doc:name="Listener" doc:id="ee6d3bf1-3474-4d38-80f9-2651f374d876" config-ref="HTTP_Listener_config" path="/async-rfc"/>
		<sap:create-transaction-id doc:name="Start SAP transaction" doc:id="3bfd77a6-3397-45cb-b9c6-6450f3f010c8" config-ref="SAP_Config"/>
		<set-variable value="#[payload]" doc:name="Set Variable" doc:id="a20de9fb-61ec-4d90-8da7-fee910da7d49" variableName="createdTransactionId"/>
		<ee:transform doc:name="Transform Message" doc:id="7c000a34-c035-470b-8ff3-546e8156ece4" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/xml
---
{
	BAPI_BANK_GETLIST: {
		"import": {
			BANK_CTRY: "US",
			MAX_ROWS: 0
		}
	}
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<sap:async-rfc doc:name="Asynchronous Remote Function Call" doc:id="a45ec861-be1b-4c16-8d3e-ef83dab24cea" config-ref="SAP_Config" key='#["BAPI_BANK_GETLIST"]' transactionId="#[vars.createdTransactionId]"/>
		<sap:confirm-transaction-id doc:name="Confirm transaction" doc:id="939e882d-9416-40c0-8b5d-85871e264aa6" config-ref="SAP_Config" transactionId="#[vars.createdTransactionId]"/>
	</flow>
</mule>
```

## Configure Multiple Gateways

This example shows you how to create a Mule app that configures a message server with multiple
gateway connections to distribute the load and improve performance, instead of a single gateway
connection.

The message server configuration can be used for all SAP Connector operations, including **Document
Listener**, **Function Listener**, and operations such as **Synchronous Remote Function Call** and
**Send IDoc**.

The following screenshot shows the Studio flows for this example:

![Studio flows for configuring a message server with multiple gateways](/mulesoft/current/en-us/sap-connector/latest/_images/sap-multiple-gateways.png)

### Configure the First Flow

The first flow uses the message server configuration with the **Document listener** source. To
configure this flow:

1.  In Anypoint Studio, create a new Mule project.

2.  From the **Mule Palette** view, select **SAP** and drag the **Document listener** source to the
    canvas.

3.  Configure the SAP Connector configuration for the **Document listener** source:

    1.  In the connection configuration, select either **Certificate**, **Kerberos**, or **Simple
        Connection Provider** as the connection type.

    2.  Fill in the required fields such as **SAP client ID**, **Username** and **Password** (for
        Simple Connection Provider), or the appropriate authentication fields for your connection
        type.

    3.  Configure the **Message server configuration** section with the following fields:

        1.  **Host**: The host of the message server (for example, `54.160.77.19`)

        2.  **System Id**: The system ID of the SAP system

        3.  **Port**: The port with which the connector logs into the message server

        4.  **Group**: The group of SAP application servers

    4.  Note: When using **Message server configuration**, the **SAP system number** field is not
        required. When using **Application server host**, the **SAP system number** field is
        required.

4.  In the **Document listener** properties tab, configure the following fields:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Gateway host</strong></p></td><td><div><div><p><code>54.160.77.19</code></p></div></div></td></tr><tr><td><p><strong>Gateway service</strong></p></td><td><div><div><p><code>3300</code></p></div></div></td></tr><tr><td><p><strong>Program id</strong></p></td><td><div><div><p><code>MULE11_IDOC_PID</code></p></div></div></td></tr><tr><td><p><strong>Connection count</strong></p></td><td><div><div><p><code>1</code></p></div></div></td></tr></tbody></table>

5.  From the **Mule Palette** view, select **Core** and drag a **Logger** component next to
    **Document listener** on the canvas.

### Configure the Second Flow

The second flow triggers the first individual gateway. To configure this flow:

1.  From the **Mule Palette** view, drag the **HTTP > Listener** source to the canvas.

2.  Configure the global element using the default values.

3.  In the **Listener** properties tab, set the path to `/c`.

4.  From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
    next to the **Listener** source.

5.  In the **Output** section of the **Transform Message** component, overlay the brackets with this
    text:

    %dw 2.0 output application/xml
    ---

    { ZMMFM\_TRIGGER\_IDOC\_MATMAS: { "import": { IV\_MTYP: "MATMAS" , IV\_OBJ: "23" , IV\_SYS:
    "MULE11\_LS" } , export: { EV\_RET: "0" },export: { EV\_OBJ: "0000000003526552" },export:
    null,changing: null, tables: { T\_MSG: null }, } }

6.  From the **Mule Palette** view, select **SAP** and drag the **Synchronous Remote Function Call**
    operation to the canvas.

7.  Configure the global element for the **Synchronous Remote Function Call** operation and fill in
    the required fields.

8.  In the **Synchronous Remote Function Call** properties tab, configure the following fields:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Function Name</strong></p></td><td><div><div><p><code>"ZMMFM_TRIGGER_IDOC_MATMAS"</code></p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p><code>payload</code></p></div></div></td></tr></tbody></table>

9.  From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
    next to the **Synchronous Remote Function Call** operation.

10. In the **Output** section of the **Transform Message** component, overlay the brackets with this
    text:

    %dw 2.0 output application/json
    ---

    payload

### Configure the Third Flow

The third flow triggers the second individual gateway. To configure this flow:

1.  From the **Mule Palette** view, drag the **HTTP > Listener** source to the canvas.

2.  Configure the global element using the default values.

3.  In the **Listener** properties tab, set the path to `/d`.

4.  From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
    next to the **Listener** source.

5.  In the **Output** section of the **Transform Message** component, overlay the brackets with this
    text:

    %dw 2.0 output application/xml
    ---

    { ZMMFM\_TRIGGER\_IDOC\_MATMAS: { "import": { IV\_MTYP: "MATMAS" , IV\_OBJ: "23" , IV\_SYS:
    "MULE11\_LS" } , export: { EV\_RET: "0" },export: { EV\_OBJ: "0000000003526552" },export:
    null,changing: null, tables: { T\_MSG: null }, } }

6.  From the **Mule Palette** view, select **SAP** and drag the **Synchronous Remote Function Call**
    operation to the canvas.

7.  Configure the global element for the **Synchronous Remote Function Call** operation and fill in
    the required fields.

8.  In the **Synchronous Remote Function Call** properties tab, configure the following fields:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Function Name</strong></p></td><td><div><div><p><code>"ZMMFM_TRIGGER_IDOC_MATMAS"</code></p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p><code>payload</code></p></div></div></td></tr></tbody></table>

9.  From the **Mule Palette** view, select **Core** and drag the **Transform Message** component
    next to the **Synchronous Remote Function Call** operation.

10. In the **Output** section of the **Transform Message** component, overlay the brackets with this
    text:

    %dw 2.0 output application/json
    ---

    payload

### Run the App

To run the Mule app:

1.  Click **Run** > **Run as** > **Mule Application**.

### XML for Configuring Multiple Gateways

Paste this code into a new Mule app in Studio to quickly load the flow for the configuring multiple
gateways example. Change the values to reflect your environment.

```dataweave
<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:sap="http://www.mulesoft.org/schema/mule/sap" xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/sap http://www.mulesoft.org/schema/mule/sap/current/mule-sap.xsd">
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="5d46abaa-dc40-457b-a7df-ce54fc8f3a43" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<sap:sap-config name="SAP_Config_C" doc:name="SAP Config" doc:id="78a4da95-2381-4bd1-919c-fc86ae23c134" >
		<sap:simple-connection-provider-connection systemNumber="02" client="800" applicationServerHost="34.225.79.228" />
	</sap:sap-config>
	<sap:sap-config name="SAP_Config_D" doc:name="SAP Config" doc:id="0f026b1e-96f8-4ef8-ae46-f4677b1f95ae" >
		<sap:simple-connection-provider-connection systemNumber="03" client="800" applicationServerHost="44.214.23.92" />
	</sap:sap-config>
	<sap:sap-config name="SAP_Config_B" doc:name="SAP Config" doc:id="829dbb29-682b-443d-b85c-47ad20d7c134" >
		<sap:simple-connection-provider-connection systemNumber="00" client="800" applicationServerHost="54.160.77.19"/>
	</sap:sap-config>
	<flow name="sapgatewaytestFlow" doc:id="2f660909-8fef-4872-85d0-efd172ac47fe" >
		<sap:document-listener doc:name="Document listener" doc:id="36de92d6-8796-46f6-b280-ac288a57b343" config-ref="SAP_Config_B" gatewayHost="54.160.77.19" gatewayService="3300" programID="MULE11_IDOC_PID"/>
		<logger level="INFO" doc:name="Logger" doc:id="51941f3f-a26e-4f60-99bf-637ce7f39e12" message="#[payload]"/>
	</flow>
	<flow name="sapgatewaytestFlowC" doc:id="4be0cd2f-197c-4cd2-afa5-5833b42399d2" >
		<http:listener doc:name="Listener" doc:id="3561b7af-6a02-4497-b02a-09e5dcc71f46" config-ref="HTTP_Listener_config" path="/c"/>
		<ee:transform doc:name="Transform Message" doc:id="71afc270-fc02-4fd8-bf82-a97a3eac86ac" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/xml
---
{
  ZMMFM_TRIGGER_IDOC_MATMAS: {
    "import": {
  IV_MTYP: "MATMAS"
,
IV_OBJ: "23"
,
IV_SYS: "MULE11_LS"
}
,
export: {
  EV_RET: "0"
},export: {
  EV_OBJ: "0000000003526552"
},export: null,changing: null,
tables: {
  T_MSG: null
},
  }
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<sap:sync-rfc doc:name="Synchronous Remote Function Call" doc:id="d3b152e0-db3a-4745-a9fe-60cc6ade0581" config-ref="SAP_Config_C" key='#["ZMMFM_TRIGGER_IDOC_MATMAS"]'/>
		<ee:transform doc:name="Transform Message" doc:id="387d00c7-efbf-4675-9f50-5fbafe592ec0" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
	<flow name="sapgatewaytestFlowD" doc:id="3b2c4526-74e7-4a21-b18a-f11ba2f86beb" >
		<http:listener doc:name="Listener" doc:id="fa1567ab-1ded-415e-8dd2-8a0833451176" config-ref="HTTP_Listener_config" path="/d"/>
		<ee:transform doc:name="Transform Message" doc:id="b71d390e-5de2-435d-b0b0-51efb6f70b60" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/xml
---
{
  ZMMFM_TRIGGER_IDOC_MATMAS: {
    "import": {
  IV_MTYP: "MATMAS"
,
IV_OBJ: "23"
,
IV_SYS: "MULE11_LS"
}
,
export: {
  EV_RET: "0"
},export: {
  EV_OBJ: "0000000003526552"
},export: null,changing: null,
tables: {
  T_MSG: null
},
  }
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<sap:sync-rfc doc:name="Synchronous Remote Function Call" doc:id="edfae6dd-edc3-4e56-8a26-d3ad1b51db04" config-ref="SAP_Config_D" key='#["ZMMFM_TRIGGER_IDOC_MATMAS"]'/>
		<ee:transform doc:name="Transform Message" doc:id="fd6eb7f2-0c9f-43c6-842d-02be2216620a" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=f5b91c556f5e0783095a711ff01b1d49c12d3d1b711ea143e678d92f26376441 url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-reference.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# SAP Connector 5.9 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for SAP (SAP Connector) enables the integration of data to and from external
systems based on SAP NetWeaver.

> [!NOTE] Starting with version 5.0, SAP Connector also supports connecting to an on-premises
> instance of SAP S/4HANA.

## Limitations

- For SAP Connector versions 5.4.0 and earlier, multiple servers deployed on the same Mule runtime
  engine with the same PROGRAM\_ID, GATEWAY\_SERVICE, and GATEWAY\_HOST cannot be created by the JCo
  library. If you attempt to create two servers with the same PROGRAM\_ID, GATEWAY\_SERVICE, and
  GATEWAY\_HOST, only one server is created. To work around this, you can use two different Mule
  runtime engines or use the same PROGRAM\_ID with two different GATEWAY\_HOSTs.

- SAP Connector does not support Bitronix Transaction Manager.

- The **Document Listener** and **Function Listener** sources do not support Mule transactions.
  Although the **Transactional action** and **Transaction type** parameters (on the **Advanced
  tab**) are available for both sources, the transactional feature is not implemented.

- The reconnection strategy on SAP Listeners (**Document Listener** and **Function Listener**)
  relies exclusively on the JCo library, which means that the Mule reconnection mechanism has no
  impact on reconnections.

- The JCO Server that runs in the background manages the reconnection when there is a connection
  issue. The JCo RFC provider recognizes a communication error between the Java server and the ABAP
  gateway and attempts to reconnect. If the first reconnection fails, the next reconnection attempt
  occurs after waiting for one second. If the reconnection fails again, the reconnection wait time
  doubles from one second to two seconds, until eventually it reaches the default maximum waiting
  period of 3600 seconds, or one hour. Set the maximum reconnection timeout using the
  `-Djco.server.max_startup_delay=<reconnect delay in seconds>` JMV parameter.

- The `XSTRING` data format in SAP is a binary blop format. To submit values in an `XSTRING` field,
  you must use the [toHex](https://docs.mulesoft.com/dataweave/latest/dw-numbers-functions-tohex) function to base-32
  encode the binary within the XML submitted to the RFC step.

## Configuration

Default Configuration for SAP Connector.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#sap_certificate">Certificate</a></p></li><li><p><a href="#sap_kerberos">Kerberos</a></p></li><li><p><a href="#sap_simple-connection-provider">Simple Connection Provider</a></p></li></ul></div></div></td><td><div><div><p>Connection types for this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Default Idocument Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Default IDoc version.</p></div></div></td><td><div><div><p><code>0</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Jco Internal Cache</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Flag that indicates whether to use the JCo internal cache. Set this flag to <code>true</code> to disable the SAP JCo internal cache. By default, JCo stores the metadata after the first call and populates that template in the following calls. This flag applies to both functions and sources.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Evaluate Response Flag</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Flag that indicates if an error response throws an exception or enables the user to handle it as another result. This flag is an exception or logging mechanism used to specify whether a message throws an exception (E) or is treated as a result with a warning (W).</p></div><div><p>If you set the flag to <code>true</code> and an exception (E) message is returned, an exception is thrown with that message.</p></div><div><p>If you set the flag to <code>true</code> and a warning (W) message is returned, a warning message is logged.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Log Trace Flag</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Flag that indicates whether to log the trace on the Mule server. Set this flag to <code>true</code> to log a trace.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Use SAP Format</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to support the legacy format for returning SAP values. Used in the <code>JCoToBusinessObjectParser</code> class when parsing a <code>JCoField</code>. Use the SAP default format only when working with BAPIFunctions over sRFC.</p></div><div><ul><li><p><code>true</code></p><div><p>Values are returned as strings with the original SAP format.</p></div></li><li><p><code>false</code></p><div><p>Original values are converted to the corresponding Java objects, serialized, and returned.</p></div></li></ul></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Use SAP Format On Function Listener</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to support the legacy format for returning SAP values. Used to parse a <code>JCoField</code>. Use the SAP default format only when working with the BAPI function listener.</p></div><div><ul><li><p><code>true</code></p><div><p>Values are returned as strings with the original SAP format.</p></div></li><li><p><code>false</code></p><div><p>Original values are converted to the corresponding Java objects, serialized, and returned.</p></div></li></ul></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr></tbody></table>

### Certificate Connection Type

Relies on an X509 certificate to authenticate the user.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>SAP system number</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Two-digit system number (sysnr) of the SAP system. Required when using <strong>Application server host</strong>. Not required when using <strong>Message server configuration</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SAP client ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Three-digit client number. Leading zeros are preserved if they appear in the number.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Destination Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Identifier of the destination generated by this connector. If none is set, a random value is created.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Login language</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Language code used by the connector. The language determines the code page used for communicating between the SAP adapter and the application server.</p></div></div></td><td><div><div><p><code>EN</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Extended Properties</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Used to pass in all the database server-specific connection parameters.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>X.509 Certificate</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the X.509 certificate. This is required when the connector is working as a client.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Application server host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host of the SAP application server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message server configuration</strong></p></td><td><div><div><p><a href="#MessageServer">Message Server</a></p></div></div></td><td><div><div><p>Configuration for message server usage.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable RFC tracing on server</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enables or disables RFC trace on the server.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable CPIC tracing on server</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INHERIT</p></li><li><p>NO_TRACING</p></li><li><p>LEVEL_1</p></li><li><p>LEVEL_2</p></li><li><p>LEVEL_3</p></li></ul></div></div></td><td><div><div><p>Enables or disables CPIC trace on the server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Kerberos Connection Type

Implements the Kerberos protocol to authenticate and authorize the user.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>SAP system number</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Two-digit system number (sysnr) of the SAP system. Required when using <strong>Application server host</strong>. Not required when using <strong>Message server configuration</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SAP client ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Three-digit client number. Leading zeros are preserved if they appear in the number.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Destination Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Identifier of the destination generated by this connector. If none is set, a random value is created.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Login language</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Language code used by the connector. The language determines the code page used for communicating between the SAP adapter and the application server.</p></div></div></td><td><div><div><p><code>EN</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Extended Properties</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Used to pass in all the database server-specific connection parameters.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Application server host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host of the SAP application server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message server configuration</strong></p></td><td><div><div><p><a href="#MessageServer">Message Server</a></p></div></div></td><td><div><div><p>Configuration for message server usage.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable RFC tracing on server</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enables or disables RFC trace on the server.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable CPIC tracing on server</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INHERIT</p></li><li><p>NO_TRACING</p></li><li><p>LEVEL_1</p></li><li><p>LEVEL_2</p></li><li><p>LEVEL_3</p></li></ul></div></div></td><td><div><div><p>Enables or disables CPIC trace on the server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Kerberos Config File Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the krb5.conf file.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Keytab File Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keytab file.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>GSS Library Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the gss library.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Principal that the connector uses to log in to SAP.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Client SNC Partner Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The <code>jco.client.snc_partnername</code> property.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Client SNC My Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The <code>jco.client.snc_myname</code> property.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Server SNC Partner Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The <code>jco.server.snc_partnername</code> property.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Server SNC My Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The <code>jco.server.snc_myname</code> property.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Simple Connection Provider Connection Type

Connects using a username and password.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>SAP system number</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Two-digit system number (sysnr) of the SAP system. Required when using <strong>Application server host</strong>. Not required when using <strong>Message server configuration</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SAP client ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Three-digit client number. Leading zeros are preserved if they appear in the number.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Destination Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Identifier of the destination generated by this connector. If none is set, a random value is created.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Login language</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Language code used by the connector. The language determines the code page used for communicating between the SAP adapter and the application server.</p></div></div></td><td><div><div><p><code>EN</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Extended Properties</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Used to pass in all the database server-specific connection parameters.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username the connector uses to log in to SAP.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password associated with the login username.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Application server host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host of the SAP application server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message server configuration</strong></p></td><td><div><div><p><a href="#MessageServer">Message Server</a></p></div></div></td><td><div><div><p>Configuration for message server usage.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable RFC tracing on server</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enables or disables RFC trace on the server.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable CPIC tracing on server</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INHERIT</p></li><li><p>NO_TRACING</p></li><li><p>LEVEL_1</p></li><li><p>LEVEL_2</p></li><li><p>LEVEL_3</p></li></ul></div></div></td><td><div><div><p>Enables or disables CPIC trace on the server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Sources

- [Document Listener](#document-listener)

- [Function Listener](#function-listener)

### Document Listener

`<sap:document-listener>`

Listens for incoming IDocs.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Gateway Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the host running the gateway server. This is the name of the host running the gateway handler. SAP Gateway is a development framework used to connect non-SAP applications to SAP applications. You can configure the SAP Gateway host to be the trusted system using an RFC destination.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Gateway Service</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Service port for the gateway service of the SAP system. To use the name instead of the port, you must map the gateway service name to the gateway service port.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Program ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>SAP system program ID that is registered on the gateway. Must be unique for the given gateway.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of connections to register on the gateway. If there is more than one connection, handler requests are processed in parallel. For example, if two connections are set, this creates two handler workers or threads that handle requests in parallel, almost like having two sources start together.</p></div></div></td><td><div><div><p><code>1</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Idoc Type Filter Regex</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression to filter all incoming IDocs by type.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Idoc Type Extension Filter Regex</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression to filter all incoming IDocs by type extension.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message server host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host of the message server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message server port</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Message server name or port number.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>System ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>System ID of the system the message server belongs to.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Group</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Logon group defined in ABAP that identifies a set of application servers.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Update interval</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>How often the message server fetches the list of application servers.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IDoc Render Options</strong></p></td><td><div><div><p><a href="#IDocRenderParameterGroup">IDoc Render Parameter Group</a></p></div></div></td><td><div><div><p>IDoc rendering options.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_BEGIN</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Type of beginning action that sources take regarding transactions.</p></div></div></td><td><div><div><p><code>NONE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transaction Type</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LOCAL</p></li><li><p>XA</p></li></ul></div></div></td><td><div><div><p>Type of transaction to create. Availability depends on Mule version.</p></div></div></td><td><div><div><p><code>LOCAL</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#SapAttributes">SAP Attributes</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

### Function Listener

`<sap:function-listener>`

Listens for incoming BAPI functions.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Gateway Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the host running the gateway server. This is the name of the host running the gateway handler. SAP Gateway is a development framework used to connect non-SAP applications to SAP applications. You can configure the SAP Gateway host to be the trusted system using an RFC destination.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Gateway Service</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Service port for the gateway service of the SAP system. To use the name instead of the port, you must map the gateway service name to the gateway service port.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Program ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>SAP system program ID that is registered on the gateway. Must be unique for the given gateway.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of connections to register on the gateway. If there is more than one connection, handler requests are processed in parallel. For example, if two connections are set, this creates two handler workers or threads that handle requests in parallel, almost like having two sources start together.</p></div></div></td><td><div><div><p><code>1</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Targeted Function</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the function to receive. Filters the incoming BAPI functions by their names.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message server host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host of the message server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message server port</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Message server name or port number.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>System ID</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>System ID of the system the message server belongs to.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Group</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Logon group defined in ABAP that identifies a set of application servers.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Update interval</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>How often the message server fetches the list of application servers.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_BEGIN</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Type of beginning action that sources take regarding transactions.</p></div></div></td><td><div><div><p><code>NONE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transaction Type</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LOCAL</p></li><li><p>XA</p></li></ul></div></div></td><td><div><div><p>Type of transaction to create. Availability depends on Mule version.</p></div></div></td><td><div><div><p><code>LOCAL</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>Source response.</p></div><div><div data-type="NOTE">SAP 5.6 and later supports updating a specific row in a table when a response is sent back to SAP after <strong>Function Listener</strong> is triggered. To update a specific row, add the <code>INDEX_ROW_UPDATE</code> parameter to the payload with the index of the row you want to update.</div></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#SapAttributes">SAP Attributes</a></p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

## Operations

- [Asynchronous Remote Function Call (Deprecated)](#asyncRfc)

- [Asynchronous Remote Function Call](#asynchronousRemoteFunctionCall)

- [Confirm Transaction](#confirmTransactionId)

- [Get Function](#getFunction)

- [Retrieve IDoc](#retrieveIdoc)

- [Send IDoc](#send)

- [Start SAP Transaction](#startsaptransaction)

- [Synchronous Remote Function Call (Deprecated)](#syncRfc)

- [Synchronous Remote Function Call](#synchronousRemoteFunctionCall)

### Asynchronous Remote Function Call (Deprecated)

`<sap:async-rfc>`

This operation is deprecated. Use the
[**Asynchronous Remote Function Call**](#asynchronousRemoteFunctionCall) operation instead.

This operation works only with JCo 3.0.x.

Executes a BAPIFunction over a queued Remote Function Call (qRFC).

A qRFC is an extension of a transactional RFC (tRFC) that ensures that individual steps are
processed in sequence. This guarantees that multiple logical unit of work (LUW) transactions are
processed in the order specified by the application.

tRFC can be serialized using inbound and outbound queues, hence the name queued RFC. qRFC is best
used as an extension of tRFC to define a processing sequence. Use qRFC to guarantee that several
transactions are processed in a predefined order.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Function Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the function to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>BAPIFunction to execute.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transaction Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>ID that identifies an RFC so that the RFC runs only once.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the queue on which the RFC executes. This applies for qRFC since each tRFC call that is processed is given a queue name by the application. A queue name and version are required for each qRFC transaction.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations take regarding transactions.</p></div></div></td><td><div><div><p><code>JOIN_IF_POSSIBLE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

#### Throws

- SAP:CONNECTIVITY

- SAP:INVALID\_CACHE

- SAP:INVALID\_INPUT

- SAP:METADATA\_UNAVAILABLE

- SAP:NOT\_FOUND

- SAP:NOT\_SUPPORTED

- SAP:PARSING

- SAP:RETRY\_EXHAUSTED

- SAP:SYSTEM\_BUSY

- SAP:TIMEOUT

### Asynchronous Remote Function Call

`<sap:asynchronous-remote-function-call>`

This operation works only with JCo 3.1.x and expects valid XML content in the response.

Executes a BAPIFunction over a queued Remote Function Call (qRFC) and throws an `SAP:INVALID_INPUT`
error when the provided payload is invalid according to JCo library checks.

A qRFC is an extension of a transactional RFC (tRFC) that ensures that individual steps are
processed in sequence. This guarantees that multiple logical unit of work (LUW) transactions are
processed in the order specified by the application.

tRFC can be serialized using inbound and outbound queues, hence the name queued RFC. qRFC is best
used as an extension of tRFC to define a processing sequence. Use qRFC to guarantee that several
transactions are processed in a predefined order.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Function Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the function to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>BAPIFunction to execute.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transaction Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>ID that identifies an RFC so that the RFC runs only once.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Queue Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the queue on which the RFC executes. This applies for qRFC since each tRFC call that is processed is given a queue name by the application. A queue name and version are required for each qRFC transaction.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations take regarding transactions.</p></div></div></td><td><div><div><p><code>JOIN_IF_POSSIBLE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

#### Throws

- SAP:CONNECTIVITY

- SAP:INVALID\_CACHE

- SAP:INVALID\_INPUT

- SAP:METADATA\_UNAVAILABLE

- SAP:NOT\_FOUND

- SAP:NOT\_SUPPORTED

- SAP:PARSING

- SAP:RETRY\_EXHAUSTED

- SAP:SYSTEM\_BUSY

- SAP:TIMEOUT

### Confirm Transaction

`<sap:confirm-transaction-id>`

Confirms to the server that a transaction is successful.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transaction ID (TID)</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>ID of the transaction to confirm.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations take regarding transactions.</p></div></div></td><td><div><div><p><code>JOIN_IF_POSSIBLE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

#### Throws

- SAP:CONNECTIVITY

- SAP:RETRY\_EXHAUSTED

### Get Function

`<sap:get-function>`

Retrieves a BAPIFunction based on its name.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Function Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the function to retrieve.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations take regarding transactions.</p></div></div></td><td><div><div><p><code>JOIN_IF_POSSIBLE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

#### Throws

- SAP:CONNECTIVITY

- SAP:INVALID\_CACHE

- SAP:INVALID\_INPUT

- SAP:METADATA\_UNAVAILABLE

- SAP:NOT\_FOUND

- SAP:NOT\_SUPPORTED

- SAP:PARSING

- SAP:RETRY\_EXHAUSTED

- SAP:SYSTEM\_BUSY

- SAP:TIMEOUT

### Retrieve IDoc

`<sap:retrieve-idoc>`

Retrieves an IDoc structure based on its key.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>IDoc Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Key that contains the required information to retrieve the IDoc.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations take regarding transactions.</p></div></div></td><td><div><div><p><code>JOIN_IF_POSSIBLE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

#### Throws

- SAP:CONNECTIVITY

- SAP:INVALID\_CACHE

- SAP:INVALID\_INPUT

- SAP:METADATA\_UNAVAILABLE

- SAP:NOT\_FOUND

- SAP:NOT\_SUPPORTED

- SAP:PARSING

- SAP:RETRY\_EXHAUSTED

- SAP:SYSTEM\_BUSY

- SAP:TIMEOUT

### Send IDoc

`<sap:send>`

Sends an IDoc to SAP over an RFC. An RFC can be one of two types for IDocs:

- Transactional (tRFC)

  A special form of asynchronous Remote Function Call (aRFC). tRFC ensures transaction-like handling
  of processing steps that were originally handled autonomously. tRFC is an asynchronous
  communication method that executes the called function module in the RFC server only once, even if
  the data is sent multiple times due to a network issue. The remote system does not need to be
  available at the time the RFC client program is executing a tRFC. The tRFC component stores the
  called RFC function, along with the corresponding data, in the SAP database under a unique
  transaction ID (TID). tRFC is similar to aRFC since it does not wait at the target system (similar
  to a registered post). If the system is not available, the data is written into aRFC tables with a
  transaction ID (SM58) that is chosen by the scheduler RSARFCSE and runs every 60 seconds. tRFC is
  best used as an extension of asynchronous RFC secure communication between systems.

- Queued (qRFC)

  An extension of tRFC. qRFC ensures that individual steps are processed in sequence. Use qRFC to
  guarantee that multiple LUWs (Logical Unit of Work transactions) are processed in the order
  specified by the application. tRFC can be serialized using inbound and outbound queues, hence the
  name queued RFC (qRFC). qRFC is best used as an extension of tRFC to define a processing sequence.
  Implement qRFC if you want to guarantee that several transactions are processed in a predefined
  order.

Both tRFC and qRFC have a TID handler.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>IDoc Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the IDoc to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>IDoc to execute.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Version</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Version on the IDoc.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transaction Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>ID that identifies an RFC so that the RFC runs only once.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Queue Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the queue on which the RFC executes. This applies for qRFC since each tRFC call that is processed is given a queue name by the application. A queue name and version are required for each qRFC transaction.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>IDoc Parsing Options</strong></p></td><td><div><div><p><a href="#IDocParseParameterGroup">IDoc Parse Parameter Group</a></p></div></div></td><td><div><div><p>IDoc parsing options.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations take regarding transactions.</p></div></div></td><td><div><div><p><code>JOIN_IF_POSSIBLE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

#### Throws

- SAP:CONNECTIVITY

- SAP:INVALID\_CACHE

- SAP:INVALID\_INPUT

- SAP:METADATA\_UNAVAILABLE

- SAP:NOT\_FOUND

- SAP:NOT\_SUPPORTED

- SAP:PARSING

- SAP:RETRY\_EXHAUSTED

- SAP:SYSTEM\_BUSY

- SAP:TIMEOUT

### Start SAP Transaction

`<sap:create-transaction-id>`

Creates a transaction ID to use as part of future calls.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations take regarding transactions.</p></div></div></td><td><div><div><p><code>JOIN_IF_POSSIBLE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

#### Throws

- SAP:CONNECTIVITY

- SAP:INVALID\_CACHE

- SAP:INVALID\_INPUT

- SAP:METADATA\_UNAVAILABLE

- SAP:NOT\_FOUND

- SAP:NOT\_SUPPORTED

- SAP:PARSING

- SAP:RETRY\_EXHAUSTED

- SAP:SYSTEM\_BUSY

- SAP:TIMEOUT

### Synchronous Remote Function Call (Deprecated)

`<sap:sync-rfc>`

This operation is deprecated. Use the
[**Synchronous Remote Function Call**](#synchronousRemoteFunctionCall) operation instead.

This operation works only with JCo 3.0.x.

Executes a BAPIFunction over a synchronous Remote Function Call (sRFC). sRFC requires both the
systems (client and server) to be available at the time of communication or data transfer. sRFC is
the most common type and is used when a result is required immediately after the execution of sRFC.
sRFC is a means of communication between systems where acknowledgments are required.

The resources of the source system wait at the target system and ensure that they deliver the
message or data with ACKD. The data is consistent and reliable for communication. If the target
system is not available, the source system resources wait until the target system is available. This
can lead to the processes of the source system going into Sleep/RFC/CPIC mode at the target systems,
which blocks these resources. Use sRFC for communication between systems, and communication between
an SAP web application server and an SAP GUI.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Function Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the function to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>BAPIFunction to execute.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations take regarding transactions.</p></div></div></td><td><div><div><p><code>JOIN_IF_POSSIBLE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

#### Throws

- SAP:CONNECTIVITY

- SAP:INVALID\_CACHE

- SAP:INVALID\_INPUT

- SAP:METADATA\_UNAVAILABLE

- SAP:NOT\_FOUND

- SAP:NOT\_SUPPORTED

- SAP:PARSING

- SAP:RETRY\_EXHAUSTED

- SAP:SYSTEM\_BUSY

- SAP:TIMEOUT

### Synchronous Remote Function Call

`<sap:synchronous-remote-function-call>`

This operation works only with JCo 3.1.x and expects valid XML content in the response.

If the function being called must impact changes in SAP, you must add a `try` block because you need
an open transaction.

Executes a BAPIFunction over a synchronous Remote Function Call (sRFC) and throws an
`SAP:INVALID_INPUT` error when the provided payload is invalid according to JCo library checks. sRFC
requires both the systems (client and server) to be available at the time of communication or data
transfer. sRFC is the most common type and is used when a result is required immediately after the
execution of sRFC. sRFC is a means of communication between systems where acknowledgments are
required.

The resources of the source system wait at the target system and ensure that they deliver the
message or data with ACKD. The data is consistent and reliable for communication. If the target
system is not available, the source system resources wait until the target system is available. This
can lead to the processes of the source system going into Sleep/RFC/CPIC mode at the target systems,
which blocks these resources. Use sRFC for communication between systems, and communication between
an SAP web application server and an SAP GUI.

> [!NOTE] The **Synchronous Remote Function Call** operation requires authorization for the
> `RFC_METADATA_GET` function module. If authorization is not granted, you may encounter this error:
>
> `com.sap.conn.rfc.exceptions.RfcGetException: No RFC authorization for function module RFC_METADATA_GET`.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Function Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the function to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>BAPIFunction to execute.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Canonical name of the encoding. Refer to <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Oracle’s supported encodings</a>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations take regarding transactions.</p></div></div></td><td><div><div><p><code>JOIN_IF_POSSIBLE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#sap)

#### Throws

- SAP:CONNECTIVITY

- SAP:INVALID\_CACHE

- SAP:INVALID\_INPUT

- SAP:METADATA\_UNAVAILABLE

- SAP:NOT\_FOUND

- SAP:NOT\_SUPPORTED

- SAP:PARSING

- SAP:RETRY\_EXHAUSTED

- SAP:SYSTEM\_BUSY

- SAP:TIMEOUT

## Object Types

- [Expiration Policy](#ExpirationPolicy)

- [IDoc Parse Parameter Group](#IDocParseParameterGroup)

- [IDoc Render Parameter Group](#IDocRenderParameterGroup)

- [Message Server](#MessageServer)

- [Reconnect](#reconnect)

- [Reconnect Forever](#reconnect-forever)

- [Reconnection](#Reconnection)

- [Redelivery Policy](#RedeliveryPolicy)

- [Repeatable File Store Stream](#repeatable-file-store-stream)

- [Repeatable In Memory Stream](#repeatable-in-memory-stream)

- [SAP Attributes](#SapAttributes)

### Expiration Policy

Configures an expiration policy strategy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### IDoc Parse Parameter Group

IDoc parsing options.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Parse With Field Value Checking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to enable the field value checking mechanism in accordance with the respective IDoc field metadata when parsing.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Parse Ignore Unknown Fields</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to ignore unknown fields when parsing, for example, when parsing with older IDoc metadata.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Parse Ignore Invalid Char Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to ignore character range check errors in accordance with the declared XML specification version when parsing. When using this option, invalid characters within field values are accepted, although the XML document to parse might contain characters that are not in the valid character range.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Parse Without Field Data Type Checking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to disable the field data type checking mechanism in accordance with the respective IDoc field metadata when parsing.<br><br></p></div><div><div data-type="WARNING"><div><p>Use this option with care.</p></div><div><p>Sending IDocs with illegal field contents that violate the field’s defined datatype can cause ABAP system dumps and result in unrecognized partial loss of data when processed in an AS ABAP system.</p></div></div></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Parse Refuse Unknown XML Version</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to refuse XML documents that declare an unknown XML specification version, for example, a potential future XML specification version 1.2 or 2.0.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Parse Refuse XML Version10</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to refuse XML documents that don’t use XML specification version 1.0 or that don’t contain an XML declaration header.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Parse Refuse XML Version11</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to refuse XML documents that use XML specification version 1.1.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Parse Accept Only Xml Version10</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to accept only XML documents that use XML specification version 1.0 or that don’t contain an XML declaration header.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Parse Accept Only Xml Version11</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to accept only XML documents that use XML specification version 1.1 or that don’t contain an XML declaration header.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Parse Accept Only Xml Version10 To11</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to accept only XML documents that use XML specification version 1.0 or 1.1 or that don’t contain an XML declaration header.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr></tbody></table>

### IDoc Render Parameter Group

IDoc rendering options.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Render IDoc Empty Tags</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to include all empty tags in the resulting XML document.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc Ignore Invalid Char Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to ignore character range check errors in accordance with the used XML specification version.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc Ignore Tag Escape Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to ignore escape character errors within XML tags in accordance with the used IDocXML format</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc Omit Xml Declaration</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to omit the XML declaration section in the resulting XML document.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc Optional Encoding Decl</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to write an optional XML encoding declaration attribute into the resulting XML document.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc Substitute Invalid Chars</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to substitute invalid characters within IDoc field values with the number sign <code>#</code> (<code>U+0023</code>).</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc With CR</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to insert <code>CR</code> (Carriage Return) characters into the resulting XML document.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc With CRLF</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to insert <code>CR+LF</code> (Carriage Return and Line Feed) characters into the resulting XML document.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc With LF</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to insert <code>LF</code> (Line Feed) characters into the resulting XML document.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc With Tabs And CR</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to insert <code>TAB</code> and <code>CR</code> (Tab and Carriage Return) characters into the resulting XML document.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc With Tabs And CRLF</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to insert <code>TAB</code> and <code>CR+LF</code> (Tab, Carriage Return and Line Feed) characters into the resulting XML document.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc With Tabs And LF</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to insert <code>TAB</code> and <code>LF</code> (Tab and Line Feed) characters into the resulting XML document.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc Xml10</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to create an XML document compliant with XML specification version 1.0.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Render IDoc Xml11</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to create an XML document compliant with XML specification version 1.1.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr></tbody></table>

### Message Server

You can configure a message server with multiple gateways to distribute the load and improve
performance. The message server configuration is used for all SAP Connector operations (**Document
Listener**, **Function Listener**, and all other operations such as **Synchronous Remote Function
Call** and **Send IDoc**). For more information, refer to
[Configure Multiple Gateways](https://docs.mulesoft.com/sap-connector/latest/sap-connector-examples#configure-multiple-gateways).

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host of the message server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>System Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>System ID of the SAP system.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port with which the connector logs into the message server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Group</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Group of SAP application servers.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Router</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>SAP router string to use for a system protected by a firewall.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to
reconnect at a specified frequency for as long as the Mule app runs.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:</p></div><div><ul><li><p><code>true</code></p><div><p>Allow the deployment to fail.</p></div></li><li><p><code>false</code></p><div><p>Ignore the results of the connectivity test.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a
redelivery policy to any source in a flow.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Secure hashing algorithm to use if the <strong>Use Secure Hash</strong> field is <code>true</code>. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s <code>hashCode()</code> returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more expressions that determine when a message was redelivered. This property can be set only if the <strong>Use Secure Hash</strong> field is <code>false</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>Object Store</p></div></div></td><td><div><div><p>Configures the object store that stores the redelivery counter for each message.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream
content in memory. If the stream content is larger than the configured buffer size, Mule backs up
the buffer’s content to disk and then clears the memory.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:</p></div><div><ul><li><p>Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.</p></li><li><p>Configure a smaller buffer size to decrease memory load at the expense of response time.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Size</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX
buffer size. Always run performance tests to find the optimal buffer size for your specific use
case.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by <strong>Buffer Size Increment</strong>, with an upper limit of <strong>Max In Memory Size value</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount by which the buffer size expands if it exceeds its initial size. Setting a value of <code>0</code> or lower specifies that the buffer can’t expand.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>Initial Buffer Size</strong>, <strong>Buffer Size Increment</strong>, and <strong>Buffer Unit</strong> fields.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### SAP Attributes

Attributes for SAP payload.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Transaction Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Transaction ID value.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=18f41a9126b2164b5a71d42d1cecf4a5df7de3e3622297fb5d57f33b159a6061 url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-studio.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# SAP Connector 5.9 Studio Configuration

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install SAP Connector and configure the connector in Anypoint Studio. First install the SAP Java
Connector (JCo) libraries that you obtain from SAP and then you can create an app containing one or
more SAP Connector operations. Studio enables you to create an app and access the app from a
browser.

To configure SAP Connector in Anypoint Studio:

1.  Add the connector to your Mule project.

2.  Configure the SAP connector.

3.  Configure an input source for the connector.

## Add the Connector to Your Mule Project

Add SAP Connector to your Mule project to automatically populate the XML code with the connector’s
namespace and schema location and to add the required dependencies to the project’s `pom.xml` file:

1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

2.  In the **Add Dependencies to Project** window, type `sap` in the search field.

3.  Click **SP Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Select a Source Operation

1.  In Anypoint Studio, click the **Mule Palette** and type `sap`.

2.  Choose an operation.  
    If you want your app to start when an object is sent from SAP, choose either of the following
    operations and drag the operation to the **Source** area of the Studio canvas.

    - **Document source** listens for a change to an IDoc. When an IDoc changes, your app executes

    - **Function source** listens for a change to an SAP function module. When the targeted function
      module changes, your app executes.

      See the [SAP Connector Reference](https://docs.mulesoft.com/sap-connector/latest/sap-connector-reference) for field values. If you chose the
      **Document source** or **Function source** operation, proceed to the next section to install
      the SAP libraries.

3.  Alternatively, you can configure an input source for this connector such as an **HTTP
    Listener**, or **Scheduler**, and drag the operation to the Studio canvas.  
    An HTTP Listener enables you to start your app from a browser. A Scheduler starts your app at a
    specific time.

4.  Install the SAP libraries.

## Install SAP Libraries

To use SAP libraries in your Mule project, you must first download the libraries to your computer.
You can use the three libraries in Anypoint Studio directly, without conversion. You must have an
SAP ID to download the libraries.

The file types for each library depend on your operating system:

<table><colgroup><col> <col></colgroup><thead><tr><th>OS</th><th>File Types</th></tr></thead><tbody><tr><td><p>Windows</p></td><td><div><div><ul><li><p>sapidoc3.jar</p></li><li><p>sapjco3.jar</p></li><li><p>sapjco3.dll</p></li></ul></div></div></td></tr><tr><td><p>Mac OS</p></td><td><div><div><ul><li><p>sapidoc3.jar</p></li><li><p>sapjco3.jar</p></li><li><p>libsapjco3.jnilib</p></li></ul></div></div></td></tr><tr><td><p>Linux</p></td><td><div><div><ul><li><p>sapidoc3.jar</p></li><li><p>sapjco3.jar</p></li><li><p>libsapjco3.so</p></li></ul></div></div></td></tr></tbody></table>

> [!NOTE] SAP Connector supports SAP JCo libraries versions 3.0.x and 3.1.x.

After you install the libraries, you can customize the global element properties and test the
connection.

## Configure the Libraries in Anypoint Studio

After installing the SAP Connector in Studio and adding the connector to your Mule project,
configure the libraries.

1.  Double-click the connector in the flow.

2.  Click the plus sign (**+**) on the right of the **Connector Configuration** field.  
    This screen appears:

    ![SAP Connector global element properties window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-01.png)

### Install the IDOC Library

1.  Click **Add Dependency**.

2.  Click **Install**.

    ![Install button in Maven dependency window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-02.png)

3.  In the **Install** menu, click **Browse** to locate the library file.

4.  Specify a unique group ID, artifact ID, and version.

    ![Install file into local repository window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-02-in.png)

5.  Click **Finish** or, if you want to cancel, click **Remove Dependency**.

    ![Finish button in Maven dependency window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-02-finish.png)

### Install the JCO Library

1.  Click **Add Dependency**.

2.  Click **Install**.

    ![Install button in Maven dependency window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-02.png)

3.  In the **Install** menu, click **Browse** to locate the library file.

4.  Specify a unique group ID, artifact ID, and version.

    ![Install file into local repository window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-03-in.png)

5.  Click **Finish** or, if you want to cancel, click **Remove Dependency**.

    ![Finish button in Maven dependency window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-03-finish.png)

### Install the JCO Native Library

1.  Click **Add Dependency**.

2.  Click **Install**.

    ![Install button in Maven dependency window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-02.png)

3.  In the **Install** menu, click **Browse** to locate the library file.

    On MacOS, starting with JCO version 3.1.2, the native library extension was changed from
    `jnilib` to `dylib`.

    1.  After installing the library from the local machine:

    2.  Navigate to the bottom of the **Shared Folder** window.

    3.  Select **Any**, and then select the `dylib` native library.

    4.  In the **Install file into local repository** window, enter values for the following fields:

        - **Group ID**

        - **Artifact ID**

        - **Version**

4.  Specify a unique group ID, artifact ID, and version.

    ![Install file into local repository window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-04-in.png)

5.  Click **Finish** or, if you want to cancel, click **Remove Dependency**.

    ![Finish button in Maven dependency window](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-configuration-04-finish.png)

When you are finished installing the libraries, the configuration screen appears as follows with
green check marks for each successfully installed library:

![Global element properties window with required libraries installed](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-libraries-installed.png)

## Test the Connection

1.  Sign into your SAP login to get the information you need to configure the remaining **Global
    Element Properties** fields as described in [Configure in Studio](#gepparms).

2.  Click **Test Connection** to ensure that you have the correct login information.

## Configure the Connector

If you need more than one SAP Connector instance in your Mule project, you can create a global SAP
element. The SAP Connector object holds the configuration properties that allow you to connect to
the SAP server.

To create a configuration for SAP Connector, complete the following steps:

1.  Go to **Global Elements** section and click **Create**.

2.  Select either **SAP Inbound** or **SAP Outbound** in the **Connector Configuration** section.

3.  In the **General** tab pane, enter the required parameters for defining an SAP connection, which
    your SAP system administrator can supply.

The SAP global element properties allow you to define connection properties as well as to add the
required SAP dependencies to your project.

For ease of use, SAP Connector shows only the most common properties as connector parameters. To
configure a property that is not listed in the **Properties** panel, see the
[Define Extended Properties](https://docs.mulesoft.com/sap-connector/latest/sap-connector-config-topics) topic.

The minimum required attributes to define are:

<table id="gepparms"><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Application Server Host</strong></p></td><td><div><div><p>SAP endpoint</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>Username of an authorized SAP user</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>Password credential of an authorized SAP user</p></div></div></td></tr><tr><td><p><strong>System Number</strong></p></td><td><div><div><p>System number used to connect to the SAP system</p></div></div></td></tr><tr><td><p><strong>Client</strong></p></td><td><div><div><p>The SAP client ID (usually a number) used to connect to the SAP system</p></div></div></td></tr><tr><td><p><strong>Login Language</strong></p></td><td><div><div><p>The language to use for the SAP connection. For example, <code>EN</code> for English.</p></div></div></td></tr></tbody></table>

As a best practice, use property placeholder syntax to load the credentials in a more simple and
reusable way.

Click **Test Connection** to verify that the connection to the SAP instance is correct. If the
credentials are correct you should see the `Test Connection Successful` message.

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio
  console window.

- If you’re running the app using Mule from the command line, the app log is visible in your OS
  console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`.

## Next

After configuring this connector in Studio, see the
[Additional Configuration Information](https://docs.mulesoft.com/sap-connector/latest/sap-connector-config-topics) topic for more configuration
topics.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=ea9911fc3e29eccb6b2ee5e9cdf9ac298d2ebd5c3bb5d9c7ee1d065b70883025 url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-terminology.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# SAP Connector 5.9 Terminology

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

The following are commonly used SAP system acronyms:

ABAP (Advanced Business Application Programming)

SAP proprietary programming language and part of the NetWeaver platform for building business
applications.

ALE (Application Link Enabling)

Sets up distributed applications and integrated installation of SAP systems. This involves
business-driven message exchange using consistent data across loosely linked SAP apps. Apps are
integrated through synchronous and asynchronous communication, rather than by use of a central
database.

BAPI (Business Application Programming Interface)

The function module that fulfills design criteria and provides the ability to:

- Implement a method of an SAP business object

- Maintain a static interface through different versions of the SAP system

- Enable remotely

- Run to completion with or without user interaction

- Handle errors

FM (function module)

Procedures defined in the ABAP language of SAP that allow the encapsulation and reuse of global
functions in SAP.

IDoc (intermediate document)

Standard SAP format for electronic data interchange between SAP systems. Different message types
(such as delivery notes or purchase orders) generally correspond to different special formats, known
as IDoc types. Multiple message types with related content can, however, be assigned to a single
IDoc type.

Java API

Handles dynamic metadata lookup and caching. The Java API implements the `JCO.Function` container
used for parameters and tables for the SAP BAPI function module in Java. Java apps are built on top
of the Java API.

JNI (Java Native Interface)

JNI is a layer in the SAP Connector library. JCo wraps the C libraries in Java to provide
platform-native access to the SAP system. RFC middleware uses the RFC library through the JNI layer.

RFC (remote function call)

Communication with the SAP system is performed over the RFC protocol. A remote function call calls
BAPI or triggers IDoc processing that runs in another system as a calling program. The RFC interface
enables function calls either between two SAP systems or between the SAP and external system.

RFC layer

SAP component that processes remote function calls.

RFC library

Libraries of C language-based functions to access the SAP system. The RFC library is addressed by
JNI.

SAP Java IDoc class library

Provides structured, high-level interpretation and navigation of SAP IDocs in Java that consists of
the following add-on packages:

- SAP Java base IDoc class library: A middleware-independent library that provides a set of general
  base classes and interfaces for middleware-dependent Java IDoc class library implementations.

- SAP Java connector IDoc class library: A middleware-independent library for creating, sending, and
  receiving IDocs.

SAP NetWeaver

One of the main technologies and application platforms used by SAP solutions. The main component of
NetWeaver is SAP Web Application Server (WebAS), which provides the runtime environment for SAP
applications like ERP, CRM, SCM, PLM, SRM, and BI. Other components include the enterprise portal,
exchange infrastructure, master data management, and mobile infrastructure. SAP NetWeaver is an
umbrella term for these technical components. SAP NetWeaver runs on both the Java and ABAP stacks.

SNC (Secure Network Communications)

Integrates with SAP NetWeaver single sign-on or an external security product that works with SAP
systems. SNC provides security functions that are not directly available with SAP systems.

## See Also

- [Anypoint Connectors Overview](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=79830573b0b2f717a747a8e4c1c128a30d7161354398108445cff431e9c0106e url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-xml-maven.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# SAP Connector 5.9 XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:

If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can access the connector from your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

If you add the connector in Studio, Studio automatically populates the XML code with the connector’s
namespace and schema location and it also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `<mule>` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/sap
http://www.mulesoft.org/schema/mule/sap/current/mule-sap.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:<connector>="http://www.mulesoft.org/schema/mule/<connector>"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/sap
	http://www.mulesoft.org/schema/mule/sap/current/mule-sap.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-sap-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

For JCo library support, add these dependencies:

```xml
<build>
    <plugins>
        <plugin>
            <groupId>org.mule.tools.maven</groupId>
            <artifactId>mule-maven-plugin</artifactId>
            <version>${mule.maven.plugin.version}</version>
            <extensions>true</extensions>
            <configuration>
                <sharedLibraries>
                    <sharedLibrary>
                        <groupId>com.sap.conn.jco</groupId>
                        <artifactId>com.sap.conn.jco.sapjco3</artifactId>
                    </sharedLibrary>
                    <sharedLibrary>
                        <groupId>com.sap.conn.idoc</groupId>
                        <artifactId>com.sap.conn.idoc.sapidoc3</artifactId>
                    </sharedLibrary>
                    <sharedLibrary>
                        <groupId>com.sap.conn.jco</groupId>
                        <artifactId>com.sap.conn.jco.libsapjco3</artifactId>
                    </sharedLibrary>
                </sharedLibraries>
            </configuration>
        </plugin>
    </plugins>
</build>
```

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `sap`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## Next

After completing your namespace and `pom.xml` file, you can try the SAP
[Examples](https://docs.mulesoft.com/sap-connector/latest/sap-connector-examples).

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=8d0e0ef3c3f69e3a305b166a212eb40255127a639ecf51f7d2c9c45fb3f0a628 url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-troubleshooting.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# Troubleshooting SAP Connector 5.9

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To troubleshoot Anypoint Connector for SAP (SAP Connector), become familiar with the information
about performing general troubleshooting, addressing specific common errors, and interpreting
commonly thrown exception messages.

## Enable Verbose Exception Logging

Enable verbose exception logs to show a complete stack trace of the error instead of the default
truncated output:

1.  In Studio, right-click on the project and select **Run > Run Configurations**.

2.  Go to the **Arguments** tab and append the arguments in the **VM arguments** section to add the
    `mule.verbose.exceptions` property. For example:

    `-XX:PermSize=128M -XX:MaxPermSize=256M -Dmule.verbose.exceptions=true`

## Enable Verbose Logging

To get a better understanding of why an application’s interaction with SAP Connector is failing,
temporarily enable verbose logging for the connector.

Remember to always disable enhanced verbosity after troubleshooting, because it can affect your Mule
application’s performance.

To enable verbose logging in the configuration file:

1.  Access Anypoint Studio and navigate to the **Package Explorer** view.

2.  Open your application’s project name.

3.  Open the `src/main/resources` folder.

4.  Open the `log4j2.xml` file inside the folder.

5.  Add an `<AsyncLogger>` tag inside the `<Loggers>` tag:

    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="com.mulesoft.connector.sap" level="DEBUG"/>
    				...
    			</Loggers>
    ```

6.  Save your application changes.

7.  Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule
    Application**.

## Perform General Troubleshooting

Here is a list of general troubleshooting guidelines for SAP Connector:

- [Check Log Files](#check-log-files)

- [Enable JCo Trace](#enable-jco-trace)

### Check Log Files

Mule stores log files (on a per-application basis) in the `$MULE_HOME\logs` directory:

- `mule.log`  
  Default Mule log file

- `mule-app-YOUR_APP_NAME.log`  
  Per-application log file

### Enable JCo Trace

You can enable JCo trace externally from Mule. JCo trace accepts the following Java startup
environment properties:

- `-Djco.trace_level=N`  
  Where `0` <= `N` <= `10`, and `10` is the most detailed trace

- `-Djco.trace_path=<PATH>`  
  Optional

JCo supports trace levels from `0` (default) through `10`. The amount of traced data increases with
higher trace levels. Each trace level also contains all the trace data from the lower trace levels.
If you are using a high JCo trace level with many JCo calls and transferred content, ensure that
enough disk space is available.

To enable traces at the connector level:

1.  Set the attribute `jcoTrace` to `true` or provide the extended JCo property `jco.client.trace`
    or `jco.server.trace` with the value `1`.

2.  Provide a value for `-Djco.trace_level=N` at Mule startup:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Trace Level</th><th>AS Java Severity Level</th><th>JCo 3 Trace Content</th></tr></thead><tbody><tr><td><p><code>0</code></p></td><td><p><code>NONE</code></p></td><td><p>No trace</p></td></tr><tr><td><p><code>1</code></p></td><td><p><code>ERROR</code></p></td><td><p>JCo version and runtime environment information and JCo internal errors and exceptions without application errors</p></td></tr><tr><td><p><code>2</code></p></td><td><p><code>WARNING</code></p></td><td><p>JCo warning messages, for example, non-ABAP system exceptions</p></td></tr><tr><td><p><code>3</code></p></td><td><p><code>INFO</code></p></td><td><p>JCo information messages, for example, ABAP exceptions</p></td></tr><tr><td><p><code>4</code></p></td><td><p><code>PATH</code></p></td><td><p>RFC calls and important public API calls</p></td></tr><tr><td><p><code>5</code></p></td><td><p><code>DEBUG</code></p></td><td><p>Important internal middleware calls<br>Codepage information</p></td></tr><tr><td><p><code>6</code></p></td><td><p><code>DEBUG</code></p></td><td><p>Connection attributes<br>ASCII content data (the first 1000 chars of structures or the first 5 rows of tables)</p></td></tr><tr><td><p><code>7</code></p></td><td><p><code>DEBUG</code></p></td><td><p>RFC metadata, which includes: name, type, offset, length, import and export options, and additional hexadecimal values for content data</p></td></tr><tr><td><p><code>8</code></p></td><td><p><code>DEBUG</code></p></td><td><p>Full content data dump (no character or row limits)<br>Caller stack trace information, for example, <code>getClient()</code> identifies the application</p></td></tr><tr><td><p><code>9</code></p></td><td><p><code>DEBUG</code></p></td><td><p>No additional information (reserved for future use)</p></td></tr><tr><td><p><code>10</code></p></td><td><p><code>DEBUG</code></p></td><td><p>No additional information (reserved for future use)</p></td></tr></tbody></table>

3.  Optionally, provide a value for `-Djco.trace_path=<PATH>`. This is usually the complete path to
    an existing directory in which the trace files are stored, but you can apply other special
    values:

    - `stdout`  
      JCo trace information is sent to standard the **output** stream

    - `stderr`  
      JCo trace information is sent to standard the **error** stream

If `-Djco.trace_path` is not set, then trace files are stored in the working directory. For Mule
standalone instances, this is usually the `$MULE_HOME/bin` folder.

## Troubleshoot Common Errors

Here is a list of the common SAP Connector errors and how to resolve them:

- [Missing JCo Libraries](#missing-jco-libraries)

- [JCo Classloader Conflicts](#jco-classloader-conflicts)

- [JCo Version Conflicts](#jco-version-conflicts)

- [JCo Renaming Conflicts](#jco-renaming-conflicts)

- [Message Not an SAP Object](#message-not-an-sap-object)

- [IDoc Metadata Unavailable](#idoc-metadata-unavailable)

- [Missing TID Handler](#missing-tid-handler)

- [Parameter Not Supported](#parameter-not-supported)

- [Multiple JCo Servers Running](#multiple-jco-servers-running)

### Missing JCo Libraries

These errors typically occur when you test the connection or try to deploy the Mule application
without loading one or more of the required SAP JCo dependencies:

- Missing JCo native library

  ```text
  java.lang.ExceptionInInitializerError: JCo initialization failed with java.lang.UnsatisfiedLinkError: no sapjco3 in java.library.path
  ```

- Missing JCo JAR

  java.lang.NoClassDefFoundError: com/sap/conn/jco/JCoTraceListener

- Missing IDoc JAR

  java.lang.NoClassDefFoundError: com/sap/conn/idoc/IDocMetaDataUnavailableException

![Global element properties window with missing libraries](/mulesoft/current/en-us/sap-connector/latest/_images/sap-connector-missing-libraries.png)

To resolve this error:

1.  Click **Configure** next to the dependency with the red exclamation mark icon in the **Required
    Libraries** section.

2.  Browse through the dependencies and select the appropriate file.  
    The missing dependencies are automatically added to the project’s classpath.

> [!TIP] In **Package Explorer**, right-click the project and navigate to **Build Path > Configure
> Build Path** to view the libraries in the project’s build path.

### JCo Classloader Conflicts

When you load the native library from the global configuration, a copy of the file is placed in
`$YOUR_APP/src/main/app/lib`, but the source file is not removed; hence, you get the following error
if the native library shares the same directory as the JCo JAR files when testing the connection or
deploying your app:

```text
java.lang.ExceptionInInitializerError: JCo initialization failed with java.lang.UnsatisfiedLinkError: Native Library /home/mule/sap-errors/lib/jco/libsapjco3.so already loaded in another classloader
```

![SAP Error JCo classloader folder structure](/mulesoft/current/en-us/sap-connector/latest/_images/sap-error-jco-classloader-folder.png)

To resolve this error:

Choose either of the following solutions. The first is the simplest, but the second is the best
practice approach.

- Remove the _duplicate_ native library file from the directory in which your JCo JAR files reside:

  ![SAP Error JCo classloader fixed folder structure](/mulesoft/current/en-us/sap-connector/latest/_images/sap-error-jco-classloader-fix.png)

- Configure the environment variable `LD_LIBRARY_PATH` to hold the dynamic link library and share it
  across multiple applications deployed within the same Mule runtime server.

### JCo Version Conflicts

The most frequent cause of the following error is that different versions of the native library and
JCo JAR files are being used:

```text
java.lang.ExceptionInInitializerError: Native library sapjco3 is too old. Found library System-defined path to libsapjco3.so has version "720.612", but required is at least version "720.713".
```

To resolve this error, ensure that the following requirements are met:

- 64-bit JCo is required on a JVM that runs in 64-bit mode, and 32-bit JCo is required on a JVM that
  runs in 32-bit mode.

- On Microsoft Windows, JCo requires the Microsoft Visual Studio 2005 C/C++ runtime libraries.

- Both the `sapjco.jar`, and one of `sapjco3.dll` or `sapjco3.so` or `sapjco3.jnilib` must be from
  the **same JCo package**.

To verify the versions of the JCo libraries that you are using, do one of the following:

- On Windows (in the UI):

  1.  Navigate to the directory in which the `sapjco3.jar` file is located.

  2.  Right-click the `sapjco3.jar` file.

  3.  Select **Open With** from the context menu.

  4.  Click the **Java 2 Platform Standard Edition** binary.

  5.  Verify the information shown in the JCo dialog that displays.

- On Mac:

  1.  Open a terminal window.

  2.  Navigate to the directory in which the `sapjco3.jar` file is located.

  3.  Execute the command `java -jar sapjco3.jar -version`.

  4.  Verify the information shown in the JCo dialog that displays.

### JCo Renaming Conflicts

You cannot rename any of the SAP JCo library files in JCo 3.0.11 or later as they won’t be
recognized by JCo, and you receive the following error:

```text
java.lang.ExceptionInInitializerError: Illegal JCo archive "sapjco3-3.0.11.jar". It is not allowed to rename or repackage the original archive "sapjco3.jar"
```

This is also true for the IDoc library and you might receive this error:

```text
java.lang.ExceptionInInitializerError: Illegal IDoc library archive "sapidoc3-3.1.4.jar". It is not allowed to rename or repackage the original archive "sapidoc3.jar".
```

To resolve this error, add this `maven-shade-plugin` to your application’s `pom.xml` file:

```xml
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <version>3.5.1</version> <!-- use latest version -->
  <executions>
    <execution>
      <phase>package</phase>
      <goals>
        <goal>shade</goal>
      </goals>
      <configuration>
        <minimizeJar>false</minimizeJar>
        <artifactSet>
          <includes combine.children="append">
            <include>sapjco3-group-id:sapjco3-artifact-id</include>
            <include>sapidoc3-group-id:sapidco3-artifact-id</include>
          </includes>
        </artifactSet>
      </configuration>
    </execution>
  </executions>
</plugin>
```

> [!NOTE] To prevent build issues, ensure the versions of `maven-shade-plugin` and
> `munit-maven-plugin` are compatible:
>
> - `maven-shade-plugin` 3.5.x and later requires `munit-maven-plugin` 2.3.x and later.
>
> - `maven-shade-plugin` 3.4.x and earlier requires `munit-maven-plugin` 2.2.x and earlier.

To determine the correct `groupId` and `artifactId` values, refer to your existing dependencies. An
example configuration is shown below (these might vary depending on your setup):

```xml
<dependency>
  <groupId>com.sap.conn.jco</groupId>
  <artifactId>com.sap.conn.jco.sapjco3</artifactId>
  <version>3.1.12</version>
</dependency>
<dependency>
  <groupId>com.sap.conn.idoc</groupId>
  <artifactId>com.sap.conn.idoc.sapidoc3</artifactId>
  <version>3.1.4</version>
</dependency>
```

In this example, the full artifact coordinates are `com.sap.conn.jco:com.sap.conn.jco.sapjco3` and
`com.sap.conn.idoc:com.sap.conn.idoc.sapidoc3`.

> [!NOTE] Shading might increase the application size by nearly 2 MB.

### Message Not an SAP Object

The endpoint expects an SAP object with the input parameters that are necessary to execute a BAPI or
an IDoc.

If you receive the following message, either:

- The necessary input parameters are not provided.

- The input parameters are provided but the SAP object is malformed.

```text
org.mule.api.transport.DispatchException: Message is not a SAP object, it is of type "byte[]". Check the transformer for this Connector "SapConnector". Failed to route event via endpoint: SapOutboundEndpoint{endpointUri=sap://function, connector=SapConnector
{
 name=SapConnector
 lifecycle=start
 this=4571cebe
 numberOfConcurrentTransactedReceivers=4
 createMultipleTransactedReceivers=true
 connected=true
 supportedProtocols=[sap]
 serviceOverrides=<none>
}
,  name='endpoint.sap.function', mep=ONE_WAY, properties={evaluateFunctionResponse=false, bapiTransaction=false, functionName=BAPI_MATERIAL_AVAILABILITY, rfcType=srfc, outputXml=true}, transactionConfig=Transaction{factory=null, action=INDIFFERENT, timeout=0}, deleteUnacceptedMessages=false, initialState=started, responseTimeout=10000, endpointEncoding=UTF-8, disableTransportTransformer=false}. Message payload is of type: byte[]
```

To resolve this error:

Create an SAP object that represents the call to the BAPI or IDoc by performing one of the following
two actions:

- Create XML that contains an SAP object with the BAPI call.

- Provide an XML definition that includes input to create the actual SAP call.

### IDoc Metadata Unavailable

When you receive the following error, it means that the RFC destination does not support Unicode:

```text
RfcException: [mc-vmware|a_rfc] message: (3) IDOC_ERROR_METADATA_UNAVAILABLE: The meta data for the IDoc type "??????????????????????????å å" with extension "  ORDSAPB6L B60CL          ???" is unavailable.
    Return code: RFC_FAILURE(1)
    error group: 104
    key: RFC_ERROR_SYSTEM_FAILURE
```

To resolve this error:

Use transaction **SM59** to configure Unicode support in your SAP instance.

### Missing TID Handler

Because no TID handler is defined, you receive the following error:

```text
RfcException: [mule.local|MULESOFT_IDOC_SEND_TEST]
    message: check TID fault: No transaction handler is installed. Unable to process tRFC/qRFC requests.
    Return code: RFC_FAILURE(1)
    error group: 104
    key: RFC_ERROR_SYSTEM_FAILURE
Exception raised by myhost.com.ar|MULESOFT_IDOC_SEND_TEST
    at com.sap.conn.jco.rt.MiddlewareJavaRfc$JavaRfcServer.playbackTRfc(MiddlewareJavaRfc.java:2625)
    at com.sap.conn.jco.rt.MiddlewareJavaRfc$JavaRfcServer.handletRfcRequest(MiddlewareJavaRfc.java:2546)
    at com.sap.conn.jco.rt.MiddlewareJavaRfc$JavaRfcServer.listen(MiddlewareJavaRfc.java:2367)
    at com.sap.conn.jco.rt.DefaultServerWorker.dispatch(DefaultServerWorker.java:284)
    at com.sap.conn.jco.rt.DefaultServerWorker.loop(DefaultServerWorker.java:369)
    at com.sap.conn.jco.rt.DefaultServerWorker.run(DefaultServerWorker.java:245)
    at java.lang.Thread.run(Thread.java:680)
```

To resolve this error:

Set `rfcType` to `trfc` or `qrfc` in `<sap:inbound-endpoint />`.

### Parameter Not Supported

Because SAP extended properties must have valid names, if you provide an invalid property name, you
receive an error message similar to this one:

```text
Root Exception stack trace:
RfcException: [null]
message: Parameter 'type' not supported: 'f'
Return code: RFC_INVALID_PARAMETER(19)
error group: 101
key: RFC_ERROR_PROGRAM

at com.sap.conn.rfc.api.RfcOptions.checkParameters(RfcOptions.java:182)
at com.sap.conn.jco.rt.MiddlewareJavaRfc$JavaRfcClient.connect(MiddlewareJavaRfc.java:1328)
at com.sap.conn.jco.rt.ClientConnection.connect(ClientConnection.java:731)
+ 3 more (set debug level logging or '-Dmule.verbose.exceptions=true' for everything)
```

In this example, JCo libraries are reporting that the parameter with name `type` is not valid.

To resolve this error:

Provide a valid property name from JCo extended properties.

### Multiple JCo Servers Running

Two or more JCo servers cannot have the same set of configuration parameters, even if they have
different configuration names, so you receive the following error:

```text
ERROR 2012-07-05 10:11:30,525 [WrapperListener_start_runner] com.mulesoft.mule.transport.sap.SapMessageReceiver: Error connecting to server
com.sap.conn.jco.JCoException: (101) JCO_ERROR_CONFIGURATION: Server configuration for sapavalara-1.0-SNAPSHOT-gettax is already used for a running server
at com.sap.conn.jco.rt.StandaloneServerFactory.update(StandaloneServerFactory.java:358)
at com.sap.conn.jco.rt.StandaloneServerFactory.getServerInstance(StandaloneServerFactory.java:176)
at com.sap.conn.jco.server.JCoServerFactory.getServer(JCoServerFactory.java:74)
at com.mulesoft.mule.transport.sap.jco3.SapJcoRfcServer.initialise(SapJcoRfcServer.java:46)
at com.mulesoft.mule.transport.sap.jco3.SapJcoServerFactory.create(SapJcoServerFactory.java:60)
at com.mulesoft.mule.transport.sap.SapMessageReceiver.doConnect(SapMessageReceiver.java:56)
at org.mule.transport.AbstractTransportMessageHandler.connect(AbstractTransportMessageHandler.java:218)
at org.mule.transport.AbstractConnector.registerListener(AbstractConnector.java:1254)
```

> [!NOTE] This applies only to Mule applications running on the same Mule server. Nodes on a Mule
> server group do not have this limitation.

To resolve this error:

Use the following attributes to create the server group key (which determines the uniqueness of a
JCo server connection):

- `jco.server.gwhost`

- `jco.server.gwserv`

- `jco.server.progid`

You can start two servers in the same Mule instance (JCo keeps this information in a Singleton
class) only if they have different values for `gwhost`, `gwserv`, and `progid`.

## Understand Commonly Thrown Exceptions

Here is a list of commonly thrown exception messages and how to interpret them:

- SAP:CONNECTIVITY

  A connection cannot be established.

- SAP:INVALID\_CACHE

  The cache used internally by the JCo library is corrupted or can’t be read.

- SAP:INVALID\_INPUT

  User input cannot be parsed or is incorrect.

- SAP:METADATA\_UNAVAILABLE

  The metadata for an IDoc segment is unavailable.

- SAP:NOT\_FOUND

  A function or IDoc template cannot be found or retrieved.

- SAP:NOT\_SUPPORTED

  An action occurs that is not supported by any JCo handler.

- SAP:PARSING

  The JCo library has a parsing issue or the connector cannot convert XML to a BAPI function or an
  IDoc.

- SAP:RETRY\_EXHAUSTED

  Execution block retries are exhausted.

- SAP:SYSTEM\_BUSY

  The remote ABAP system is too busy to handle a request.

- SAP:TIMEOUT

  A timeout exception happens inside the JCo library.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [SAP Connector Reference](https://docs.mulesoft.com/sap-connector/latest/sap-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=607f36e867ae91e19b0099dc381f92487291aa8584859d42e33fb4fc5400f690 url=/mulesoft/current/en-us/sap-connector/latest/sap-connector-5-upgrade.md -->

---
product: SAP Connector
version: 5.9
is-latest-version: true
---

# Upgrading and Migrating to SAP Connector 5.x

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for SAP version 5.x has enhancements and changes. Some of the main changes
introduced in SAP Connector 5.x are:

- The `Create` operation is renamed to `Retrieve IDoc`.

- The execute BAPI functions over qRFC, tRFC, and sRFC operations are merged into Synchronous Remote
  Function Call (sRFC) and Asynchronous Remote Function Call (aRFC) operations.

- The `Disable function template cache` flag is renamed to `Disable JCo internal cache`, and applies
  to both functions and sources. The default value is `false`.

- The sources now have `-listener` in their aliases instead of `source`. For example, the XML is
  changed from `sap:document-source` to `sap:document-listener`.

- The SAP configuration has the following changes:

- The SAP Inbound and SAP Outbound configurations are merged into the new SAP configuration.

- The **Message Server** field is now in the **General** tab.  
  The new configuration makes understanding what configuration to use in the connector more
  intuitive.

These new features and enhancements may cause backward compatibility issues.

## Upgrade Steps

Follow these steps to perform the upgrade:

1.  In Anypoint Studio, create a Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange**.

3.  In **Add Dependencies to Project**, enter `sap` in the search field.

4.  In **Available modules**, select **SAP Connector - Mule 4** and click **Add**.

5.  Click **Finish**.

6.  Verify that the SAP Connector dependency version is 5.x.x in the `pom.xml` file in the Mule
    project, where `x.x` is the minor release and patch version number. For example, if you are
    upgrading to v5.2, the dependency version in the pom.xml file should be 5.2.0.

Studio upgrades the connector automatically.

### Verify the Upgrade

After you install the latest version of the connector, follow these steps to verify the upgrade:

1.  In Studio, verify that there are no errors in the **Problems** or **Console** views.

2.  Verify that there are no problems in the project `pom.xml` file.

3.  Test the connection to verify that the operations work.

### Revert the Upgrade

If it is necessary to revert to the previous version of SAP Connector, change the `sap-connector`
dependency version in the project’s `pom.xml` file to the previous version.

You must update the project’s `pom.xml` file in Anypoint Studio.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)