Contact Free trial Login

SAP S/4HANA Cloud Connector Reference

Support Category: Premium

SAP S/4HANA Cloud Connector V1.0

Configurations


Config

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Time Zone

String

The timezone with which the Date objects returned from S/4HANA are converted.

UTC

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

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, removing the need for handshakes. This mechanism provides no confidentiality protection for the transmitted credentials. They are merely encoded with Base64 in transit, but not encrypted or hashed in any way.

Parameters
Name Type Description Default Value Required

Service base URL

String

The base URL of the service on SAP S/4HANA to be accessed from the connector. From this base URL all other endpoints derive.

x

Username

String

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

x

Password

String

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

x

Service discovery relative path

String

URL used for automatic services discovery.

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

Unlisted services

Array of String

List of services to add to the list of discovered services.

Default headers

Array of Default Header

Default HTTP headers the message should include.

Default query parameters

Default Query parameters the request should include.

Proxy configuration

Proxy configuration for the connector.

TLS configuration

TLS

Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS, the HTTP communication is secured using TLS/SSL. If HTTPS is configured as a protocol, a user needs to configure at least the key store in the tls:context child element of this listener-config.

Reconnection

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

Operations

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 that is returned by the operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

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 that the request includes. The ones specified here overwrite the default ones specified in the config.

Custom query parameters

Object

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

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. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

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

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 to be deleted. This must include the entity identification key.

#[payload]

Custom headers

Object

Custom headers that the request includes. The ones specified here overwrite the default ones specified in the config.

Custom query parameters

Object

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

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:TIMEOUT

  • S4HANA:UNAUTHORIZED

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

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.

#[payload]

Custom headers

Object

Custom headers that the request includes. The ones specified here overwrite the default ones specified in the config.

Custom query parameters

Object

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

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. The outcome of that expression is stored 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_FUNCTION_PARAMETER

  • S4HANA:NO_SUCH_FUNCTION

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • 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

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

The comma separated list of fields of the entity to return. If no field is selected, then all fields are returned.

*

Entity key

Object

The object that identifies the entity sought. This may be an object as of itself. This is defined from the type of entity selected.

#[payload]

Custom headers

Object

Custom headers that the request includes The ones specified here overwrite the default ones specified in the config.

Custom query parameters

Object

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

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. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

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_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

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 are listed. This is a paginated operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Strategy

Configure to use repeatable streams.

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

The comma separated list of fields of the entity to return. If no field is selected, then all fields are returned.

*

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 are not specified, then the resources are ordered in ascending order.

Page size

Number

The size of the pages retrieved by the query.

100

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

Custom headers

Object

Custom headers that the request includes The ones specified here overwrite the default ones specified in the config.

Custom query parameters

Object

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

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. The outcome of that expression is stored 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_SERVICE

  • S4HANA:NO_SUCH_SORTING_FIELD

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Update Entity

<s4hana:update-entity>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

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 that the request includes. The ones specified here overwrite the default ones specified in the config.

Custom query parameters

Object

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

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

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

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location of the trust store, which is resolved relative to the current classpath and file system, if possible.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

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

Key Store

Field Type Description Default Value Required

Path

String

The location of the key store, which is resolved relative to the current classpath and file system, if possible.

Type

String

The type of store used.

Alias

String

When the key store 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 is used by the default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

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 trust store), 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.

Count

Number

How many reconnection attempts to make.

blocking

Boolean

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

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

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

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

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. Default value is 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. Default value is 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 to keep in memory. If more than that is required, then it starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.