SAP RFC Input Adapter Configuration

Logging

XML Element	Description
Log4jProperty	Type: `string` (Optional) Specify a full path to the log4j.properties logging file you wish to use. The default value is STREAMING_HOME/adapters/framework/config/log4j.properties.

XML Element

Description

Log4jProperty

Type: string

(Optional) Specify a full path to the log4j.properties logging file you wish to use. The default value is STREAMING_HOME/adapters/framework/config/log4j.properties.

Encryption

XML Element	Description
Cipher	Type: `string` (Optional) Specify a full path to the adapter.key encryption file you wish to use. The default value is $STREAMING_HOME/adapters/framework/adapter.key.

XML Element

Description

Cipher

Type: string

(Optional) Specify a full path to the adapter.key encryption file you wish to use. The default value is $STREAMING_HOME/adapters/framework/adapter.key.

Transporter Module: RFC Input Transporter

The RFC Input Transporter executes RFCs and publishes the retrieved data to streams and windows in Event Stream Processor. It has three modes: generic RFC (includes RFC chaining capabilities), read table, and BW.

XML Elements	Description
Module	(Required) Element containing all information for the RFC Input transporter. It contains a type attribute for specifying the module type. For example, transporter.
InstanceName	Type: `string` (Required) Instance name of the specific module you want to use. For example, MyInputTransporter.
Name	Type: `string` (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.
Polling	Element containing the polling elements, Enabled and TimeInterval.
Enabled	Type: `boolean` (Required) Turns on polling for the RFC Input adapter. If this is set to false, the TimeInterval property is ignored.
TimeInterval	Type: `integer` (milliseconds) (Required) The polling interval, in milliseconds, for the RFC Input adapter. If polling is enabled and this value is set to 0, the adapter polls for data only once.
Next	Type: `string` (Required) Instance name of the module that follows this one.
BufferMaxSize	Type: `integer` (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240.
Parameters	(Required) Element containing the RFCInputTransporterParameters element.
RFCInputTransporterParameters	(Required) Element containing elements for the RFC Input transporter.
Host	Type: `string` (Required) The host name of the SAP system to which the adapter is connected.
SystemNumber	Type: `string` (Required) The system number of the SAP system to which the adapter is connected.
Client	Type: `string` (Required) The SAP client number for connecting to an SAP server.
SAPUser	Type: `string` (Required) The user name of the SAP system to which the adapter is connected.
SAPPassword	Type: `string` (Required) The password for the SAP system to which the adapter is connected. Includes an "encrypted" attribute indicating whether the Password value is encrypted. If set to true, the password value is decrypted using the Keystore and KeystorePassword elements. Default value is false.
Keystore	Type: `string` (Optional) Specify the location of a Java keystore file which contains the key used to encrypt or decrypt the password set in the Password element. If sandboxing is enabled, this file must reside in the <sandbox-base-directory>/adapters/<workspace-name> or $STREAMING_HOME/adapters/rfc directory or one of their subdirectories. If the file is in a different location, the adapter will not be able to successfully connect to Event Stream Processor.
KeystorePassword	Type: `string` (Optional) Stores the password to the keystore file specified in the Keystore element.

RFC Input Transporter Elements: Generic RFC Mode Elements

In this mode, the input adapter invokes any RFCs you specify in the adapter configuration file and obtains output data from the export, changing, and table type RFC elements. Specify these RFC elements in the mapping file. The adapter converts this data into ESP data rows which then get published into the ESP streams to which it is connected. The adapter can use values from the mapping file as input to the RFC when making RFC calls. You can also use the mapping file to configure which ESP stream columns the RFC publishes its output data.

XML Element	Description
RFC	(Required for the generic RFC mode only) Element containing the Functions, Function, and Mapping elements for the adapter's generic RFC mode.
Functions	(Required for the generic RFC mode only) Element containing the RFCs you want the adapter to execute as specified by the Function element. You can specify multiple Function elements. If you specify multiple RFCs, the RFCs execute in the order listed. This is called RFC chaining.
Function	Type: `string` (Required) Specify an RFC you wish the adapter to execute.
Mapping	Type: `string` (Required for adapter operation and schema discovery) Specify the full path to and the name of the mapping file.

RFC Input Transporter Elements: Read Table Mode Elements

The read table mode invokes the RFC named RFC_READ_TABLE which retrieves columns of a specified SAP table and returns the data as a result set. You can map the result set to ESP streams or windows using the Fields element. Specify the table name for this RFC using the Table element in the adapter configuration file. This mode is similar to reading a database table.

This mode has a number of limitations. See Read Table Mode for additional details on these limitations.

XML Element	Description
ReadTable	(Required for the read table mode only) Element containing the Table, Mapping, RowCount, Fields, Field, Options, and Option elements for the adapter's read table mode.
Table	Type: `string` (Required for the read table mode) The table from which the adapter obtains data while in read table mode.
Mapping	Type: `string` (Required for adapter operation and schema discovery) Specify the name of the mapping file.
RowCount	Type: `integer` (Required) The number of rows to be read while the adapter is in read table mode.
Fields	(Optional) Element containing the Field element. If you do not specify this element, all columns from the table are read by the adapter. Specify this element to work around the total column size limit imposed by RFC_READ_TABLE in the case that a table has many columns.
Field	Type: `string` (Required) Specifies the names of the columns to be read by RFC_READ_TABLE.
Options	(Optional for the read table mode) Element containing the Option element.
Option	Type: `string` (Dependent required for the read table mode) Specifies the WHERE clause when querying the table during read table mode. If the Options element is specified, specify at least one Option element.

RFC Input Transporter Elements: BW Mode Elements

In BW mode, the adapter submits MDX (multidimensional expression) statements against defined BW queries (cubes). It returns data sets which can be multi-dimensional and organized on multiple axes. However, Event Stream Processor can only handle data in a tabular format (2-dimensional) meaning an axis for columns and an axis for rows. The adapter “flattens out” any data set returned by the MDX query into a table with columns and rows so that it can be input into Event Stream Processor. You can specify which columns from this table map to ESP streams using the mapping file.

See BW Mode for additional details on this mode.

XML Element	Description
BW	(Required for the BW mode only) Element containing the Query, MDX, Line, and Mapping elements for the adapter BW mode.
Query	Type: `string` (Required for the BW mode only) Specify the BW query to execute MDX statements against.
MDX	(Required for the BW mode only) Element containing the Line element which specfies the multidimension expression you want the adapter to execute.
Line	Type: `string` (Required for the BW mode only) Lines containing the MDX expression you want the adapter to execute. It is typical to have multiple lines as each line can contain no more than 75 characters.
Mapping	Type: `string` (Required for adapter operation and schema discovery) Specify the name of the mapping file.

ESP Connector Module: ESP Publisher

The ESP Publisher module obtains data from a transporter or formatter module and publishes it to the SAP Event Stream Processor project.

XML Element	Description
Module	(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter.
InstanceName	Type: `string` (Required) Instance name of the specific module you want to use. For example, MyInputTransporter.
Name	Type: `string` (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.
BufferMaxSize	Type: `integer` (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240.
Parameters	(Required) Element containing the EspPublisherParameters element.
EspPublisherParameters	(Required) Element containing elements for the ESP publisher.
ProjectName	Type: `string` (Required if adapter is running in standalone mode; optional if it is running in managed mode) Name of the ESP project to which the adapter is connected. For example, StreamingProject2. This is the same project tag that you specify later in the adapter configuration file in the Name element within the Event Stream Processor (EspProjects) element. If you are starting the adapter with the ESP project to which it is attached (that is, running the adapter in managed mode), you need not set this element as the adapter automatically detects the project name.
StreamName	Type: `string` (Required if adapter is running in standalone mode; optional if it is running in managed mode) Name of the stream to which the adapter publishes data. If you are starting the adapter with the ESP project to which it is attached (that is, running the adapter in managed mode), you need not set this element as the adapter automatically detects the stream name.
MaxPubPoolSize	Type: `positive integer` (Optional) 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. Record pooling is disabled if this value is 1. The default value is 256.
MaxPubPoolTime	Type: `positive integer` (Optional) 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. The default value is false.
SafeOps	Type: `boolean` (Advanced) Converts the opcodes INSERT and UPDATE to UPSERT, and converts DELETE to SAFEDELETE. The default value is false.
SkipDels	Type: `boolean` (Advanced) Skips the rows with opcodes DELETE or SAFEDELETE. The default value is false.

SAP Event Stream Processor Elements

SAP Event Stream Processor elements configure communication between Event Stream Processor and the SAP RFC Input adapter.

XML Element	Description
EspProjects	(Required) Element containing elements for connecting to Event Stream Processor.
EspProject	(Required) Element containing the Name and Uri elements. Specifies information for the ESP project to which the adapter is connected.
Name	Type: `string` (Required) Specifies the unique project tag of the ESP project which the EspConnector (publisher/subscriber) module references.
Uri	Type: `string` (Required) Specifies the total project URI to connect to the ESP project. For example, if you have SSL enabled, use esps://localhost:19011/ws1/p1.
Security	(Required) Element containing all the authentication elements below. Specifies details for the authentication method used for Event Stream Processor.
User	Type: `string` (Required) Specifies the user name required to log in to Event Stream Processor (see AuthType). No default value.
Password	Type: `string` (Required) Specifies the password required to log in to Event Stream Processor (see AuthType). Includes an "encrypted" attribute indicating whether the Password value is encrypted. The default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword.
AuthType	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, AuthType is overridden by the Authentication Mode Studio start-up parameter.
RSAKeyStore	Type: `string` (Dependent required) Specifies the location of the RSA keystore, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both.
RSAKeyStorePassword	Type:`string` (Dependent required) Specifies the keystore password, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both.
KerberosKDC	Type: `string` (Dependent required) Specifies host name of Kerberos key distribution center. Required if AuthType is set to kerberos.
KerberosRealm	Type: `string` (Dependent required) Specifies the Kerberos realm setting. Required if AuthType is set to kerberos.
KerberosService	Type: `string` (Dependent required) Specifies the Kerberos principal name that identifies the Event Stream Processor cluster. Required if AuthType is set to kerberos.
KerberosTicketCache	Type: `string` (Dependent required) Specifies the location of the Kerberos ticket cache file. Required if AuthType is set to kerberos.
EncryptionAlgorithm	Type: `string` (Optional) Used when the encrypted attribute for Password is set to true. If left blank, RSA is used as default.