SOAP

Soap Version
(soapVersion)

Specify the SOAP version used with this SOAP call.

1.1

Use SOAP version 1.1 (default).

1.2

Use 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 thetime 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 (25.3) 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.

requestHttpHeaderRolescan 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_host

Provide the client host in a header <http header name> instead of X-Sender-Host.

client_service

Provide the client service in a header <http header name> instead of X-Sender-Service.

correlation_id

Provide the correlation ID in a header <http header name> instead of X-Request-Id.

transaction_id

Provide the transaction ID in a header <http header name> instead of X-Transaction-Id.

passthrough

Pass 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).

None

No 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-512

Generate 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 (25.3) 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.

false

Do not send transaction ID in the SOAP header element.

true

Send transaction ID in the SOAP Header element (default).

Message Format
(messageFormat)

Defines the formatting of the SOAP message.

None

Format messages without using linebreaks and indentation.

Linebreaks

Format messages using linebreaks, but no indentation (default).

Indentation

Format 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.

false

Do not send the correlation ID in the SOAP header element.

true

Send 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.

On

Verification on (default).

Off

Verification off.

Existence

Limit verification to the mere existence of the host.

Ssl Verify Peer
(sslVerifyPeer)

Whether to verify the peer information from the SSL connection.

On

Verification on (default).

Off

Verification 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

alias

Specify 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).

None

No 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-512

Generate header using SHA-512 algorithm.

<any>

Array of

in

Use 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.

urlParameter

in

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

<any>

out

Use this parameter to supply the content to be used by the listed methods.

SOAPHeaderElement

encoding

String

encodingStyle

Specifies the encoding style used to construct the message.

header

Blob

-

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

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

mustunderstand

Boolean

mustUnderstand

This attribute says whether or not the recipient (indicated by the role attribute) is required to process a header entry.

name

String

-

Holds the name of a header block.

namespace

String

-

Defines the namespace to be assigned to the header element serialized with use="encoded".

relay

Boolean

relay

If 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.

role

String

role

The role is optional and defines the recipient of the header message.

url

string

in

This parameter contains the URL that will be accessed by the adapter. The URL contains protocol, port and path.

content

Blob

in

post, put, write

Use this parameter to supply the content to be used by the listed methods.

headerParameters

Array of HeaderField

in

http, https

Use this parameter to supply additional header information for the URL adapter call in the form of name and value pairs.

method

String

in

This parameter provides the method of the URL adapter call.

authentication

Authentication

in

ldap, ftp, ftps, sftp, http, https

This parameter provides an object of type Authentication containing the user and the password.

proxy

Proxy

in

ldap, ftp, ftps, sftp, http, https

Use this parameter to supply necessary proxy information.

followRedirects

Integer

in

http, https

Specify here the maximum number of redirects to follow.

ssl

SSL

in

https, ftps

Use this parameter to supply SSL information.

commands

Array of String

in

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

options

Array of Option

in

ldap, ftp, ftps, sftp, http, https

Use this parameter to specify cURL options for the URL adapter call.

HTTPTransport

headers

Array 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.

statusCode

Integer

HTTP status code of the SOAP request.

httpHeaderMap

Map of Entry

Runtime 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 (25.3) HTTP Header Support for more information on the standard xUML HTTP headers.