Connector to integrate your mule applications with SAP ERP Central Component (ECC) using SAP JCo libraries.

Configurations

Config

SAP JCo connection's configuration.

With this connector you can integrate your mule applications with SAP ERP Central Component.

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 that can be provided to this configuration.

x 

Encoding

String

Default encoding. By default UTF-8

UTF-8

 

IDoc version

String

The version of the IDoc. Default 0. See com.sap.conn.idoc.IDocFactory documentation for supported versions.

0

 

Disable Functions Cache

Boolean

Disables JCo function templates cache

false

 

Global timeout for operations.

Number

Operation timeout. Default 0 disabled

0

 

The timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Operation timeout unit. Default MILLISECONDS

MILLISECONDS

 

DataSense cache

Boolean

Enable DataSense cache at design time

true

 

Disable DataSense for types list

Boolean

Disable DataSense for types list at design time

false

 

Disable DataSense for input/output structures

Boolean

Disable DataSense for input/output structures at design time

false

 

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 will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Connection

SAP JCo Connection provider

For addtional JCo properties see sapjco3 javadoc com.sap.conn.jco.ext.DestinationDataProvider

Parameters
Name Type Description Default Value Required

Authentication

x 

SAP Server to connect to

x 

SAP system number

String

The two-digit system number (sysnr)

x 

SAP client ID

String

Three-digit client number, preserve leading zeros if they appear in the number

x 

Destination name

String

Destination name is used as unique identifier to store JCo connection properties locally. A random destination name will be generated whether leave it blank

 

Login language

String

ISO two-character language code (for example, EN, DE, FR) or SAP-specific single-character language code.

EN

 

Additional Client JCo properties

Object

See sapjco3 javadoc for supported properties (com.sap.conn.jco.ext.DestinationDataProvider)

 

Enable/disable RFC trace

Boolean

Enable/disable RFC trace (jco.client.trace)

false

 

Enable/disable CPIC trace

Enumeration, one of:

  • DEFAULT

  • DISABLED

  • LEVEL_1

  • LEVEL_2

  • LEVEL_3

Enable/disable CPIC trace (jco.client.cpic_trace)

 

Reconnection

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

 

Associated Operations

Associated Sources

Operations

Function - instance

<sap-jco:function-instance>

Gets a JCoFunction instance, rendered as XML.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function name

String

The name of the Function to be retrieved

x 

Encoding

String

Overrides default encoding defined in configuration

 

Disable Functions Cache

Boolean

Overrides default disable functions cache flag in configuration

 

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 if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function - invoke over bgRFC

<sap-jco:function-invoke-bgrfc>

Invokes a JCoFunction using the bgRFC protocol.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function name

String

the function name

---

 

Confirm

Boolean

the confirm

true

 

Function XML content

Binary

the content

#[payload]

 

Queue Name

String

the queue name to ensure execution order for (Q)ueue mode. Whether queue not provided (T)transactional mode will be used.

 

Unit ID

String

The function unit ID. For special cases only - especially for recovering after failure. The given id is assigned to the unit and cannot be changed. bgRFC supports IDs with length 32 chars as hex decimal representation of 16 bytes.

 

Trace On

Boolean

The backend will write kernel traces, while executing this unit. By default, no traces will be written.

false

 

History On

Boolean

The backend will keep a history for this unit. By default no history is kept by the backend.

false

 

Lock On

Boolean

It can be used only for units of type 'Q': The unit will be written to the queue, but not processed. The unit can then be started manually in the ABAP debugger. By default, a unit is simply processed.

false

 

Commit Check On

Boolean

Allows adjusting the commit check attribute. When turning the commit check on, the backend will check during the execution of a unit, whether one of the unit's function modules triggers an explicit or implicit COMMIT WORK. In this case the unit is aborted with an error, because the transactional integrity of this unit cannot be guaranteed. By default, the commit check is turned off. Hence, the behavior mentioned above is suppressed, meaning the unit will be executed anyway, even if one of its function modules misbehaves and triggers a COMMIT WORK.

false

 

User ID

String

The user will be associated with the unit in the backend. This is useful, if the environment in which JCo is used has its own user management. By default, the user of the backend connection will be passed.

 

Client

String

The SAP client will be associated with the unit in the backend. This is useful, if the environment in which JCo is used has a tenant concept. By default, the client of the backend connection will be passed.

 

Program Name

String

The program name will be associated with the unit in the backend. This is useful for identifying the logical application that triggered the unit. By default, the first class in the stack trace that does not belong to JCo will be passed.

 

Encoding

String

the encoding

 

Operation Timeout

Number

the operation timeout

 

Operation Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

the operation timeout unit

 

Disable Functions Cache

Boolean

the disable functions cache

 

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 on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function - invoke over qRFC

<sap-jco:function-invoke-qrfc>

Invokes a JCoFunction in queue mode using the qRFC protocol.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function name

String

the function name

---

 

Function XML content

Binary

the content

#[payload]

 

Transaction Id

String

the transaction id

 

Queue Name

String

the queue name

x 

Encoding

String

the encoding

 

Operation Timeout

Number

the operation timeout

 

Operation Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

the operation timeout unit

 

Disable Functions Cache

Boolean

the disable functions cache

 

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-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function - invoke over sRFC

<sap-jco:function-invoke-srfc>

Invokes a JCoFunction synchronously using the sRFC protocol.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function name

String

Optional function's name to work with datasense metadata resolution

---

 

Function XML content

Binary

Function to invoke as XML content

#[payload]

 

Encoding

String

Overrides default encoding defined in configuration

 

Operation Timeout

Number

Overrides default timeout defined in configuration

 

Operation Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Overrides default timeout unit defined in configuration

 

Disable Functions Cache

Boolean

Overrides default disable functions cache flag in configuration

 

Process BAPI RETURN Parameter

Boolean

Process BAPI RETURN parameter and throw exception if any error is found

false

 

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 if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function - invoke over tRFC

<sap-jco:function-invoke-trfc>

Invokes a JCoFunction in transactional mode using the tRFC protocol.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function name

String

Optional function's name to work with datasense metadata resolution

---

 

Function XML content

Binary

Function to invoke as XML content

#[payload]

 

Transaction Id

String

The transaction id

 

Encoding

String

Overrides default encoding defined in configuration

 

Operation Timeout

Number

Overrides default timeout defined in configuration

 

Operation Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Overrides default timeout unit defined in configuration

 

Disable Functions Cache

Boolean

Overrides default disable functions cache flag in configuration

 

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-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function - generate XML Schema

<sap-jco:function-schema>

Generates a JCoFunction's XML schema using its metadata. Generated XML schema can be used by other applications to prepare valid XML function calls or to define metadata types within mule applications.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function name

String

The name of the Function to generate its XML Schema

x 

Encoding

String

Overrides default encoding defined in configuration

 

Disable Functions Cache

Boolean

Overrides default disable jCoFunction cache flag in configuration

 

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 if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function Unit - add function

<sap-jco:function-unit-add-function>

Add JCoFunction to Function Unit

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function Unit

the function unit

#[payload]

 

Function name

String

Optional function's name to work with datasense metadata resolution

---

 

Function XML content

Binary

Function to invoke as XML content

#[payload]

 

Encoding

String

Overrides default encoding defined in configuration

 

Disable Functions Cache

Boolean

Overrides default disable functions cache flag in configuration

 

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 on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function Unit - confirm

<sap-jco:function-unit-confirm>

Manually confirm a Function Unit.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function Unit identifier

the unit identifier

#[payload]

 

Operation Timeout

Number

the operation timeout

 

Operation Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

the operation timeout unit

 

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-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function Unit - create

<sap-jco:function-unit-create>

Create a Function Unit.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Names

String

The optional queue names (comma separated) to ensure execution order for (Q)ueued mode. Whether queues not provided (T)transactional mode will be used.

 

Unit ID

String

The function unit ID. For special cases only - especially for recovering after failure. The given id is assigned to the unit and cannot be changed. bgRFC supports IDs with length 32 chars as hex decimal representation of 16 bytes.

 

Trace On

Boolean

The backend will write kernel traces, while executing this unit. By default, no traces will be written.

false

 

History On

Boolean

The backend will keep a history for this unit. By default no history is kept by the backend.

false

 

Lock On

Boolean

It can be used only for units of type 'Q': The unit will be written to the queue, but not processed. The unit can then be started manually in the ABAP debugger. By default, a unit is simply processed.

false

 

Commit Check On

Boolean

Allows adjusting the commit check attribute. When turning the commit check on, the backend will check during the execution of a unit, whether one of the unit's function modules triggers an explicit or implicit COMMIT WORK. In this case the unit is aborted with an error, because the transactional integrity of this unit cannot be guaranteed. By default, the commit check is turned off. Hence, the behavior mentioned above is suppressed, meaning the unit will be executed anyway, even if one of its function modules misbehaves and triggers a COMMIT WORK.

false

 

User ID

String

The user will be associated with the unit in the backend. This is useful, if the environment in which JCo is used has its own user management. By default, the user of the backend connection will be passed.

 

Client

String

The SAP client will be associated with the unit in the backend. This is useful, if the environment in which JCo is used has a tenant concept. By default, the client of the backend connection will be passed.

 

Program Name

String

The program name will be associated with the unit in the backend. This is useful for identifying the logical application that triggered the unit. By default, the first class in the stack trace that does not belong to JCo will be passed.

 

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 on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function Unit - send

<sap-jco:function-unit-send>

Send a Function Unit to destination using the bgRFC protocol.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function Unit

the function unit

#[payload]

 

Confirm

Boolean

the confirm

true

 

Operation Timeout

Number

Overrides default timeout defined in configuration

 

Operation Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Overrides default timeout unit defined in configuration

 

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-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Function Unit - status

<sap-jco:function-unit-status>

Returns Function Unit status: NOT_FOUND, IN_PROCESS, COMMITTED, CONFIRMED or ROLLED_BACK

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Function Unit identifier

the unit identifier

#[payload]

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

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 on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

IDoc - instance

<sap-jco:idoc-instance>

Creates an empty IDoc with EDI_DC segment, rendered as XML.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

IDoc type

String

The IDoc's type to create an instance

x 

Encoding

String

Overrides default encoding defined in configuration

 

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 if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

IDoc - generate XML Schema

<sap-jco:idoc-schema>

Generate a XML schema for an IDoc using its metadata. Generated XML schema can be used by other applications to prepare valid XML IDoc or to define metadata types within mule applications.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

IDoc type

String

The IDoc's type to generate XML Schema

x 

Encoding

String

Overrides default encoding defined in configuration

 

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 if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

IDoc - send

<sap-jco:idoc-send>

Sends an IDoc package.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

IDoc type

String

Optional IDoc's type to work with datasense metadata resolution

---

 

IDoc XML content

Binary

The IDoc as XML content to send

#[payload]

 

Transaction Id

String

The transaction id

 

Queue Name

String

An optional parameter used in case when the IDoc package shall be sent via queued RFC (qRFC)

 

IDoc version

String

Overrides the version of the IDoc defined in configuration

 

Operation Timeout

Number

Overrides default timeout defined in configuration

 

Operation Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Overrides default timeout unit defined in configuration

 

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-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Transaction - confirm

<sap-jco:transaction-confirm>

Confirms a transaction.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transaction Id

String

The transaction id 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-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Transaction - create

<sap-jco:transaction-create>

Creates a transaction id.

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 on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • SAP-JCO:CONNECTIVITY  

  • SAP-JCO:TRANSACTION_ERROR  

  • SAP-JCO:COMMUNICATION_ERROR  

  • SAP-JCO:INVALID_PARAMETER  

  • SAP-JCO:OPERATION_ERROR  

  • SAP-JCO:RESOURCE_NOT_FOUND  

  • SAP-JCO:XML_PARSER_ERROR  

  • SAP-JCO:INVALID_CREDENTIALS  

  • SAP-JCO:INVALID_CONFIGURATION  

  • SAP-JCO:JCO_SERVER_ERROR  

  • SAP-JCO:OPERATION_TIMEOUT  

  • SAP-JCO:ABAP_ERROR  

  • SAP-JCO:RETRY_EXHAUSTED  

Sources

Source - receive Function

<sap-jco:function-source>

Registers a JCoServer to process incoming JCoFunctions calls from ABAP programs

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Gateway Host

String

The gateway host at which the JCoServer should be registered

x 

Gateway Service

String

The gateway service to be used for registering at the gateway, i.e. the symbolic service name or the port number

x 

Program Id

String

The program ID for registering and identifying the JCoServer at the gateway

x 

Connection Count

Number

The number of server connections to register at the gateway

1

 

Handle only this function

String

Name of the unique Function to be handled. Received Function that do not match selected one will be silently discarded. If not provided, any Function can be received.

 

Disable Functions Cache

Boolean

Overrides default disable functions cache flag in configuration

 

Additional Server JCo properties

Object

See sapjco3 javadoc for supported properties (com.sap.conn.jco.ext.ServerDataProvider)

 

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 will depend on the runtime version.

LOCAL

 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when runnning in Cluster

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Redelivery Policy

Defines a policy for processing the redelivery of the same message

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Function XML response content

Binary

the JCoFunction as result of processing incoming JCoFunction

 

Output

Type

Binary

Attributes Type

For Configurations.

Source - receive IDoc

<sap-jco:idoc-source>

Registers a JCoIDocServer to receive IDocs from ABAP programs

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Gateway Host

String

The gateway host at which the JCoIDocServer should be registered

x 

Gateway Service

String

The gateway service to be used for registering at the gateway, i.e. the symbolic service name or the port number

x 

Program Id

String

The program ID for registering and identifying the JCoIDocServer at the gateway

x 

Connection Count

Number

The number of server connections to register at the gateway

1

 

Handle only this IDoc

String

Unique IDoc type to be handled. Received IDocs that do not match selected one will be silently discarded. If not provided, any IDoc can be received.

 

Additional Server JCo properties

Object

See sapjco3 javadoc for supported properties (com.sap.conn.jco.ext.ServerDataProvider)

 

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 will depend on the runtime version.

LOCAL

 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when runnning in Cluster

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

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

For Configurations.

Types

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 will fail 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 ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

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 J Co Function Source Attributes

Field Type Description Default Value Required

Incoming Function Name

String

Transaction Id

String

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

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

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower 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 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

The object store where the redelivery counter for each message is going to be stored.

Sap J Co I Doc Source Attributes

Field Type Description Default Value Required

Incoming I Doc Name

String

Incoming I Doc Type

String

Transaction Id

String

Function Unit Identifier

Field Type Description Default Value Required

Id

String

The unit ID, bgRFC supports IDs with length 32 chars as hex decimal representation of 16 bytes

x

Type

Enumeration, one of:

  • TYPE_T

  • TYPE_Q

Unit identifier type. TYPE_T (T)ransactional or TYPE_Q (Q)ueued. By default=TYPE_T

Function Unit

Field Type Description Default Value Required

Unit

Any

Unit Identifier

Username Password

Field Type Description Default Value Required

Username

String

User name for logging into the SAP system

x

Password

String

Password for logging into the SAP system

x

X509 Certificate

Field Type Description Default Value Required

Path

String

Path to an X.509 certificate to be used as logon ticket.

Sap Application Server

Field Type Description Default Value Required

Host

String

The host of the SAP application server.

x

Sap Message Server

Field Type Description Default Value Required

Host

String

SAP message server host

x

System Id

String

SAP System ID (SID)

x

Service

String

SAP message server service or port number (optional)

Group

String

Logon group name of SAP application servers (Optional, default is PUBLIC)

Router

String

SAProuter string to use for networks being protected by a firewall