Skip to main content
Skip table of contents

SOAP

Tagged Values

<<SOAPAlias>>

Tagged ValueDescriptionAllowed Values / Examples

Soap Version
(soapVersion)

Specify the SOAP version used with this SOAP call.

1.1Use SOAP version 1.1 (default).
1.2Use SOAP version 1.2.

Protocol
(protocol)

Specify the transport protocol.

Method
(method)
Specify the HTTP method.One of: get, post (default), read, write, put, list, patch

Port
(port)
Specify the machine port number the service is binding to.a valid port number (default: 80)

Path
(path)
Specify the HTTP path for the SOAP request.

Host
(host)
Specify an optional host name.a valid hostname (default: localhost)
Advanced


Timezone
(timezone)

Time zone string as specified in the time zone appendix. timezone is used to print DateTime expressions.

Examples: "Australia/Melbourne", "CET", "Etc/GMT+10".

If "local" is used, the date/time is printed relative to the local timezone of the Bridge, for example:
2012-10-01T12:36:47.0+02:00 (the timezone of the Bridge is UTC+02:00)

Date Format String
(dateFormatString)

Date formatting code as listed in Date and Time Formatting. If nothing is defined, the XSD standard is used.

Example: %F

Request Http Header Roles
(requestHttpHeaderRoles)



Builder 7.12.0 Runtime 2020.12 In the context of HTTP based adapters (URL, REST, SOAP), enable automatic header generation for the listed headers. These definitions overwrite the default behavior, and X-Transaction-Id, X-Request-Id, X-Sender-Host and/or X-Sender-Service will be substituted by this definition.

requestHttpHeaderRoles can hold a list of definitions in format <http header name>:<role>, that will automatically be generated for each adapter call on this alias. <role> can be one of the listed allowed values (one list entry per line).
Refer to HTTP Header Support > Overwriting the Standard HTTP Headers for more details on header roles.






client_hostProvide the client host in a header <http header name> instead of X-Sender-Host.
client_serviceProvide the client service in a header <http header name> instead of X-Sender-Service.
correlation_idProvide the correlation ID in a header <http header name> instead of X-Request-Id.
transaction_idProvide the transaction ID in a header <http header name> instead of X-Transaction-Id.
passthroughPass a present header <http header name> to the called service.
passthrough= <request header name>Pass an incoming header <request header name> to the called service under the name of <http header name>.
This is equivalent to renaming a header.
Digest Algorithm
(digestAlgorithm)

Builder 7.12.0 Runtime 2021.1 Generates a HTTP digest header using the specified algorithm. When applied, a  digest  header is generated using the specified algorithm, and sent with the request . The generated header conforms with RFC3230 and RFC5843. 

Only one value is supported (no multi-value header).

NoneNo header generated.
MD5Generate header using MD5 algorithm.
SHAGenerate header using SHA algorithm.
SHA-1Generate header using SHA-1 algorithm.
SHA-256Generate header using SHA-256 algorithm.
SHA-512Generate header using SHA-512 algorithm.
Follow Redirects
(followRedirects)
Maximum number of redirects to follow.any integer
Options
(options)
Specify native cURL options as listed in Setting cURL Options on the URL Adapter.
Also refer to this page for more details on how to set these options.
Example: CURLOPT_TIMEOUT=20
Ignore Http Errors
(ignoreHttpErrors)
Not implemented for SOAP.
Authentication
User
(user)
Username/password.
Proxy
Proxy Type
(proxyType)

Type of the proxy

one of: HTTP, SOCKS5
Proxy User
(proxyUser)

Proxy user.


Proxy URL
(proxyURL)

URL of the proxy server.


SOAP

Send Transaction ID
(sendTransactionID)

Defines whether the transaction ID is sent in a SOAP header element <TransactionID>...</TransactionID> with namespace http://e2e.ch/bridge .
If sent, the calling and the called service can be identified to belong to the same transaction.

falseDo not send transaction ID in the SOAP header element.
trueSend transaction ID in the SOAP Header element (default).

Message Format
(messageFormat)



Defines the formatting of the SOAP message.

NoneFormat messages without using linebreaks and indentation.
LinebreaksFormat messages using linebreaks, but no indentation (default).
IndentationFormat messages using linebreaks and indentation.

SendCorrelationID
(sendCorrelationID)

Defines whether the correlation ID is sent in a SOAP header element <CorrelationID>...</CorrelationID> with namespace http://e2e.ch/bridge .
The correlation ID is used to identify each SOAP call.

falseDo not send the correlation ID in the SOAP header element.
trueSend the correlation ID in the SOAP header element (default).
SSL
Ssl Private Key Type
(sslPrivateKeyType)

Type of the private key.

one of: PEM (default), DER, ENG
Ssl Verify Host
(sslVerifyHost)

Whether to verify the host information form the SSL connection.



OnVerification on (default).
OffVerification off.
ExistenceLimit verification to the mere existence of the host.
Ssl Verify Peer
(sslVerifyPeer)

Whether to verify the peer information from the SSL connection.

OnVerification on (default).
OffVerification off.
Ssl Private Key File
(sslPrivateKeyFile)

Name of the file that contains the private key.



Ssl Private Key Password
(sslPrivateKeyPassword)

Password for the private key.



Ssl Certificate File
(sslCertificateFile)

Name of the file that contains the client certificate.



Ssl CA Info
(sslCAInfo)

Name of the file containing additional certificates for the connection verification (e.g. additional root CAs).



Ssl Certificate Type
(sslCertificateType)

Type of the certificate.

one of: PEM (default), DER, P12

<<SOAPAdapter>>

Since Runtime 2022.6 the Runtime uses Transfer-encoding: chunked for POST requests.

AttributeDescriptionAllowed Values
aliasSpecify the SOAP alias the adapter should connect to.a valid SOAP alias
digestAlgorithm

Builder 7.12.0 Runtime 2021.1 Generates a HTTP digest header using the specified algorithm. When applied, a  digest  header is generated using the specified algorithm, and sent with the request . The generated header conforms with RFC3230 and RFC5843. 

Only one value is supported (no multi-value header).

NoneNo header generated.

MD5

Generate header using MD5 algorithm.

SHA

Generate header using SHA algorithm.

SHA-1

Generate header using SHA-1 algorithm.

SHA-256

Generate header using SHA-256 algorithm.
SHA-512Generate header using SHA-512 algorithm.

Parameters

NameTypeDirectionDescriptionDocumentation
<any>Array of SOAPHeaderElementinUse this parameter to provide the SOAP headers in an array of type SOAPHeaderElement. The xUML Runtime will then set the SOAP headers accordingly to the header block of the SOAP message.Accessing the SOAP Headers
urlParameterURLMessagein

Use this parameter to supply the URL that will be accessed by the adapter and some additional URL parameters, e.g cURL options.

urlParameter contains an array of HTTP header fields. Do not confuse these headers with the SOAP headers (see above). The SOAP headers go to the SOAP message to the body of the HTTP call, the headers from urlParameter go to the HTTP headers.

Providing the SOAP Adapter with URL Parameter
<any>HTTPTransportoutUse this parameter to supply the content to be used by the listed methods.SOAP Call and HTTP Headers

Parameter Types

SOAPHeaderElement

ClassAttributeTypeSOAP AttributeDescriptionExample XML Fragment
SOAPHeaderElementencodingStringencodingStyleSpecifies the encoding style used to construct the message.
env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"
headerBlob-

The header holds the actual header data of base type Blob.

The blob must contain XML structured content. So, use either the classToXML() Operation (for objects of complex types) or the classToXMLFragment() Operation (for objects of base types) to provide the necessary structure.


mustunderstandBooleanmustUnderstandThis attribute says whether or not the recipient (indicated by the role attribute) is required to process a header entry.
env:mustUnderstand="true"
nameString-Holds the name of a header block.
namespaceString-Defines the namespace to be assigned to the header element serialized with use="encoded".
relayBooleanrelayIf relay is set to true, it indicates that the SOAP header block must not be processed by any node that is targeted by the header block, but must only be passed on to the next targeted node.
env:relay="true"
roleStringroleThe role is optional and defines the recipient of the header message.
env:role="http://example.com/Login"

URLMessage

NameTypeDirectionRestrictionsDescription
to listed protocol onlyto listed method only
urlstringin

This parameter contains the URL that will be accessed by the adapter. The URL contains protocol, port and path.
contentBlobin
post, put, writeUse this parameter to supply the content to be used by the listed methods.
headerParametersArray of HeaderField inhttp, https
Use this parameter to supply additional header information for the URL adapter call in the form of name and value pairs.
methodStringin

This parameter provides the method of the URL adapter call.
authentication Authentication inldap, ftp, ftps, sftp, http, https
This parameter provides an object of type Authentication containing the user and the password.
proxy Proxy inldap, ftp, ftps, sftp, http, https
Use this parameter to supply necessary proxy information.
followRedirectsIntegerinhttp, https
Specify here the maximum number of redirects to follow.
ssl SSL inhttps, ftps
Use this parameter to supply SSL information.
commandsArray of Stringinftp, ftps

Use this parameter to specify ftp commands. All commands are executed after executing the ftp method. For a list of available ftp commands see RFC 959.

optionsArray of Option inldap, ftp, ftps, sftp, http, https
Use this parameter to specify cURL options for the URL adapter call.

HTTPTransport

ClassAttributeTypeDescription
HTTPTransportheadersArray of HeaderField

DeprecatedThis attribute is deprecated as of Runtime 2020.11. Please use httpHeaderMap (see below) for new implementations as its implementation complies to the HTTP specification.

Header information as array of name/value pairs.

statusCodeIntegerHTTP status code of the SOAP request.
httpHeaderMapMap of EntryRuntime 2020.11 Header information as a map. The map contains arrays of header value strings whereas the header name is the key of the map.
  • Header names are lowercase and treated case insensitive.
  • Multiple headers with the same name are treated as arrays.

Refer to HTTP Header Support for more information on the standard xUML HTTP headers.

URLMessage and HTTPTransport Types

ClassAttributeTypeCURL OptionDescriptionValues/Example
AuthenticationpasswordString
Password needed for authentication.
usernameString
Username needed for authentication.
EntrykeyString
Key of the map entry.
valueArray of Any

List of values of the map entry. The dynamic type for httpHeaderMap is String.


HeaderFieldnameString
Name of the header field.
valueString
Value of the header field.
OptionnameString
Native cURL option.CURLOPT_CONNECTTIMEOUT
valueString
Value of the cURL option.10
ProxyauthenticationAuthenticationCURLOPT_PROXYUSERPWDProxy user.
typeStringCURLOPT_PROXYTYPEType of the proxy.HTTP, SOCKS5
urlStringCURLOPT_PROXYURL of the proxy server.
SSLcaInfoStringCURLOPT_CAINFOName of the file containing additional certificates for the connection verification (e.g. additional root CAs).
certificateCertificate
Client certificate
keyKey
Private key of client certificate
verifyHostStringCURLOPT_SSL_VERIFYHOST

Whether to verify the host information form the SSL connection.

OnVerification on (default).
OffVerification off.
ExistenceLimit verification to the mere existence of the host.
verifyPeerStringCURLOPT_SSL_VERIFYPEERWhether to verify the peer information from the SSL connection.OnVerification on (default).
OffVerification off.
KeyfileStringCURLOPT_SSLKEYName of the file containing the private key.
passwordStringCURLOPT_KEYPASSWDPassword for the private key.
typeStringCURLOPT_SSLKEYTYPEType of the key.PEM, DER, ENG
CertificatefileStringCURLOPT_SSLCERTName of the file containing the client certificate.
typeStringCURLOPT_SSLCERTTYPEType of the certificate.PEM, DER, P12

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.