Event Stream Processor Parameters

Parameters that you can specify within the ESPOPTIONS.ini configuration file to create a connection to Event Stream Processor.

The parameter names in parentheses reflect how they appear in the RTView Builder.

Note: Use URL encoding (%xx) when specifying special characters within the ESPOPTIONS.ini configuration file. For example, if entering "a #! b" (a, white-space, pound, bang, white-space, b), you would specify "a%20%23%21%20b". You do not need to use URL encoding when entering special characters in the RTView Builder.
Parameter Description
authType (Authentication Mode)

Type: choice

(Required) Specifies the method used to authenticate to Event Stream Processor. Default is UserPassword.
  • UserPassword – user and password parameters are required.
  • ServerRSA – user, keyStore, and keyStoreFile parameters are required.
  • Kerberos – user, krbKdc, krbRealm, krbService, and krbCache parameters are required.
projectUri (projectUri)

Type: string

(Optional) Specifies the total project URI to connect to Event Stream Processor cluster. For example, esp://hostname:port/workspace/project. No default value.

keyStore (keyStore)

Type: string

(Optional) Specifies the location of the RSA keystore, and decrypts the password value. Required if authType is set to ServerRSA. No default value.

keyStorePassword (keyStorePassword)

Type: string

(Optional) Specifies the keystore password, and decrypts the password value. Required if authType is set to ServerRSA. No default value.

rsaKeyFile (rsaKeyFile)

Type: string

(Optional) Peforms authentication using the rsaKeyFile mechanism instead of password authentication. The rsaKeyFile must specify the pathname of the RSA key file.

krbKdc (Kerberos KDC Host)

Type: string

(Optional) Specifies host name of Kerberos key distribution center. Required if authType is set to Kerberos. No default value.

krbRealm (Kerberos Realm)

Type: string

(Optional) Specifies the Kerberos realm setting. Required if authtype is set to Kerberos. No default value.

krbService (Kerberos Service Principal Name)

Type: string

(Optional) Specifies the Kerberos principal name that identifies an Event Stream Processor cluster. Required if authtype is set to Kerberos. No default value.

krbCache (Kerberos Ticket Cache)

Type: string

(Optional) Specifies the location of the Kerberos ticket cache file. Required if authtype is set to Kerberos. No default value.

user (User Name)

Type: string

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

password (Password)

Type: string

(Optional) Specifies the password required to log in to Event Stream Processor. Required for UserPassword authentication scheme (see authType). No default value.

isEncrypted (Is Encrypted)

Type: string

(Optional) Specifies whether password is encrypted. Valid values are true or false. If set to true, password is an encrypted field. This ensures that the Server recognizes the password as encrypted text and is able to decrypt the password at runtime. Default value is true.

getBase (Get Initial Snapshot)

Type: string

(Optional) Specifies whether the Server sends existing data in the stream at the time the subscription is set up. Valid values are true or false. If set to true, the Server does not send existing data in the stream. Default value is false.

droppable (Droppable Subscription)

Type: string

(Optional) Specifies whether the Server drops this connection if that client cannot keep up. If set to true, the Server drops the connection. Default value is false.

lossy (Lossy Subscription)

Type: string

(Optional) Specifies whether the Server may discard records if the client cannot keep up. If set to true, the Server discards records. Default value is false.

shineThrough (Shine Through Updates)

Type: string

(Optional) Used for update and upsert operations. If a field is set to shine through, then an update to an existing record does not affect the value of that field.

refreshInterval (Refresh Interval (Seconds))

Type: integer

(Optional) Specifies the pulse interval. Event Stream Processor consolidates data and sends it periodically at intervals as specified in milliseconds. A value of 0 or less disables pulsing. No default value.

dateFormat (Date Format)

Type: string

(Optional) Specifies date format. Default value is YYYY-MM-DDHH24:MI:SS:FF.

timeFormat (timeFormat)

Type: string

(Optional) Specifies time format. Default value is YYYY-MM-DDHH24:MI:SS:FF.

timestampFormat (Timestamp Format)

Type: string

(Optional) Specifies timestamp format. Default value is YYYY-MM-DDHH24:MI:SS:FF.

delimiter (Command Argument Delimiter)

Type: string

(Required) Used in the publisher command line. Default value is ##.

defaultconnection

Type: string

(Required) Specifies default connection settings used to connect to the Server. Default value is conn1.

retryInterval

Type: integer

(Required) Specifies how long to wait to reconnect to the Server if the connection is broken. Default value is 0.

pollinterval (seconds)

Type: integer

(Required) Specifies how long to wait to poll data. Default value is 0.