SAP Connector Reference 4.2
SAP Connector v4.2
Class that has an overall configuration for the SAP extension.
Release Notes: SAP Connector Release Notes
Inbound Configuration
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 |
The connection types to provide to this configuration. |
x |
||
Expiration Policy |
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 it sees fit. |
|||
Encoding |
String |
Canonical name of an encoding. See Oracle’s Supported Encodings. |
Inbound Connection Types
Simple Connection Provider
Connection provider that connects using 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. 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 |
Code of the language used by the connector. The language determines the code page used for communicating between SAP Adapter and the application server. |
EN |
|
Extended Properties |
Object |
|||
SAP username |
String |
The username with which the connector logs into 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 |
The configuration for message server usage. |
|||
Enable RFC tracing on server |
Boolean |
Enable or disable a RFC trace on the server. |
false |
|
Enable CPIC tracing on server |
Enumeration, one of:
|
Enable or disable CPIC trace on the server. LEVEL_3 is the most detailed tracing level, LEVEL_1 is the least. INHERIT: The trace level is inherited by remote CPIC or RFC servers to allow traces to be taken from distributed processes. These servers adopt the trace level and generate a trace for processing the CPIC program or RFC module. To prevent misuse, you can use the INHERIT parameter to prevent the trace level from being transferred. |
||
Reconnection |
When an 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. |
Outbound Configuration
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 |
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 it sees fit. |
|||
Encoding |
String |
Canonical name of an encoding. See Oracle’s Supported Encodings. |
||
Default Idocument Version |
String |
0 |
||
Disable Function Template Cache Flag |
Boolean |
|
||
Evaluate Response Flag |
Boolean |
|
||
Log Trace Flag |
Boolean |
|
||
Use SAP Default Format |
Boolean |
Indicates to use SAP default format when working with BAPI functions over sRFC. |
|
|
Operation timeout |
Integer |
Timeout for operations. This is a positive value in milliseconds, 0 means indefinite waiting. |
0 |
Outbound 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 will be created. |
||
Login language |
String |
Code of the language used by the connector. The language determines the code page used for communicating between SAP Adapter and the application server. |
EN |
|
Extended Properties |
Object |
|||
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 |
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:
|
Enable or disable CPIC trace on the server. LEVEL_3 has the most tracing, LEVEL_1 the least. INHERIT: The trace level is inherited by remote CPIC or RFC servers to allow traces to be taken from distributed processes. These servers adopt the trace level and generate a trace for processing the CPIC program or RFC module. To prevent misuse, you can use the INHERIT parameter to prevent the trace level from being transferred. |
||
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 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. 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 will be created. |
||
Login language |
String |
Code of the language used by the connector. The language determines the code page used for communicating between SAP Adapter and the application server. |
EN |
|
Extended Properties |
Object |
|||
SAP username |
String |
The username with which the connector will log into 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 |
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:
|
Enable or disable CPIC trace on the server. LEVEL_3 has the most tracing, LEVEL_1 the least. INHERIT: The trace level is inherited by remote CPIC or RFC servers to allow traces to be taken from distributed processes. These servers adopt the trace level and generate a trace for processing the CPIC program or RFC module. To prevent misuse, you can use the INHERIT parameter to prevent the trace level from being transferred. |
||
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 Id
<sap:confirm-transaction-id>
Confirms a determined transaction.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Transaction Id |
String |
The ID of the transaction to confirm. |
x |
|
Transactional Action |
Enumeration, one of:
|
The type of joining action that operations can take regarding transactions. |
JOIN_IF_POSSIBLE |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Create IDoc
<sap:create-idoc>
Retrieves an IDocument 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 IDocument. |
x |
|
Transactional Action |
Enumeration, one of:
|
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. |
|
|
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
Create Transaction Id
<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:
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 tRFC that ensures that individual steps are processed in sequence.
To guarantee that multiple LUWs (Logical Unit of Work transaction) are processed in the order specified by the application. tRFC can be serialized using queues (inbound and outbound queues). Hence the name queued RFC (qRFC).
Use qRFC to extend the Transactional RFC Defined processing sequence.
Implementation of qRFC is recommended 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 function to execute. |
x |
|
Content |
Binary |
The BAPI function to execute. |
|
|
Transaction Id |
String |
The ID that identifies an RFC that’s run only once. |
||
Queue Name |
String |
The name of the queue in which the RFC executes. |
x |
|
Transactional Action |
Enumeration, one of:
|
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 both the systems (client and server) to be available at the time of communication or data transfer. It is the most common type and is required when 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 and 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 may lead to the processes of the source system to go into Sleep RFC or CPIC Mode at the target systems and block these resources. |
sRFC is best used for:
-
Communication between systems.
-
Communication between SAP Web Application Server to 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. |
|
|
Transactional Action |
Enumeration, one of:
|
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. |
|
|
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 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 some network issue. The remote system need not be available at the time when the RFC client program is executing a tRFC.
The tRFC component stores in 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, this operation writes the data into aRFC tables with a transaction ID (SM58), which is picked by the scheduler RSARFCSE that runs for every 60 seconds.
tRFC is best used to extend asynchronous RFC for 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 BAPI function to execute. |
|
|
Transaction Id |
String |
The ID that identifies an RFC that runs only once. |
||
Transactional Action |
Enumeration, one of:
|
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>
Retrieves a BAPI function 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:
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SAP:INVALID_CREDENTIALS_ERROR
-
SAP:CONFIG_ERROR
-
SAP:COMMIT_TRANSACTION_ERROR
-
SAP:UNKNOWN
-
SAP:CONNECTION_ERROR
-
SAP:FIELD_NOT_FOUND_ERROR
-
SAP:XML_PARSING_ERROR
-
SAP:CONFIRM_TRANSACTION_ERROR
-
SAP:CONNECTIVITY
-
SAP:EXECUTION_ERROR
-
SAP:BEGIN_TRANSACTION_ERROR
-
SAP:MISSING_BUSINESS_OBJECT_ERROR
-
SAP:ROLLBACK_TRANSACTION_ERROR
-
SAP:TID_CREATION_ERROR
-
SAP:RETRY_EXHAUSTED
-
SAP:INVALID_HOST_ERROR
Send IDoc
<sap:send>
Sends an IDocument to SAP over an RFC.
An RFC can be one of two types for IDocuments:
-
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 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 some network issue.
The remote system need not 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 an 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 (runs every 60 seconds). Use tRFC to extend an asynchronous RFC for secure communication between systems.
-
Queued (qRFC) - A queued RFC is an extension of tRFC that ensures that individual steps are processed in sequence. Use to guarantee that multiple LUWs (logical unit of work transactions) are processed in the order specified by the application. A tRFC can be serialized using queues (inbound and queues). Hence the name queued RFC (qRFC). Use qRFC to extend the transactional RFC defined processing sequence. Implement qRFC 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 IDocument to execute. |
|
|
Version |
String |
The version on the IDoc |
||
Transaction Id |
String |
The ID that identifies an RFC that’s run only once. |
||
Queue Name |
String |
The name of the queue on which the RFC executes. |
||
Transactional Action |
Enumeration, one of:
|
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 |
x |
||
Gateway Host |
String |
x |
||
Gateway Service |
String |
x |
||
Program ID |
String |
x |
||
Connection Count |
Number |
1 |
||
Transactional Action |
Enumeration, one of:
|
The type of beginning action that sources can take regarding transactions. |
NONE |
|
Transaction Type |
Enumeration, one of:
|
The type of transaction to create. Availability depends on the runtime version. |
LOCAL |
|
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running in Cluster |
||
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
x |
||
Gateway Host |
String |
x |
||
Gateway Service |
String |
x |
||
Program ID |
String |
x |
||
Connection Count |
Number |
1 |
||
Targeted Function |
String |
|||
Transactional Action |
Enumeration, one of:
|
The type of beginning action that sources can take regarding transactions. |
NONE |
|
Transaction Type |
Enumeration, one of:
|
The type of transaction to create. Availability depends on the runtime version. |
LOCAL |
|
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running in Cluster |
||
Streaming Strategy |
|
Configure to use repeatable streams. |
||
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 |
|
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 at 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
| 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 in milliseconds to reconnect. |
||
Count |
Number |
How many 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:
|
A time unit that qualifies the maxIdleTime attribute. |
Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
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 Buffer 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:
|
The unit in which all these attributes are expressed. |
Repeatable File Store Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max 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 starts to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize 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 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 SHA-256. |
||
Id Expression |
String |
Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false. |
||
Object Store |
Object Store |
The object store where the redelivery counter for each message is going to be stored. |