Contact Us 1-800-596-4880
  1. Homepage
  2. SAP S/4HANA OData Connector (2.5)

  3. SAP S/4HANA OData Connector Reference

All Connectors

SAP S/4HANA OData Connector 2.5 Reference - Mule 4

For software requirements and compatibility information, see the SAP S/4HANA OData Connector Release Notes.

Default Configuration

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

Time Zone

String

The timezone with which to convert the Date objects returned from S/4HANA.

UTC

Batch Buffer Size

Number

Defines the maximum memory the connector will use to keep batch requests in memory. If more than the specified maximum memory is consumed the connector starts to buffer the content on disk.

512

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which batchBufferSize size is expressed.

KB

Response timeout

Number

Response timeout for the request

30

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request

SECONDS

Encoding

String

Name

String

The identifier of this element, which is also used in other components to reference the element.

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.

Connection Types

Basic Authentication

Basic authentication is the simplest way of enforcing access controls because it does not require cookies, session identifiers, or login pages. Instead, it uses standard fields in the HTTP header, which removes the need for handshakes. This mechanism provides no confidentiality protection for the transmitted credentials. The credentials are encoded with Base64 in transit, but not encrypted or hashed in any other way.

Parameters

Name Type Description Default Value Required

Service base URL

String

The base URL of the SAP S/4HANA instance to access from the connector and from which all other endpoints are derived.

x

Cache Entry TTL

Number

The time to live. The time a cache entry is kept in the cache before being evicted. A value of 0 disables the cache.

0

Cache Entry TTL Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Cache Entry TTL field.

MINUTES

EDM Expiration Interval

Number

The interval to check for expired EDM objects in the ObjectStore.

30

EDM Expiration Interval Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the EDM Expiration Interval field.

MINUTES

Username

String

The account username with which to log into SAP S/4HANA.

x

Password

String

The account password with which to log into SAP S/4HANA.

x

Discovery Service Enabled

Boolean

Feature switch for automatic service discovery.

true

Service discovery relative path

String

Relative path from the base URL to the endpoint used for automatic services discovery.

sap/opu/odata/IWFND/CATALOGSERVICE;v=0002/ServiceCollection

s

Unlisted services directory

String

Common HTTP directory for all unlisted services. This field enables users to specify service names instead of service URLs in the unlisted services list. It also enables the connector to construct the service URL by using the following format: {base URL parameter}/{this parameter}/{item from unlisted services list}.

Unlisted services

Array of String

List of services to add to the list of discovered services. Each item in this list must be a valid service URL, or it must be possible to construct a valid service URL with the following format: {base url parameter}/{service directory parameter}/{item from this list}.

Default headers

Array of Default Header

Default HTTP headers to include in the message.

Default query parameters

Array of Default Query Param

Default query parameters to include in the request.

Proxy configuration

Proxy Configuration

Proxy configuration for the connector.

Connection timeout

Number

Connection timeout for the request

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Connection timeout unit for the request

SECONDS

Client timeout

Number

Client timeout for the request

30

Client Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Client timeout unit for the request

SECONDS

Retrieve Csrf Token

Boolean

Enables or disables automatic X-CSRF-Token retrieval before a resource-modifying request, such as a POST request.

true

TLS configuration

TLS

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the tls:context child element of the listener-config.

HTTP

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.

OAuth 2.0 Client Credentials Authentication

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.

Parameters

Name Type Description Default Value Required

Service base URL

String

The base URL of the SAP S/4HANA instance to access from the connector and from which all other endpoints are derived.

x

Cache Entry TTL

Number

The time to live. The time a cache entry is kept in the cache before being evicted. A value of 0 disables the cache.

0

Cache Entry TTL Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Cache Entry TTL field.

MINUTES

EDM Expiration Interval

Number

The interval to check for expired EDM objects in the ObjectStore.

30

EDM Expiration Interval Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the EDM Expiration Interval field.

MINUTES

Discovery Service Enabled

Boolean

Feature switch for automatic service discovery.

true

Service discovery relative path

String

Relative path from the base URL to the endpoint used for automatic services discovery.

sap/opu/odata/IWFND/CATALOGSERVICE;v=0002/ServiceCollection

Unlisted services directory

String

Common HTTP directory for all unlisted services. This field enables users to specify service names instead of service URLs in the unlisted services list. It also enables the connector to construct the service URL by using the following format: {base URL parameter}/{this parameter}/{item from unlisted services list}.

Unlisted services

Array of String

List of services to add to the list of discovered services. Each item in this list must be a valid service URL, or it must be possible to construct a valid service URL with the following format: {base url parameter}/{service directory parameter}/{item from this list}.

Default headers

Array of Default Header

Default HTTP headers to include in the message.

Default query parameters

Array of Default Query Param

Default query parameters to include in the request.

Proxy configuration

Proxy Configuration

Proxy configuration for the connector.

Connection timeout

Number

Connection timeout for the request

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Connection timeout unit for the request

SECONDS

Client timeout

Number

Client timeout for the request

30

Client Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Client timeout unit for the request

SECONDS

Retrieve Csrf Token

Boolean

Enables or disables automatic X-CSRF-Token retrieval before a resource-modifying request, such as a POST request.

true

TLS configuration

TLS

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the tls:context child element of the listener-config.

HTTP

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.

Client Id

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret as registered with the service provider.

x

Token Url

String

The service provider’s token endpoint URL.

https://{host-name}/{oauth-service}/{generate-token-resource}

Scopes

String

The OAuth scopes requested during the dance. If not provided, it defaults to those in the annotation.

Object Store

String

A reference to the object store used to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store.

Supported Operations

Batch Create Entity

<s4hana:batch-create-entity>

This operation adds a create entity request into the batch. This is a dynamic operation that returns what the OData specification states will be returned by the operation. The result of the operation will be an empty JSON if this request was not processed by the server successfully. The result will be available only after executing the Execute batch operation. Accessing the result before the Execute batch operation is executed results in an error.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Batch ID

String

Batch identifier

x

Change set ID

String

Change set identifier

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Entity

Object

The entity in the SAP S/4HANA instance that is affected. This entity must be of the type defined in the Entity type parameter.

#[payload]

Custom headers

Object

Custom headers to include in the request. The custom headers specified here overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters to include in the request. The custom query parameters specified here overwrite the default query parameters specified in the configuration.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

Target Variable

String

The name of a variable in which 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

Any

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Delete Entity

<s4hana:batch-delete-entity>

Adds a delete entity request into the batch.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Batch ID

String

Batch identifier

x

Change set ID

String

Change set identifier.

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Entity key

Object

The object that identifies the entity sought, which may itself be an object. This is defined by the type of entity selected.

#[payload]

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters to include in the request. The custom query parameters specified here will overwrite the default query parameters specified in the configuration.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Execute Function

<s4hana:batch-execute-function>

This operation adds an execute function request (invoke request) to the batch. The result of the operation will be an empty JSON if this request was not processed by the server successfully. The result will be available only after executing the Execute batch operation. Accessing the result before the Execute batch operation is executed will cause an error.

You are required to specify the change set identifier for the Change set ID parameter only if Execute Batch Function is executed using a POST HTTP method, otherwise do not specify the changet set identifier.

The connector throws an exception:

  • If the change set identifier is not specified and the POST HTTP method is used

  • When the change set identifier is specified and the Execute Batch Function uses GET HTTP method

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Batch ID

String

Batch identifier

x

Change set ID

String

Change set identifier

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Function Name

String

The name of the function to execute.

x

Input parameters

Object

The parameters of the function wrapped into a single object.

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters to include in the request. The custom query parameters specified here will overwrite the default query parameters specified in the configuration.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

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

Any

For Configurations

Throws

  • S4HANA:BATCH_PROCESSING_ERROR

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_FUNCTION_PARAMETER

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_FUNCTION

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Get Entity

<s4hana:batch-get-entity>

Adds a query operation request with a defined key into the batch. This is a dynamic operation, returning whatever the OData specification states will be returned by the operation. Result of the operation will be an empty JSON if this request was not processed by the server successfully. The result will be available only after the Execute batch operation is executed. Accessing the result before the Execute batch operation is executed will lead to an error.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Batch ID

String

Batch identifier

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Returned Fields

String

Comma-separated list of selection clauses. Each selection clause may be a Property name, Navigation Property name, or the "*" character. The "*" syntax causes all Properties on an Entry to be included without traversing associations. Use forward slash "/" to select fields of expanded navigation properties. If no field is selected, then all fields are returned.

Expanded properties

String

Comma-separated list of Navigation Properties. Additionally, each Navigation Property can be followed by a forward slash and another Navigation Property to enable identification of a multi-level relationship. Properties of the expanded navigation property will not be part of the payload unless selected.

Entity key

Object

The object that identifies the entity sought, which may itself be an object. This is defined by the type of entity selected.

#[payload]

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters to include in the request. The custom query parameters specified here will overwrite the default query parameters specified in the configuration.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

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

Any

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Query Entity

<s4hana:batch-query>

Adds a query operation request into the batch, filtering the results by the parameters defined. If no filter is added, then all results will be listed. Result of the operation will be an empty JSON if this request was not processed by the server successfully. The result will be available only after the Execute batch operation is executed. Accessing the result before the Execute batch operation is executed will lead to an error.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Batch ID

String

Batch identifier

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Returned Fields

String

Comma-separated list of selection clauses. Each selection clause may be a Property name, Navigation Property name, or the "*" character. The "*" syntax causes all Properties on an Entry to be included without traversing associations. Use forward slash "/" to select fields of expanded navigation properties. If no field is selected, then all fields are returned.

Expanded properties

String

Comma-separated list of Navigation Properties. Additionally each Navigation Property can be followed by a forward slash and another Navigation Property to enable identification of a multi-level relationship. Properties of expanded navigation property will not be part of the payload unless selected.

Filter

String

The condition to filter the resulting list of entities.

Order by

String

Allows information to be requested in either ascending or descending order by using the asc or desc suffixes. If asc or desc are not specified, then the resources will be ordered in ascending order.

asc

Maximum returned elements

Number

Limits the number of records to be retrieved by this query.

Skipped record amount

Number

The number of records to skip before starting to return results.

0

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

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

Any

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:RETRY_EXHAUSTED

Batch Update Entity

<s4hana:batch-update-entity>

Adds an update entity request into the batch. This operation works through a PATCH request. This means that any fields that are missing will not be updated.

Users cannot specify custom namespaces for custom business objects.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Batch ID

String

Batch identifier

x

Change set ID

String

Change set identifier

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Entity

Object

The entity to be affected in the SAP S/4HANA instance. This entity must be of the type defined in the type parameter.

#[payload]

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RESOURCE_NOT_FOUND

  • S4HANA:RETRY_EXHAUSTED

Batch Upsert Custom Business Object

<s4hana:batch-upsert-custom-business-object>

This operation supports upsert for custom business objects.

Users cannot specify custom namespaces for custom business objects.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Batch ID

String

Batch identifier.

x

Change set ID

String

Change set identifier.

x

Service

String

Type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

Name of the entity type to execute.

x

Entity

Object

Custom business object entity of the entity type wrapped into a single object.

#[payload]

Custom headers

Object

Custom headers that the request includes. The custom headers specified here overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters that the request includes. The custom query parameters specified here overwrite the default query parameters specified in the configuration.

Response timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RESOURCE_NOT_FOUND

  • S4HANA:RETRY_EXHAUSTED

Create Change Set

<s4hana:create-change-set>

Creates a new change set in the batch and returns its identifier.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Batch ID

String

Batch identifier

x

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

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:RETRY_EXHAUSTED

Create Entity

<s4hana:create-entity>

Executes a create operation within the connected SAP S/4HANA instance. This is a dynamic operation, returning whatever the OData specification states will be returned by the operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Entity

Object

The entity to be affected in the SAP S/4HANA instance. This entity must be of the type defined in the type parameter.

#[payload]

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

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

Object

Attributes Type

Response Attributes

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Delete Entity

<s4hana:delete-entity>

Executes a delete operation within the connected SAP S/4HANA instance.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Entity key

Object

The object that identifies the entity sought, which may itself be an object. This is defined by the type of entity selected.

#[payload]

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Execute Batch

<s4hana:execute-batch>

Executes the batch and returns a summary containing results for all requests of the batch. After this operation is successfully executed, it will be possible to read a detailed result of each batch operation which was a part of this batch.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Service

String

The SAP S/4HANA’s service.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Batch ID

String

Batch identifier

x

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

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

Bulk Operation Result

For Configurations

Throws

  • S4HANA:BATCH_PROCESSING_ERROR

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Execute Function

<s4hana:execute-function>

Executes an OData-defined function in the SAP S/4HANA instance.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Function Name

String

The name of the function to execute.

x

Input parameters

Object

The parameters of the function wrapped into a single object.

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

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

Any

Attributes Type

Response Attributes

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_FUNCTION_PARAMETER

  • S4HANA:NO_SUCH_FUNCTION

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Get Entity by Key

<s4hana:get-entity>

Executes a retrieve operation on the SAP S/4HANA instance filtering the result by key. If no elements are found an error is thrown.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Returned Fields

String

Comma-separated list of selection clauses. Each selection clause may be a Property name, Navigation Property name, or the "*" character. The "*" syntax causes all Properties on an Entry to be included without traversing associations. Use forward slash "/" to select fields of expanded navigation properties. If no field is selected, then all fields are returned.

Expanded properties

String

Comma-separated list of Navigation Properties. Additionally each Navigation Property can be followed by a forward slash and another Navigation Property to enable identifying a multi-level relationship. Properties of expanded navigation property will not be part of the payload unless selected.

Entity key

Object

The object that identifies the entity sought, which may itself be an object. This is defined by the type of entity selected.

#[payload]

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

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

Object

Attributes Type

Response Attributes

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_FIELD

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_NAVIGATION_PROPERTY

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Initiate Batch

<s4hana:initiate-batch>

Prepares a new batch and returns its identifier.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

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

  • S4HANA:CONNECTIVITY

  • S4HANA:RETRY_EXHAUSTED

Query

<s4hana:query>

Executes a retrieve operation on the SAP S/4HANA instance filtering the results by the parameters defined. If no filter is added, then all results will be listed. This is a paginated operation.

You must enable pagination support in your SAP S/4HANA instance to use this operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Returned Fields

String

Comma-separated list of selection clauses. Each selection clause may be a Property name, Navigation Property name, or the "*" character. The "*" syntax causes all Properties on an Entry to be included without traversing associations. Use forward slash "/" to select fields of expanded navigation properties. If no field is selected, then all fields are returned.

Expanded properties

String

Comma-separated list of Navigation Properties. Additionally each Navigation Property can be followed by a forward slash and another Navigation Property to enable identifying a multi-level relationship. Properties of expanded navigation property will not be part of the payload unless selected.

Filter

String

The condition to filter the resulting list of entities.

Order by

String

Allows to request information in either ascending or descending order by using the ?asc? or ?desc? suffixes. If asc or desc not specified, then the resources will be ordered in ascending order.

Maximum returned elements

Number

Limits the amount of records to be retrieved by this query.

Skipped record amount

Number

The amount of records to skip before starting returning results.

0

Page size

Number

The size of the pages retrieved by the query.

100

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

Target Variable

String

The name of a variable in which 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

Array of Object

For Configurations

Throws

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_FILTER

  • S4HANA:INVALID_KEY

  • S4HANA:INVALID_PAGE_SIZE

  • S4HANA:INVALID_SKIP_SIZE

  • S4HANA:INVALID_TOP_SIZE

  • S4HANA:NO_SUCH_ENTITY_FIELD

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_NAVIGATION_PROPERTY

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:NO_SUCH_SORTING_FIELD

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Unauthorize

<s4hana:unauthorize>

Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the authorization dance.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

For Configurations

Update Entity

<s4hana:update-entity>

Executes an update operation within the connected SAP S/4HANA instance. This operation will work through PATCH requests. This means that any fields that are missing will not be updated.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Service

String

The type of service. This is defined from the services available in the SAP S/4HANA instance.

x

Entity type

String

The type of entity over which the operation is executed. This is defined from the types of entities available in the selected service.

x

Entity

Object

The entity in the SAP S/4HANA instance that is affected. This entity must be of the type defined in the type parameter.

#[payload]

Custom headers

Object

Custom headers to include in the request. The custom headers specified here will overwrite the default headers specified in the configuration.

Custom query parameters

Object

Custom query parameters to include in the request. The custom query parameters specified here overwrite the default query parameters that are specified in the configuration.

Response timeout

Number

Response timeout for the request. The timeout specified here overwrites the default timeout that is specified in the configuration.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The timeout unit specified here overwrites the default timeout unit specified in the configuration.

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Types

Default Header

Field Type Description Default Value Required

Key

String

The key

x

Value

String

The value

x

Default Query Param

Field Type Description Default Value Required

Key

String

The key

x

Value

String

The value

x

Proxy Configuration

Field Type Description Default Value Required

Host

String

Host where the proxy requests is sent.

x

Port

Number

Port where the proxy requests is sent.

x

Username

String

The username to authenticate against the proxy.

Password

String

The password to authenticate against the proxy.

Non Proxy Hosts

Array of String

A list of hosts against which the proxy should not be used.

Ntlm Domain

String

The domain to authenticate against the proxy.

TLS

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the tls:context child element of the listener-config.

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Key Store

Keystore

Revocation Check

Truststore

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.

Password

String

The password used to protect the truststore.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Keystore

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.

Type

String

The type of store used.

Alias

String

When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the truststore), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

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.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

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

Repeatable In Memory Stream

When streaming in this mode, Mule does not use the disk to buffer the contents. If you exceed the buffer size, the message fails.

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 stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This specifies 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:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

File store repeatable streams require buffering, and there are different buffering strategies. Mule keeps a portion of contents in memory. If the stream contents are larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

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

Non-repeatable Stream

You can disable the repeatable stream functionality and use non-repeatable streams, which can have less performance overhead, memory use, and cost.

Field Type Description Default Value Required

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

Response Attributes

Field Type Description Default Value Required

Headers

Object

Status Code

Number

Bulk Operation Result

Field Type Description Default Value Required

Id

Any

Items

Array of Bulk Item

Successful

Boolean

Bulk Item

Field Type Description Default Value Required

Exception

Any

Id

Any

Message

String

Payload

Any

Status Code

String

Successful

Boolean

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of instances that is initially be allowed to be kept in memory 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.

100 instances

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.

100 instances

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.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances that will be kept in memory. If more than that is required, 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

See Also

MuleSoft Help Center

Back to top
View on GitHub