Set values for the Web Services (SOAP) Output Transporter in the adapter configuration file.
Parameter | Description |
---|---|
Enabled |
Type: boolean (Required) Turns on polling for the Web Service Client Output adapter. This parameter should always be enabled for the output adapter. |
Parameter | Description |
---|---|
webservice |
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 parameters. |
urls |
(Required) Section containing the wsdlURL and serviceURL parameters. |
wsdlURL |
Type: string (Required) The URL for the Web service's WSDL. |
serviceURL |
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 parameter. For example, for testing purposes or tcpMon. |
serviceTimeout |
Type: integer (Required) Specifies the amount of time the adapter waits before timing out the connection with the Web service. |
serviceRetries |
Type: integer (Required) Specifies the number of times the adapter retries each service endpoint if it fails to connect. |
request |
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. |
mappingFile |
Type: string (Required for adapter operation and schema discovery) Specifies a valid path to the mapping file you want the adapter to use. |
security |
(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. This section contains the sslTrustStore
and sslTrustStorePassword parameters,
as well as the configuration parameters for either
WSPolicy security or
TransportUsernameToken
security.
Note: You can enable only one of HTTP basic
access authentication, WS policy security, or transport
level security at a time.
|
sslTrustStore |
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. |
sslTrustStorePassword |
Type: string (Required only if ESP projects are running in SSL mode) Specify the password to access the trust store. |
BasicAccessAuthentication |
(Required only if using HTTP basic access authentication) Stores the credentials used to authenticate against a Web service that is set up with HTTP basic access authentication. Section containing the credentials, User, Password, RSAKeyStore , RSAKeyStorePassword and EncryptionAlgorithm parameters for WS policy security. |
credentials |
(Optional) Section containing the User, Password, RSAKeyStore, RSAKeyStorePassword and EncryptionAlgorithm parameters. |
User |
Type: string (Required) Specifies the user name required to connect to the Web service. |
Password |
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. |
RSAKeyStore |
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 parameter. |
RSAKeyStorePassword |
Type: string (Optional) Stores the password to the RSA keystore file specified in the Keystore parameter. |
EncryptionAlgorithm |
Type: string (Optional) Specifies the algorithm that is used to decrypt the password specified in the Password parameter, if encrypted. For example, RSA. |
Parameter | Description |
---|---|
WSPolicy |
(Required only if using WS policy security) Section containing the credentials, User, Password, RSAKeyStore, RSAKeyStorePassword, policyClass, and param parameters for WS policy security. |
credentials |
(Optional) Section containing the User, Password, RSAKeyStore, and RSAKeyStorePassword parameters. |
User |
Type: string (Optional) Specifies the user name required to connect to the Web service. |
Password |
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. |
RSAKeyStore |
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 parameter. |
RSAKeyStorePassword |
Type: string (Optional) Stores the password to the RSA keystore file specified in the Keystore parameter. |
policyClass |
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. |
param |
Type: string (Optional) Specifies the parameters needed by the security mechanism of the WS policy. Includes "name" and "value" attributes. |
Parameter | Description |
---|---|
TransportUsernameToken |
(Required only if using transport level security) Section containing the credentials, User, Password, RSAKeyStore, RSAKeyStorePassword, and EncryptionAlgorithm parameters. This type of security uses a username/token which is signed at the transport level. |
credentials |
(Required) Section containing the User, Password, RSAKeyStore, RSAKeyStorePassword, and EncryptionAlgorithm parameters. Specifies credentials for transport level security. |
User |
Type: string (Required) Specifies the user name required for connecting to the Web service. |
Password |
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. |
RSAKeyStore |
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 parameter. |
RSAKeyStorePassword |
Type: string (Optional) Stores the password to the RSA keystore file specified in the Keystore parameter. |
EncryptionAlgorithm |
Type: string (Optional) Specifies the algorithm that is used to decrypt the password specified in the Password parameter, if encrypted. For example, RSA. |
Parameter | Description |
---|---|
workingDir |
Type: string (Required) Section containing the proxy, host, port, and nonProxyHost parameters. The directory where temporary adapter files are written. These files are cleaned up when the adapter shuts down. |
proxy |
(Optional) Section containing the host, port, and nonProxyHosts parameters. 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. |
host |
Type: string (Optional) If the adapter needs to connect through a proxy, specify the host of the proxy through which the adapter is connecting. |
port |
Type: integer (Optional) If the adapter needs to connect through a proxy, specify the host of the proxy through which the adapter is connecting. |
nonProxyHosts |
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. |