SAP

SAP Application Server and Message Server messages

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Enterprise All Logic Apps regions and Integration Service Environments (ISEs)
Contact
Name Microsoft
URL https://support.microsoft.com/
Email abapi@microsoft.com
Connector Metadata
Publisher Microsoft
Website https://www.sap.com/index.html
Privacy policy https://www.sap.com/about/legal/privacy.html
Categories IT Operations

Connector in-depth

For more information about the connector, see the in-dept section.

General Limits

Name Value
Maximum request body size for send message operation (in KB) when using On-Premises Data Gateway 2560
Maximum request body size for send message operation (in KB) when using ISE without On-Premises Data Gateway 102400
Request timeout in seconds for runtime requests 115
Request timeout in seconds for design time requests 20

Creating a connection

The connector supports the following authentication types:

Default Required parameters for creating connection. All regions

Default

Applicable: All regions

Required parameters for creating connection.

Name Type Description
Gateway gatewaySetting On-prem gateway (see https://docs.microsoft.com/data-integration/gateway for more details)
Client int The SAP client ID to connect to the SAP system.
Authentication Type string Authentication type to connect to the SAP System. Must be basic (username and password).
SAP Username securestring The username to be used for log in to the SAP System.
SAP Password securestring The password to be used for log in to the SAP System.
Logon Type string The type of logon to the SAP System, either Application Server Logon (Type A) or Group Logon (Type B aka Message Server).
AS Host string The hostname of the SAP Application Server.
AS Service string The service name or port number of the SAP Application Server.
AS System Number int The SAP System's System Number. It is a number ranging from 00 to 99.
MS Server Host string The hostname of the SAP Message Server aka R3 System Name.
MS Service Name or Port Number string The service name or port number of the Message Server.
MS System ID string The System ID of the SAP system.
MS Logon Group string The Logon Group for the SAP System.
Safe Typing bool Use strong types if false, otherwise use string as safe type.
Use SNC bool When selected, the connections will be secured with SNC.
SNC Library string Name or path of the SNC library to be used.
SNC SSO string The SNC SSO specifies whether to use SNC identity or credentials provided on RFC level.
SNC My Name string Identity to be used for this particular destination/server (optional).
SNC Partner Name string The backend's SNC name.
SNC Quality of Protection string Quality of Service to be used for SNC communication of this particular destination/server.
SNC Certificate string Base64 encoded X.509 certificate.

Throttling Limits

Name Calls Renewal Period
API calls per connection250060 seconds

Actions

Call BAPI (Preview)

Calls the BAPI method on the SAP system.

Call RFC (Preview)

Calls an sRFC, tRFC or qRFC on the SAP system.

Close stateful session (Preview)

Closes an existing stateful connection session to the SAP system.

Commit BAPI transaction (Preview)

Commits the BAPI transaction for the given session.

Confirm transaction Id (Preview)

Sends transaction Id confirmation to SAP.

Create stateful session (Preview)

Creates a stateful connection session to the SAP system.

Generate schemas

Generates XML schemas for the provided SAP action or URI.

Get IDOC status from IDOC number (Preview)

Get IDOC status from IDOC number.

Get IDOCs list for the transaction (Preview)

Gets the list of IDOCs for the transaction identified by either session identifier GUID or transaction identifier (TID).

Read an SAP table (Preview)

The user must have access to 'BBP_RFC_READ_TABLE' or 'RFC_READ_TABLE' RFC to use this action.

Rollback BAPI transaction (Preview)

Rollbacks the BAPI transaction for the given session.

Send IDOC (Preview)

Sends IDOC message to SAP.

Send message to SAP

Sends any message type RFC, BAPI, IDOC to SAP.

Call BAPI (Preview)

Calls the BAPI method on the SAP system.

Parameters

Name Key Required Type Description
Business Object
businessObject True string

The Business object type, e.g. 'BANKDETAIL'.

Method
method True string

The method to be called, e.g. 'CREATE', followed by the implementing BAPI method, separated by ':' character.

Auto commit
autoCommit boolean

Automatically commits the BAPI transaction if SAP BAPI response has no error. Automatically rollback the BAPI transaction if SAP BAPI response has an error.

Session Id
sessionId string

The optional stateful session Id as a string. If none is provided, the call is made on a stateless connection.

Input BAPI parameters
body True binary

Input BAPI parameters to call SAP or URI to storage blob containing the BAPI parameters.

Content-Type
Content-Type string

Specify content-type of the request payload.

Returns

Result for Call BAPI operation.

Call RFC (Preview)

Calls an sRFC, tRFC or qRFC on the SAP system.

Parameters

Name Key Required Type Description
RFC name
rfcName True string

The RFC to be called, e.g. 'STFC_CONNECTION'.

RFC Group filter
rfcGroupFilter string

The optional RFC group filter, e.g. 'STFC', to filter the RFCs.

Auto commit
autoCommit boolean

Automatically commits the RFC transaction if adding the qRFC/tRFC to the transaction has no error. Auto-commit only takes effect if either {tId} or {queueName} is provided.

Session Id
sessionId string

The optional stateful session Id as a string for stateful RFC. If no session Id is provided, the call is made on a stateless connection.

Input RFC parameters
body True binary

Input RFC parameters to call SAP or URI to storage blob containing the RFC parameters.

Content-Type
Content-Type string

Specify content-type of the request payload.

Returns

Result for Call RFC operation.

Close stateful session (Preview)

Closes an existing stateful connection session to the SAP system.

Parameters

Name Key Required Type Description
Session Id
sessionId True string

The stateful session Id as a string.

Returns

response
object

Commit BAPI transaction (Preview)

Commits the BAPI transaction for the given session.

Parameters

Name Key Required Type Description
Session Id
sessionId True string

The stateful session Id as a string.

Wait for synchronous update
wait boolean

Wait for synchronous updating completion.

Close the session
closeSession boolean

Closes the stateful connection session.

Returns

SAP BAPI return structure version 2 aka BAPIRET2

Body
BapiRet2

Confirm transaction Id (Preview)

Sends transaction Id confirmation to SAP.

Parameters

Name Key Required Type Description
Transaction Id
tid True string

The transaction Id in GUID string format.

Returns

response
object

Create stateful session (Preview)

Creates a stateful connection session to the SAP system.

Returns

Result for Create Session operation.

Generate schemas

Generates XML schemas for the provided SAP action or URI.

Parameters

Name Key Required Type Description
ActionUri
string
File name prefix
fileNamePrefix string

Prefix for the schema file names.

Returns

Generate Schemas Response

Get IDOC status from IDOC number (Preview)

Get IDOC status from IDOC number.

Parameters

Name Key Required Type Description
IDOC number
idocNumber True integer

The IDOC number for which to fetch the status.

Returns

Result for get status for IDOC operation.

Get IDOCs list for the transaction (Preview)

Gets the list of IDOCs for the transaction identified by either session identifier GUID or transaction identifier (TID).

Parameters

Name Key Required Type Description
Direction
direction True string

Whether the IDOC to look for was sent or received by SAP.

Transaction Id
tId True string

The transaction Id formatted as either GUID or 24-characters string.

Returns

List of IDOC numbers.

Read an SAP table (Preview)

The user must have access to 'BBP_RFC_READ_TABLE' or 'RFC_READ_TABLE' RFC to use this action.

Parameters

Name Key Required Type Description
Table name
tableName True string

The name of the SAP table to read.

Fields to read
fieldNames array

The list of fields to read. If not provided, all fields will be read but the row size may then exceed the maximum length permitted by SAP.

Where filters
whereFilters array

The list of where filter clauses, e.g. "MTART = 'ROH' AND MEINS = 'PAK'".

Starting row index
startIndex integer

Starting row index, e.g. 0.

Count of rows to read
rowCount integer

The count of rows to read, e.g. 10. Use 0 if you only want to get the fields metadata.

Field delimiter
delimiter string

The optional delimiter to insert between row fields data.

Returns

Result for Read Table operation.

Rollback BAPI transaction (Preview)

Rollbacks the BAPI transaction for the given session.

Parameters

Name Key Required Type Description
Session Id
sessionId True string

The stateful session Id as a string.

Close the session
closeSession boolean

Closes the stateful connection session.

Returns

SAP BAPI return structure version 2 aka BAPIRET2

Body
BapiRet2

Send IDOC (Preview)

Sends IDOC message to SAP.

Parameters

Name Key Required Type Description
IDOC type with optional extension
idocType True string

The IDOC (basic) type, e.g. 'DELVRY01', and the optional IDOC type extension, aka enhancement, aka CIM type.

SAP release version
releaseVersion string

The SAP release version, e.g. 720. If none is provided, the current system version will be selected.

Record types version
recordTypesVersion string

The IDOC record types version, '2' or '3'.

Confirm TID
confirmTid boolean

Confirm the Transaction Id automatically, 'true' or 'false'.

Transaction Id GUID
tid string

The optional Transaction Id GUID as a string. If none is provided, a new GUID will be generated.

Input IDOC message
body True binary

Input IDOC message to SAP or URI to storage blob containing the IDOC message.

Content-Type
Content-Type string

Specify content-type of the request payload.

Returns

Result for Send IDOC operation.

Send message to SAP

Sends any message type RFC, BAPI, IDOC to SAP.

Parameters

Name Key Required Type Description
SAP Action
sapAction True string

SAP Action.

Input Message
body True binary

Input Message to SAP or URI to storage blob containing the message.

Content-Type
Content-Type string

Specify content-type of the request payload.

Returns

response
object

Triggers

When a message is received

When a message is received from SAP.

When a message is received

When a message is received from SAP.

Parameters

Name Key Required Type Description
GatewayHost
gatewayHost True string

SAP RFC server registration gateway host.

GatewayService
gatewayService True string

SAP RFC server registration gateway service.

ProgramId
programId True string

SAP RFC server registration gateway program id.

SapActions
SapActions string
IDOC Format
IdocFormat string

Format in which to receive IDOCs

Receive IDOCs with unreleased segments
ReceiveIdocsWithUnreleasedSegments boolean

Whether to receive IDOCs with unreleased segments or not

SncPartnerNames
sncPartnerNames string

A vertical bar (|) separated list of SNC partner names.

DegreeOfParallelism
degreeOfParallelism integer

How many calls to process in parallel.

Returns

Definitions

Object

SendIdocResponse

Result for Send IDOC operation.

Name Path Type Description
Transaction Id
TransactionID string

Transaction Id GUID for the IDOC tRFC.

CallBapiResponse

Result for Call BAPI operation.

Name Path Type Description
BapiReturn
BapiReturn BapiRet2

SAP BAPI return structure version 2 aka BAPIRET2

BAPI Returns
BapiReturns array of BapiRet2

BAPI return structures

XML Response
XmlResponse string

XML Response to the BAPI call

JsonResponse
JsonResponse Object

BapiRet2

SAP BAPI return structure version 2 aka BAPIRET2

Name Path Type Description
Type
Type string

Message type

Id
Id string

Message Class

Number
Number string

Message Number

Message
Message string

Message Text

LogNumber
LogNumber string

Application log: log number

LogMessageNumber
LogMessageNumber string

Application log: Internal message serial number

MessageVariable1
MessageVariable1 string

Message Variable 1

MessageVariable2
MessageVariable2 string

Message Variable 2

MessageVariable3
MessageVariable3 string

Message Variable 3

MessageVariable4
MessageVariable4 string

Message Variable 4

Parameter
Parameter string

Parameter Name

Row
Row integer

Lines in parameter

Field
Field string

Field in parameter

System
System string

Logical system from which message originates

CallRfcResponse

Result for Call RFC operation.

Name Path Type Description
XML Response
XmlResponse string

XML Response to the RFC call

JsonResponse
JsonResponse Object

IdocNumbersList

List of IDOC numbers.

Name Path Type Description
IDOC numbers
IdocNumbers array of integer

List of IDOC numbers

IdocStatusResponse

Result for get status for IDOC operation.

Name Path Type Description
IDOC status code
IdocStatus integer

IDOC status code

ReadTableResponse

Result for Read Table operation.

Name Path Type Description
XML Response
XmlResponse string

XML Response to the Read Table RFC call

Fields metadata
FieldsMetadata array of FieldMetadata

Fields metadata

Rows
Rows array of string

Rows

FieldMetadata

Field metadata

Name Path Type Description
Field name
Name string

Field name

Field offset
Offset integer

Field start offset

Field length
Length integer

Field length

ABAP data type
AbapDataType string

Field ABAP data type

Field description
Description string

Field description

CreateSessionResponse

Result for Create Session operation.

Name Path Type Description
Session Id
SessionId string

Id for the stateful session.

SapConnectorGenerateSchemasResponse

Generate Schemas Response

Name Path Type Description
Schemas
Schemas array of SapConnectorSchema

The list of generated schemas.

SapConnectorSchema

SAP schema.

Name Path Type Description
Name
Name string

The schema name.

Content
Content byte

The base-64 encoded schema content.

ListenerRequest

Name Path Type Description
ActionUri
ActionUri string
Content
Content string

object

This is the type 'object'.