Tagged Values

Anchor

	SOAPAlias
	SOAPAlias

<<SOAPAlias>>

Multiexcerpt

MultiExcerptName	SOAPAlias

Tagged Value Description Allowed Values / Examples

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)

Multiexcerpt include

SpaceWithExcerpt	WBRIDGE
MultiExcerptName	timezone
nopanel	true
PageWithExcerpt	SOAP Service Reference

Multiexcerpt include

MultiExcerptName	timezone_examples
nopanel	true
PageWithExcerpt	SOAP Service Reference

Date Format String
(dateFormatString)

Multiexcerpt include

MultiExcerptName	dateFormatString
nopanel	true
PageWithExcerpt	SOAP Service Reference

Multiexcerpt include

MultiExcerptName	dateFormatString_examples
nopanel	true
PageWithExcerpt	SOAP Service Reference

Request Http Header Roles
(requestHttpHeaderRoles)

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	request_http_header_roles
PageWithExcerpt	INTERNAL:_bridge_excerpts

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	request_http_header_roles_adapter
PageWithExcerpt	INTERNAL:_bridge_excerpts

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)

Multiexcerpt

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

Info
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 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)

Multiexcerpt include

MultiExcerptName	proxyType
nopanel	true
PageWithExcerpt	URL

one of: HTTP, SOCKS5

Proxy User
(proxyUser)

Multiexcerpt include

MultiExcerptName	proxyUser
nopanel	true
PageWithExcerpt	URL

Proxy URL
(proxyURL)

Multiexcerpt include

MultiExcerptName	proxyURL
nopanel	true
PageWithExcerpt	URL

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)

Multiexcerpt include

MultiExcerptName	sslPrivateKeyType
nopanel	true
PageWithExcerpt	URL

one of: PEM (default), DER, ENG

Ssl Verify Host
(sslVerifyHost)

Multiexcerpt include

MultiExcerptName	sslVerifyHost
nopanel	true
PageWithExcerpt	URL

On

Verification on (default).

Off Verification off.

Existence Limit verification to the mere existence of the host.

Ssl Verify Peer
(sslVerifyPeer)

Multiexcerpt include

MultiExcerptName	sslVerifyPeer
nopanel	true
PageWithExcerpt	URL

On

Verification on (default).

Off Verification off.

Ssl Private Key File
(sslPrivateKeyFile)

Multiexcerpt include

MultiExcerptName	sslPrivateKeyFile
nopanel	true
PageWithExcerpt	URL

Ssl Private Key Password
(sslPrivateKeyPassword)

Multiexcerpt include

MultiExcerptName	sslPrivateKeyPassword
nopanel	true
PageWithExcerpt	URL

Ssl Certificate File
(sslCertificateFile)

Multiexcerpt include

MultiExcerptName	sslCertificateFile
nopanel	true
PageWithExcerpt	URL

Ssl CA Info
(sslCAInfo)

Multiexcerpt include

MultiExcerptName	sslCAInfo
nopanel	true
PageWithExcerpt	URL

Ssl Certificate Type
(sslCertificateType)

Multiexcerpt include

MultiExcerptName	sslCertificateType
nopanel	true
PageWithExcerpt	URL

one of: PEM (default), DER, P12

Anchor

	SOAPAdapter
	SOAPAdapter

<<SOAPAdapter>>

Info

icon	false

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

Attribute

Description

Allowed Values

alias

Specify the SOAP alias the adapter should connect to.

a valid SOAP alias

digestAlgorithm

Multiexcerpt include

MultiExcerptName	digestAlgorithm
PageWithExcerpt	SOAP

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.

Div

Class	e2e-refDiv

Otp

Floating	false

Rp
Accessing the SOAP Headers Accessing HTTP Headers of a SOAP Call Providing the SOAP Adapter with URL Parameter

Tagged Values

...

Parameters

Name

Type

Direction

Description

Documentation

<any>

Array of SOAPHeaderElement

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.

Accessing the SOAP Headers

urlParameter

URLMessage

in

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

Info

icon	false

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>

HTTPTransport

out

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

...

Parameter Types

SOAPHeaderElement

Multiexcerpt

MultiExcerptName	SOAPHeaderElement

Class

Attribute

Type

SOAP Attribute

Description

Example XML Fragment

SOAPHeaderElement

encoding

String

encodingStyle

Specifies the encoding style used to construct the message.

env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"

header

Blob

-

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

Info

icon	false

The blob must contain XML structured content. So, use either the classToXML (for objects of complex types) or the classToXMLFragment (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.

env:mustUnderstand="true"

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.

env:relay="true"

role

String

role

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

env:role="http://example.com/Login"

URLMessage

Multiexcerpt

MultiExcerptName	URLMessage

Name	Type	Direction	Restrictions		Description
Name	Type	Direction	to listed protocol only	to listed method only	Description
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

Multiexcerpt

MultiExcerptName	HTTPTransport

Class

Attribute

Type

Description

HTTPTransport

headers

Array of HeaderField

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	httpHeaders_depr
PageWithExcerpt	INTERNAL:_bridge_excerpts

Header information as array of name/value pairs

...

.

statusCode

Integer

HTTP status code of the SOAP request.

httpHeaderMap

Map of Entry

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	httpHeaderMap
PageWithExcerpt	INTERNAL:_bridge_excerpts

Anchor

	URL Parameter Types
	URL Parameter Types

URLMessage and HTTPTransport Types

Multiexcerpt include

MultiExcerptName	url_parameter_types
nopanel	true
PageWithExcerpt	URL

Panel

title	On this Page:

Table of Contents

Panel

title	Related Pages:

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Tagged Values

<<SOAPAlias>>

<<SOAPAdapter>>

Tagged Values

Parameters

Parameter Types

SOAPHeaderElement

URLMessage

HTTPTransport

URLMessage and HTTPTransport Types

Page tree

Page History

Versions Compared

Old Version 2

New Version Current

Key

Tagged Values

<<SOAPAlias>>

<<SOAPAdapter>>

Tagged Values

Parameters

Parameter Types

SOAPHeaderElement

URLMessage

HTTPTransport

URLMessage and HTTPTransport Types