Configure the SAP RFC Input adapter by specifying values for the RFC Polling Input transporter, the ESP connector (EspPublisher), and Event Stream Processor.
| Parameter | Description |
|---|---|
| Log4jProperty |
Type: string (Optional) Specify the path to the log4j.properties logging file you wish to use. The default value is $ESP_HOME/adapters/framework/config/log4j.properties. |
| Parameter | Description |
|---|---|
| Module |
(Required) Section containing all information for the RFC polling input transporter. It contains a type attribute for specifying the module type. For example, transporter. |
| InstanceName |
Type: string (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter. |
| Name |
Type: string (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
| Polling |
Section containing the polling parameters, Enabled and TimeInterval. |
| Enabled |
Type: boolean (Required) Turns on polling for the RFC Input adapter. This parameter must always be enabled for the input adapter. |
| TimeInterval |
Type: integer (milliseconds) (Required) The polling interval for the RFC Input adapter. |
| Next |
Type: string (Required) Specify the instance name of the module that follows this one. |
| Parameters |
(Required) Section containing the RFCInputTransporterParameters element. |
| RFCInputTransporterParameters |
(Required) Section containing parameters 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 parameters. 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 parameter. |
| KeystorePassword |
Type: string (Optional) Stores the password to the keystore file specified in the Keystore parameter. |
| Parameter | Description |
|---|---|
| RFC |
(Required for the generic RFC mode only) Section containing the Functions, Function, and Mapping parameters for the adapter's generic RFC mode. |
| Functions |
(Required for the generic RFC mode only) Section containing the RFCs you want the adapter to execute as specified by the Function parameter. You can specify multiple Function parameters. 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 name of the mapping file. |
| Parameter | Description |
|---|---|
| ReadTable |
(Required for the read table mode only) Section containing the Table, Mapping, RowCount, Fields, Field, Options, and Option parameters 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) Section containing the Field parameter. If you do not specify this section, all columns from the table are read by the adapter. Specify this section 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) Section containing the Option parameter. |
| 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 parameter is specified, specify at least one Option parameter. |
| Parameter | Description |
|---|---|
| BW |
(Required for the BW mode only) Section containing the Query, MDX, Line, and Mapping parameters 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) Section containing the Line parameter 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. |
| Parameter | Description |
|---|---|
| Module |
(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter. |
| InstanceName |
Type: string (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter. |
| Name |
Type: string (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
| Parameters |
(Required) Section containing the EspPublisherParameters parameter. |
| EspPublisherParameters |
(Required) Section containing parameters for the ESP publisher. |
| ProjectName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Name of the ESP project to which the adapter is connected. For example, EspProject2. This is the same project tag that you specify later in the adapter configuration file in the Name parameter of the Event Stream Processor (EspProjects) parameters section. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this property as the adapter automatically detects the project name. |
| StreamName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Name of the ESP stream to which the adapter publishes data. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this property as the adapter automatically detects the stream name. |
| 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. |
| 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. |
| 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. |
Event Stream Processor parameters configure communication between Event Stream Processor and the SAP RFC Input adapter.
| Parameter | Description |
|---|---|
| EspProjects |
Section containing parameters for connecting to Event Stream Processor. |
| EspProject |
Section containing the Name and Uri parameters. 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 Event Stream Processor cluster. For example, esp://localhost:19011/ws1/p1. |
| Security |
Section containing all the authentication parameters 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 espAuthType). Includes an "encrypted" attribute indicating whether the Password value is encrypted. Default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
| AuthType |
Type: string (Required) Specifies method used to authenticate to the
Event Stream Processor. Valid values are:
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 an 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. |