SAP Connector 5.8 Reference - Mule 4

String

Two-digit system number (sysnr) of the SAP system.

x

String

Three-digit client number. Leading zeros are preserved if they appear in the number.

x

String

Identifier of the destination generated by this connector. If none is set, a random value is created.

String

Language code used by the connector. The language determines the code page used for communicating between the SAP adapter and the application server.

EN

Object

Used to pass in all the database server-specific connection parameters.

String

Path to the X.509 certificate. This is required when the connector is working as a client.

String

Host of the SAP application server.

Message Server

Configuration for message server usage.

Boolean

Enables or disables RFC trace on the server.

false

Enumeration, one of:

Enables or disables CPIC trace on the server.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

Two-digit system number (sysnr) of the SAP system.

x

String

Three-digit client number. Leading zeros are preserved if they appear in the number.

x

String

Identifier of the destination generated by this connector. If none is set, a random value is created.

String

Language code used by the connector. The language determines the code page used for communicating between the SAP adapter and the application server.

EN

Object

Used to pass in all the database server-specific connection parameters.

String

Host of the SAP application server.

Message Server

Configuration for message server usage.

Boolean

Enables or disables RFC trace on the server.

false

Enumeration, one of:

Enables or disables CPIC trace on the server.

String

Path to the krb5.conf file.

x

String

Path to the keytab file.

x

String

Path to the gss library.

x

String

Principal that the connector uses to log in to SAP.

x

String

The jco.client.snc_partnername property.

x

String

The jco.client.snc_myname property.

x

String

The jco.server.snc_partnername property.

String

The jco.server.snc_myname property.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

Two-digit system number (sysnr) of the SAP system.

x

String

Three-digit client number. Leading zeros are preserved if they appear in the number.

x

String

Identifier of the destination generated by this connector. If none is set, a random value is created.

String

Language code used by the connector. The language determines the code page used for communicating between the SAP adapter and the application server.

EN

Object

Used to pass in all the database server-specific connection parameters.

String

Username the connector uses to log in to SAP.

x

String

Password associated with the login username.

x

String

Host of the SAP application server.

Message Server

Configuration for message server usage.

Boolean

Enables or disables RFC trace on the server.

false

Enumeration, one of:

Enables or disables CPIC trace on the server.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

String

Name of the configuration to use.

x

String

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.

x

String

Either the name or service port for the gateway service of the SAP system.

x

String

SAP system program ID that is registered on the gateway. Must be unique for the given gateway.

x

Number

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.

1

String

Expression to filter all incoming IDocs by type.

String

Expression to filter all incoming IDocs by type extension.

String

Host of the message server.

String

Message server name or port number.

String

System ID of the system the message server belongs to.

String

Logon group defined in ABAP that identifies a set of application servers.

String

How often the message server fetches the list of application servers.

IDoc Render Parameter Group

IDoc rendering options.

String

Canonical name of the encoding. Refer to Oracle’s supported encodings.

Enumeration, one of:

Type of beginning action that sources take regarding transactions.

NONE

Enumeration, one of:

Type of transaction to create. Availability depends on Mule version.

LOCAL

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

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.

x

String

Either the name or service port for the gateway service of the SAP system.

x

String

SAP system program ID that is registered on the gateway. Must be unique for the given gateway.

x

Number

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.

1

String

Name of the function to receive. Filters the incoming BAPI functions by their names.

String

Host of the message server.

String

Message server name or port number.

String

System ID of the system the message server belongs to.

String

Logon group defined in ABAP that identifies a set of application servers.

String

How often the message server fetches the list of application servers.

String

Canonical name of the encoding. Refer to Oracle’s supported encodings.

Enumeration, one of:

Type of beginning action that sources take regarding transactions.

NONE

Enumeration, one of:

Type of transaction to create. Availability depends on Mule version.

LOCAL

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

Binary

Source response.

#[payload]

String

Name of the configuration to use.

x

String

Name of the function to execute.

x

Binary

BAPIFunction to execute.

#[payload]

String

ID that identifies an RFC so that the RFC runs only once.

x

String

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.

String

Canonical name of the encoding. Refer to Oracle’s supported encodings.

Enumeration, one of:

Type of joining action that operations take regarding transactions.

JOIN_IF_POSSIBLE

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

ID of the transaction to confirm.

x

Enumeration, one of:

Type of joining action that operations take regarding transactions.

JOIN_IF_POSSIBLE

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the function to retrieve.

x

String

Canonical name of the encoding. Refer to Oracle’s supported encodings.

Enumeration, one of:

Type of joining action that operations take regarding transactions.

JOIN_IF_POSSIBLE

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Key that contains the required information to retrieve the IDoc.

x

String

Canonical name of the encoding. Refer to Oracle’s supported encodings.

Enumeration, one of:

Type of joining action that operations take regarding transactions.

JOIN_IF_POSSIBLE

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the IDoc to execute.

x

Binary

IDoc to execute.

#[payload]

String

Version on the IDoc.

String

ID that identifies an RFC so that the RFC runs only once.

String

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.

IDoc Parse Parameter Group

IDoc parsing options.

String

Canonical name of the encoding. Refer to Oracle’s supported encodings.

Enumeration, one of:

Type of joining action that operations take regarding transactions.

JOIN_IF_POSSIBLE

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

Type of joining action that operations take regarding transactions.

JOIN_IF_POSSIBLE

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the function to execute.

x

Binary

BAPIFunction to execute.

#[payload]

String

Canonical name of the encoding. Refer to Oracle’s supported encodings.

Enumeration, one of:

Type of joining action that operations take regarding transactions.

JOIN_IF_POSSIBLE

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Enumeration, one of:

Time unit for the Max Idle Time field.

Boolean

Indicates whether to enable the field value checking mechanism in accordance with the respective IDoc field metadata when parsing.

false

Boolean

Indicates whether to ignore unknown fields when parsing, for example, when parsing with older IDoc metadata.

false

Boolean

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.

false

Boolean

Indicates whether to disable the field data type checking mechanism in accordance with the respective IDoc field metadata when parsing.

false

Boolean

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.

false

Boolean

Indicates whether to refuse XML documents that don’t use XML specification version 1.0 or that don’t contain an XML declaration header.

false

Boolean

Indicates whether to refuse XML documents that use XML specification version 1.1.

false

Boolean

Indicates whether to accept only XML documents that use XML specification version 1.0 or that don’t contain an XML declaration header.

false

Boolean

Indicates whether to accept only XML documents that use XML specification version 1.1 or that don’t contain an XML declaration header.

false

Boolean

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.

false

Boolean

Indicates whether to include all empty tags in the resulting XML document.

false

Boolean

Indicates whether to ignore character range check errors in accordance with the used XML specification version.

false

Boolean

Indicates whether to ignore escape character errors within XML tags in accordance with the used IDocXML format

false

Boolean

Indicates whether to omit the XML declaration section in the resulting XML document.

false

Boolean

Indicates whether to write an optional XML encoding declaration attribute into the resulting XML document.

false

Boolean

Indicates whether to substitute invalid characters within IDoc field values with the number sign # (U+0023).

false

Boolean

Indicates whether to insert CR (Carriage Return) characters into the resulting XML document.

false

Boolean

Indicates whether to insert CR+LF (Carriage Return and Line Feed) characters into the resulting XML document.

false

Boolean

Indicates whether to insert LF (Line Feed) characters into the resulting XML document.

false

Boolean

Indicates whether to insert TAB and CR (Tab and Carriage Return) characters into the resulting XML document.

false

Boolean

Indicates whether to insert TAB and CR+LF (Tab, Carriage Return and Line Feed) characters into the resulting XML document.

false

Boolean

Indicates whether to insert TAB and LF (Tab and Line Feed) characters into the resulting XML document.

false

Boolean

Indicates whether to create an XML document compliant with XML specification version 1.0.

false

Boolean

Indicates whether to create an XML document compliant with XML specification version 1.1.

false

String

Host of the message server.

x

String

System ID of the SAP system.

x

Number

Port with which the connector logs into the message server.

String

Group of SAP application servers.

String

SAP router string to use for a system protected by a firewall.

Number

How often to attempt to reconnect, in milliseconds.

Number

How many reconnection attempts the Mule app can make.

Number

How often to attempt to reconnect, in milliseconds.

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

Reconnection strategy to use.

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

String

One or more expressions that determine when a message was redelivered. This property can be set only if the Use Secure Hash field is false.

Object Store

Configures the object store that stores the redelivery counter for each message.

Number

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:

Enumeration, one of:

Unit for the In Memory Size field.

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Number

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.

Enumeration, one of:

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

String

Transaction ID value.