Show TOC

SAP Event Stream Processor ParametersLocate this document in the navigation structure

SAP Event Stream Processor parameters configure communication between Event Stream Processor and the HTTP adapter.

These parameters are defined in the controller.xsd file in the config directory.

Parameter Name Description
espAuthType

Type: string

(Required) Method used to authenticate to Event Stream Processor. Valid values are:
  • server_rsa - RSA authentication using keystore
  • kerberos - Kerberos authentication using ticket-based authentication
  • user_password - LDAP, SAP BI, and Native OS (user name/password) authentication

If the adapter is operated as a Studio plug-in, espAuthType is overridden by the Authentication Mode Studio start-up parameter.

espUser

Type: string

(Required) Specifies the user name required to log in to Event Stream Processor (see espAuthType). No default value.

espPassword

Type: string

(Required) Specifies the password required to log in to Event Stream Processor (see espAuthType).

Includes an "encrypted" attribute indicating whether the espPassword value is encrypted. Default value is false. If set to true, the password value is decrypted using espRSAKeyStore and espRSAKeyStorePassword.

espProjectUri

Type: string

(Required) Specifies the total project URI to connect to Event Stream Processor cluster. For example, if SSL is enabled, use esps://localhost:19011/ws1/p1.

pulseInterval

Type: non-negative integer

(Optional) Specifies the time interval, in seconds, during which outbound record changes are coalesced by Event Stream Processor, then received by the adapter as a single event.

If not set or set to 0, record changes are received individually as they occur.

espHeartbeatPeriod

Type: positive integer

(Optional) Specifies the length of time, in seconds, that adapter waits before sending the next heartbeat to Event Stream Processor.

If Event Stream Processor fails to receive two consecutive heartbeats, all records published by the adapter are marked stale. The default value is 10.

recordQueueCapacity

Type: positive integer

(Optional) Specifies capacity of the record queues. Default value is 4096.

maxPubPoolSize

Type: positive integer

(Optional) Specifies the maximum size of the record pool. Record pooling, also referred to as block or batch publishing, allows for faster publication since there is less overall resource cost in publishing multiple records together compared to publishing records individually.

Block publishing (record pooling or batch publishing) is disabled if this value is set to 1. The default value is 256.

maxPubPoolTime

Type: positive integer

(Optional) Specifies the maximum period of time, in milliseconds, for which records are pooled before being published. If not set, pooling time is unlimited and the pooling strategy is governed by maxPubPoolSize. No default value.

useTransactions

Type: boolean

(Optional) If set to true, pooled messages are published to Event Stream Processor in transactions. If set to false, they are published in envelopes. Default value is false.

espRSAKeyStore

Type: string

(Dependent required) Specifies the location of the RSA keystore, and decrypts the password value. Required if espAuthType is set to server_rsa, or the encrypted attribute for espPassword is set to true, or both.

espRSAKeyStorePassword

Type: string

(Dependent required) Specifies the keystore password, and decrypts the password value. Required if espAuthType is set to server_rsa, or the encrypted attribute for espPassword is set to true, or both.

espKerberosKDC

Type: string

(Dependent required) Specifies host name of Kerberos key distribution center. Required if espAuthType is set to kerberos.

espKerberosRealm

Type: string

(Dependent required) Specifies the Kerberos realm setting. Required if espAuthType is set to kerberos.

espKerberosService

Type: string

(Dependent required) Specifies the Kerberos principal name that identifies an Event Stream Processor cluster. Required if espAuthType is set to kerberos.

espKerberosTicketCache

Type: string

(Dependent required) Specifies the location of the Kerberos ticket cache file. Required if espAuthType is set to kerberos.

espEncryptionAlgorithm

Type: string

(Optional) Used when the encrypted attribute for espPassword is set to true. If left blank, RSA is used as default.