Contact Free trial Login
All Connectors

SAP Connector Reference 4.5

Support Category: Premium

SAP Connector v4.5

Anypoint Connector for SAP (SAP Connector) provides a class that has an overall configuration for the SAP extension.

Release Notes: SAP Connector Release Notes

Configurations

Inbound

Configure the default configuration for SAP extension inbound elements.

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Simple Connection Provider

The connection types to provide to this configuration

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Encoding

String

Canonical name of the encoding. See Oracle’s supported encodings at https://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html.

Connection Types

Simple Connection Provider

Use these parameters to configure the connection provider that connects to the SAP system using a username and password.

Parameters
Name Type Description Default Value Required

SAP system number

String

The two-digit system number (sysnr) of the SAP system

x

SAP client ID

String

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

x

Destination Name

String

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

Login language

String

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

EN

Extended Properties

Object

Use to pass in all the database server-specific connection parameters

SAP username

String

The username the connector uses to log in to SAP

x

SAP password

String

The password associated with the login username

x

Application server host

String

The host of the SAP application server

Message server configuration

Message Server

The configuration for message server usage

Enable RFC tracing on server

Boolean

Enable or disable RFC trace on the server

false

Enable CPIC tracing on server

Enumeration, one of:

  • INHERIT

  • NO_TRACING

  • LEVEL_1

  • LEVEL_2

  • LEVEL_3

Enable or disable RFC trace on the server

Reconnection

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.

Associated Sources

Outbound

Default configuration for SAP extension outbound elements.

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Encoding

String

Canonical name of the encoding. See Oracle’s supported encodings at https://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html.

Default IDoc Version

String

Default IDoc version.

0

Disable Function Template Cache Flag

Boolean

Flag that indicates if the function template cache should be disabled.

false

Evaluate Response Flag

Boolean

Flag that indicates if an error response should throw an exception or let the user handle it as another result.

false

Log Trace Flag

Boolean

Flag that indicates if the trace should be logged on the Mule server.

false

Use SAP Format

Boolean

This parameter supports the Mule 3 format for returning SAP values. Used in the JCoToBusinessObjectParser class when parsing a JCo field. When set to true, it specifies that values should be returned as strings with the original SAP format. When set to false, the original values are converted to the corresponding Java objects, serialized, and returned.

false

Operation Timeout

Number

Timeout for operations in milliseconds. 0 means indefinite waiting.

0

Connection Types

Certificate

Connection provider that relies on the usage of a X509 certificate to authenticate the user.

Parameters
Name Type Description Default Value Required

SAP system number

String

The two-digit system number (sysnr) of the SAP system.

x

SAP client ID

String

Three-digit client number. Preserve leading zeros if they appear in the number.

x

Destination Name

String

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

Login language

String

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

EN

Extended Properties

Object

Use to pass in all the database server-specific connection parameters

X.509 Certificate

String

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

Application server host

String

The host of the SAP application server

Message server configuration

Message Server

The configuration for message server usage

Enable RFC tracing on server

Boolean

Enable or disable RFC trace on the server

false

Enable CPIC tracing on server

Enumeration, one of:

  • INHERIT

  • NO_TRACING

  • LEVEL_1

  • LEVEL_2

  • LEVEL_3

Enable/disable RFC trace on the server.

Reconnection

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.
Simple Connection Provider

Connection provider that connects using a username and password.

Parameters
Name Type Description Default Value Required

SAP system number

String

The two-digit system number (sysnr) of the SAP system.

x

SAP client ID

String

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

x

Destination Name

String

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

Login language

String

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

EN

Extended Properties

Object

Use to pass in all the database server-specific connection parameters

SAP username

String

The username the connector uses to log in to SAP

x

SAP password

String

The password associated with the login username

x

Application server host

String

The host of the SAP application server

Message server configuration

Message Server

The configuration for message server usage

Enable RFC tracing on server

Boolean

Enable or disable RFC trace on the server

false

Enable CPIC tracing on server

Enumeration, one of:

  • INHERIT

  • NO_TRACING

  • LEVEL_1

  • LEVEL_2

  • LEVEL_3

Enable or disable RFC trace on the server

Reconnection

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.

Operations

Confirm transaction

<sap:confirm-transaction-id>

Configure this operation to confirm a determined transaction.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Transaction ID (TID)

String

The ID of the transaction to confirm

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions

JOIN_IF_POSSIBLE

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SAP:CONNECTIVITY

  • SAP:RETRY_EXHAUSTED

Create IDoc

<sap:create-idoc>

Configure this operation to retrieve an IDoc based on its key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Key

String

The key that contains the required information to retrieve the IDoc

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions

JOIN_IF_POSSIBLE

Streaming Strategy

Configure to use repeatable streams

Target Variable

String

The name of a variable to store the operation’s output

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations

Throws

  • SAP:BEGIN_TRANSACTION_ERROR

  • SAP:COMMIT_TRANSACTION_ERROR

  • SAP:CONFIG_ERROR

  • SAP:CONFIRM_TRANSACTION_ERROR

  • SAP:CONNECTION_ERROR

  • SAP:CONNECTIVITY

  • SAP:EXECUTION_ERROR

  • SAP:FIELD_NOT_FOUND_ERROR

  • SAP:INVALID_CREDENTIALS_ERROR

  • SAP:INVALID_HOST_ERROR

  • SAP:MISSING_BUSINESS_OBJECT_ERROR

  • SAP:RETRY_EXHAUSTED

  • SAP:ROLLBACK_TRANSACTION_ERROR

  • SAP:TID_CREATION_ERROR

  • SAP:UNKNOWN

  • SAP:XML_PARSING_ERROR

Start SAP transaction

<sap:create-transaction-id>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions

JOIN_IF_POSSIBLE

Target Variable

String

The name of a variable to store the operation’s output

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SAP:BEGIN_TRANSACTION_ERROR

  • SAP:COMMIT_TRANSACTION_ERROR

  • SAP:CONFIG_ERROR

  • SAP:CONFIRM_TRANSACTION_ERROR

  • SAP:CONNECTION_ERROR

  • SAP:CONNECTIVITY

  • SAP:EXECUTION_ERROR

  • SAP:FIELD_NOT_FOUND_ERROR

  • SAP:INVALID_CREDENTIALS_ERROR

  • SAP:INVALID_HOST_ERROR

  • SAP:MISSING_BUSINESS_OBJECT_ERROR

  • SAP:RETRY_EXHAUSTED

  • SAP:ROLLBACK_TRANSACTION_ERROR

  • SAP:TID_CREATION_ERROR

  • SAP:UNKNOWN

  • SAP:XML_PARSING_ERROR

Execute BAPI / Function over qRFC

<sap:execute-queued-remote-function-call>

Executes a BAPI function over a queued Remote Function Call (qRFC). A queued RFC is an extension of a transactional RFC (tRFC) that ensures that individual steps are processed in sequence. To guarantee that multiple Logical Unit of Work (LUWs) 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).

Use qRFC to extend tRFC and define the processing sequence. qRFC is recommended if you want to guarantee that several transactions are processed in a predefined order.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Key

String

The name of the BAPI function to execute

x

Content

Binary

The BAPI function to execute.

#[payload]

Transaction Id

String

The ID that identifies an RFC so it runs only once

Queue Name

String

The name of the queue on which the RFC executes

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions

JOIN_IF_POSSIBLE

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SAP:BEGIN_TRANSACTION_ERROR

  • SAP:COMMIT_TRANSACTION_ERROR

  • SAP:CONFIG_ERROR

  • SAP:CONFIRM_TRANSACTION_ERROR

  • SAP:CONNECTION_ERROR

  • SAP:CONNECTIVITY

  • SAP:EXECUTION_ERROR

  • SAP:FIELD_NOT_FOUND_ERROR

  • SAP:INVALID_CREDENTIALS_ERROR

  • SAP:INVALID_HOST_ERROR

  • SAP:MISSING_BUSINESS_OBJECT_ERROR

  • SAP:RETRY_EXHAUSTED

  • SAP:ROLLBACK_TRANSACTION_ERROR

  • SAP:TID_CREATION_ERROR

  • SAP:UNKNOWN

  • SAP:XML_PARSING_ERROR

Execute BAPI function over sRFC

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

Executes a BAPI function over a synchronous Remote Function Call (sRFC). A synchronous RFC requires that both the client and server systems are available at the time of communication or data transfer. A synchronous RFC is the most common type and is used when a result is required immediately after the sRFC is executed.

Use sRFC when communication between source and target systems requires acknowledgments. The resources of the source system wait at the target system and ensure that the message or data is delivered with an acknowledgment (ACKD) and that 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 may cause the processes of the source system to go into Sleep/RFC/CPIC mode at the target systems and block the resources.

sRFC is best used for:

  • Communication between systems

  • Communication between the SAP Web Application Server to the SAP GUI

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Key

String

The name of the function to execute

x

Content

Binary

The BAPI function to execute

#[payload]

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions

JOIN_IF_POSSIBLE

Streaming Strategy

Configure to use repeatable streams

Target Variable

String

The name of a variable to store the operation’s output

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations

Throws

  • SAP:BEGIN_TRANSACTION_ERROR

  • SAP:COMMIT_TRANSACTION_ERROR

  • SAP:CONFIG_ERROR

  • SAP:CONFIRM_TRANSACTION_ERROR

  • SAP:CONNECTION_ERROR

  • SAP:CONNECTIVITY

  • SAP:EXECUTION_ERROR

  • SAP:FIELD_NOT_FOUND_ERROR

  • SAP:INVALID_CREDENTIALS_ERROR

  • SAP:INVALID_HOST_ERROR

  • SAP:MISSING_BUSINESS_OBJECT_ERROR

  • SAP:RETRY_EXHAUSTED

  • SAP:ROLLBACK_TRANSACTION_ERROR

  • SAP:TID_CREATION_ERROR

  • SAP:UNKNOWN

  • SAP:XML_PARSING_ERROR

Execute BAPI function over tRFC

<sap:execute-transactional-remote-function-call>

Executes a BAPI function over a Transactional Remote Function Call (tRFC). A tRFC is a special form of asynchronous Remote Function Call (aRFC). Transactional RFC ensures transaction-like handling of processing steps that were originally autonomous.

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 when the RFC client program is executing a tRFC. The tRFC component stores the called RFC function, together with the corresponding data, in the SAP database under a unique transaction ID (TID).

tRFC is similar to aRFC as it does not wait at the target system (similar to a registered post). If the system is not available, it writes the data into aRFC tables with a transaction ID (SM58), which is picked by the scheduler RSARFCSE and runs every 60 seconds).

tRFC is best used for:

  • Extension of asynchronous RFC

  • Secure communication between systems

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Key

String

The name of the function to execute

x

Content

Binary

The BAPIFunction to execute

#[payload]

Transaction Id

String

The ID that identifies an RFC so it runs only once

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions

JOIN_IF_POSSIBLE

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SAP:BEGIN_TRANSACTION_ERROR

  • SAP:COMMIT_TRANSACTION_ERROR

  • SAP:CONFIG_ERROR

  • SAP:CONFIRM_TRANSACTION_ERROR

  • SAP:CONNECTION_ERROR

  • SAP:CONNECTIVITY

  • SAP:EXECUTION_ERROR

  • SAP:FIELD_NOT_FOUND_ERROR

  • SAP:INVALID_CREDENTIALS_ERROR

  • SAP:INVALID_HOST_ERROR

  • SAP:MISSING_BUSINESS_OBJECT_ERROR

  • SAP:RETRY_EXHAUSTED

  • SAP:ROLLBACK_TRANSACTION_ERROR

  • SAP:TID_CREATION_ERROR

  • SAP:UNKNOWN

  • SAP:XML_PARSING_ERROR

Get Function

<sap:get-function>

This operation retrieves a BAPIFunction based on its name.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Key

String

The name of the function to retrieve

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions

JOIN_IF_POSSIBLE

Streaming Strategy

Configure to use repeatable streams

Target Variable

String

The name of a variable to store the operation’s output

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations

Throws

  • SAP:BEGIN_TRANSACTION_ERROR

  • SAP:COMMIT_TRANSACTION_ERROR

  • SAP:CONFIG_ERROR

  • SAP:CONFIRM_TRANSACTION_ERROR

  • SAP:CONNECTION_ERROR

  • SAP:CONNECTIVITY

  • SAP:EXECUTION_ERROR

  • SAP:FIELD_NOT_FOUND_ERROR

  • SAP:INVALID_CREDENTIALS_ERROR

  • SAP:INVALID_HOST_ERROR

  • SAP:MISSING_BUSINESS_OBJECT_ERROR

  • SAP:RETRY_EXHAUSTED

  • SAP:ROLLBACK_TRANSACTION_ERROR

  • SAP:TID_CREATION_ERROR

  • SAP:UNKNOWN

  • SAP:XML_PARSING_ERROR

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 tRFC is a special form of asynchronous Remote Function Call (aRFC). Transactional RFC 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 some 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, together with the corresponding data, in the SAP database under a unique transaction ID (TID).
    tRFC is similar to aRFC in that 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 run every 60 seconds.
    tRFC is best used for:

    • Extension of asynchronous RFC

    • Secure communication between systems

  • Queued (qRFC): A queued RFC is an extension of tRFC. tRFC can be serialized using inbound and outbound queues, hence the name queued RFC (qRFC). It also 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.
    qRFC is best used as an extension of tRFC to define a processing sequence. Implementation of qRFC is recommended if you want to guarantee that several transactions are processed in a predefined order.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Key

String

The name of the iDocument to execute

x

Content

Binary

The IDoc to execute

#[payload]

Version

String

The version on the IDoc

Transaction Id

String

The ID that identifies an RFC so it runs only once

Queue Name

String

The name of the queue on which the RFC executes.

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions

JOIN_IF_POSSIBLE

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SAP:BEGIN_TRANSACTION_ERROR

  • SAP:COMMIT_TRANSACTION_ERROR

  • SAP:CONFIG_ERROR

  • SAP:CONFIRM_TRANSACTION_ERROR

  • SAP:CONNECTION_ERROR

  • SAP:CONNECTIVITY

  • SAP:EXECUTION_ERROR

  • SAP:FIELD_NOT_FOUND_ERROR

  • SAP:INVALID_CREDENTIALS_ERROR

  • SAP:INVALID_HOST_ERROR

  • SAP:MISSING_BUSINESS_OBJECT_ERROR

  • SAP:RETRY_EXHAUSTED

  • SAP:ROLLBACK_TRANSACTION_ERROR

  • SAP:TID_CREATION_ERROR

  • SAP:UNKNOWN

  • SAP:XML_PARSING_ERROR

Sources

Document Source

<sap:document-source>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Operation Timeout

Number

Timeout for operations. This is a positive value in milliseconds. A value of 0 means indefinite waiting.

x

Gateway Host

String

Name of the host running the gateway server

x

Gateway Service

String

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

x

Program ID

String

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

x

Connection Count

Number

The number of connections to register on the gateway

1

Transactional Action

Enumeration, one of:

  • ALWAYS_BEGIN

  • NONE

The type of beginning action that sources can take regarding transactions.

NONE

Transaction Type

Enumeration, one of:

  • LOCAL

  • XA

The type of transaction to create. Availability depends on Mule version.

LOCAL

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Streaming Strategy

Configure to use repeatable streams.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Binary

Attributes Type

SAP Attributes

For Configurations

Function Source

<sap:function-source>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation Timeout

Number

Timeout for operations. This is a positive value in milliseconds. A value of 0 means indefinite waiting.

x

Gateway Host

String

Name of the host running the gateway server.

x

Gateway Service

String

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

x

Program ID

String

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

x

Connection Count

Number

The number of connections to register on the gateway.

1

Targeted Function

String

Filters the incoming BAPI functions by their names. The name of the function you want to receive.

Transactional Action

Enumeration, one of:

  • ALWAYS_BEGIN

  • NONE

The type of beginning action that sources can take regarding transactions

NONE

Transaction Type

Enumeration, one of:

  • LOCAL

  • XA

The type of transaction to create. Availability depends on Mule version.

LOCAL

Primary Node Only

Boolean

Whether this source should be executed only on the primary node when running in a cluster

Streaming Strategy

Configure to use repeatable streams.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Response

Binary

#[payload]

Output

Type

Binary

Attributes Type

SAP Attributes

For Configurations

Types

Message Server

Field Type Description Default Value Required

Host

String

The host of the message server

x

System Id

String

System ID of the SAP system

x

Port

Number

The port with which the connector logs into the message server

Group

String

Group of SAP application servers

Router

String

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

Reconnection

The Reconnection Strategy settings are not enabled. Although disabled, reconnection is automatic when a computer running SAP Connector is disconnected and reconnected. Reconnection occurs based on default conditions established in the SAP JCo libraries. However, if the computer is accessing the SAP instance via VPN, reconnection fails and SAP Connector displays TIMEOUT and CANNOT_SEND_IDOC errors.

Field Type Description Default Value Required

Fails Deployment

Boolean

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.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

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

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

SAP Attributes

Field Type Description Default Value Required

Transaction Id

String

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the data in this stream is larger than the buffer size, then the buffer expands according to the Buffer size increment attribute, with an upper limit of Max in Memory Size.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max in Memory Size

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.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which Max in Memory Size is expressed

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed-message

Use Secure Hash

Boolean

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

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is used.

SHA-256

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property can be set only if Use secure hash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is stored

See Also

MuleSoft Help Center