Web Services (SOAP) Input Adapter Configuration

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.

(Required) Section containing all information for the SOAP input transporter. It contains a type attribute for specifying the module type. For example, transporter.

Type: string

(Required) Instance name of the specific module you want to use. For example, MyInputTransporter.

Type: string

(Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.

Section containing the polling elements, Enabled and TimeInterval.

Type: boolean

(Required) Turns on polling for the Web Service (SOAP) Input adapter. This element should always be enabled for the input adapter. If set to false, the TimeInterval and MaxPollCount properties are ignored.

Type: integer (milliseconds)

(Required) The polling interval for the Web Services (SOAP) Input adapter.

Type: java.lang.long

(Optional) Specify the maximum number of times to call the polling interface. The default value is 9223372036854775807, which is the maximum value of the java.lang.long datatype. Leaving it to the default value means the adapter polls for data indefinitely.

Type: string

(Required) Instance name of the module that follows this one.

Type: integer

(Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240.

(Required) Section containing the SOAPInputTransportParameters element.

(Required) Element containing elements for the SOAP Input transporter.

Type: string

(Required) Specify the Web service to which the adapter connects. Include the name attribute. For example, name="StockTraderService".

This section contains the urls, wsdlURL, serviceURL, serviceTimeout, serviceRetries, request, mapFilePath, and security elements.

(Required) Section containing the wsdlURL and serviceURL elements.

Type: string

(Required) The URL for the Web service's WSDL.

Type: string

(Dependent required) Required only if you want to call the Web service at a different endpoint than what is specified in the wsdlURL element. For example, for testing purposes or tcpMon.

Type: integer

(Required) Specifies the amount of time the adapter waits before timing out the connection with the Web service.

Type: integer

(Required) Specifies the number of times the adapter retries each service endpoint if it fails to connect.

Type: string

(Required) Section containing the param element. Specifies the Web service request. Includes the action attribute which specifies the action performed by the Web service operation that is being called.

Type: string

Type: string

(Required for adapter operation and schema discovery) Specify a valid path to the mapping file for the adapter. If sandboxing is enabled, this file must reside in the <sandbox-base-directory>/adapters/<workspace-name> or $STREAMING_HOME/adapters/webservices 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.

(Required) Section containing the adapter security configuration. The adapter supports HTTPS protocol, HTTP basic access authentication, WS policy security, and transport level security. Specify either WS policy security or transport level security.

Type: string

(Required only if ESP projects are running in SSL mode) Specify the path to the trust store file containing the server's certificate.

(Required only if using WS policy security) Element containing the credentials, User, Password, RSAKeyStore, RSAKeyStorePassword, policyClass, and param elements for WS policy security.

(Optional) Element containing the User and Password, RSAKeyStore, and RSAKeyStorePassword elements.

Type: string

(Optional) Specifies the user name required to connect to the Web service.

Type: string

(Optional) Specifies the password required to connect to the Web service. 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.

Type: string

(Optional) Specify the location of an RSA keystore file which contains the key used to encrypt or decrypt the password set in the Password element.

Type: string

(Optional) Stores the password to the RSA keystore file specified in the Keystore element.

Type: string

(Required only if using WS policy security) Specifies the plugin class to use that provides the policy information to the system. This class must extend from the class com.sap.esp.adapter.ws.security.WSPolicy.

Type: string

(Optional) Specifies the elements needed by the security mechanism of the WS policy. Includes "name" and "value" attributes.

(Required only if using transport level security) Element containing the credentials, User, Password, RSAKeyStore, RSAKeyStorePassword, and EncryptionAlgorithm elements. This type of security uses a username/token which is signed at the transport level.

(Required) Element containing the User, Password, RSAKeyStore, RSAKeyStorePassword, and EncryptionAlgorithm elements. Specifies credentials for transport level security.

Type: string

(Required) Specifies the user name required for connecting to the Web service.

Type: string

(Required) Specifies the password required to connect to the Web service. 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.

Type: string

(Optional) Specify the location of an RSA keystore file which contains the key used to encrypt or decrypt the password set in the Password element.

Type: string

(Optional) Stores the password to the RSA keystore file specified in the Keystore element.

Type: string

(Optional) Specifies the algorithm that is used to decrypt the password specified in the Password element, if encrypted. For example, RSA.

Type: string

(Required) Element containing the proxy, host, port, and nonProxyHost elements.

The directory where temporary adapter files are written. These files are cleaned up when the adapter shuts down.

(Optional) Element containing the host, port, and nonProxyHosts elements. These properties specify a proxy server address through which the HTTP traffic is routed. This is often required in corporate networks, such as SAP, as individual machines do not connect directly to the external internet.

Type: string

(Optional) If the adapter needs to connect through a proxy, specify the host of the proxy through which the adapter is connecting.

Type: integer

(Optional) If the adapter needs to connect through a proxy, specify the host of the proxy through which the adapter is connecting.

Type: string

(Optional) Specify the host names which should not be routed through the proxy host. These are addresses located within the intranet that can be reached directly.

(Required) Element containing all information for this module. It contains a type attribute for specifying the module type.

For example, formatter.

Type: string

(Required) Instance name of the specific module you want to use. For example, MyInputTransporter.

Type: string

(Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.

Type: integer

(Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240.

(Required) Section containing the EspPublisherParameters element.

(Required) Section containing elements for the ESP publisher.

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.

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.

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.

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.

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.

Type: boolean

(Advanced) Converts the opcodes INSERT and UPDATE to UPSERT, and converts DELETE to SAFEDELETE. The default value is false.

Type: boolean

(Advanced) Skips the rows with opcodes DELETE or SAFEDELETE. The default value is false.