Web Services (SOAP) Output Adapter Configuration

Type: string

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

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

For example, espconnector.

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: 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) Element containing elements for the ESP subscriber.

Type: string

(Required if running adapter in standalone mode; optional if running in managed mode) Specifies the unique project tag 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 element within the Event Stream Processor (EspProjects) element.

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 element as the adapter automatically detects the project name.

Type: string

(Required if running adapter in standalone mode; optional if running in managed mode) Name of the ESP stream from which the adapter subscribes to 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 element as the adapter automatically detects the stream name.

Type: boolean

(Advanced) If set to true, the adapter runs in guaranteed delivery (GD) mode and all GD-related parameters become required. Default value is false.

Type: string

(Advanced) Specifies column name in the Flex operator holding the GD key. The GD key is a constantly increasing value that uniquely identifies every event regardless of the opcode in the stream of interest. No default value.

Type: string

(Advanced) Specifies name of column in Flex operator holding opcode. The opcode is the operation code (for example, inserts, update, or delete) of the event occurring in the stream of interest. No default value.

Type: integer

(Advanced) Specifies number of records after which the control window must be updated with the latest GD key. Default value is 3.

Type: integer

(Advanced) Specifies number of records after which to purge the Flex operator. Default value is 1000.

Type: string

(Advanced) Specifies name of the control window in the GD setup. The control window is a source stream that informs the Flex operator of which data has been processed by the adapter and can be safely deleted. No default value.

(Required) Section containing all information for the SOAP output transporter module. 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.

Type: integer

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

Section containing the polling element Enabled.

Type: boolean

(Required) Turns on polling for the Web Service Client Output adapter. This element should always be enabled for the output adapter.

(Required) Element containing the SOAPOutputTraansportParameters element.

(Required) Element containing the parameters for the SOAP Output 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, and mappingFile elements.

(Required) Element 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) Specify the Web service request. Includes the action attribute which specifies the action performed by the Web service operation that is being called.

Type: string

(Required for adapter operation and schema discovery) Specifies a valid path to the mapping file you want the adapter to use.

(Required) Element 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.

Type: string

(Required only if ESP projects are running in SSL mode) Specify the password to access the trust store.

(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, 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.