Page tree
Skip to end of metadata
Go to start of metadata

Tagged Values (<<SOAPAlias>>)

Tagged ValueDescriptionAllowed Values
SOAP
messageFormatDefines the formatting of the SOAP message.Noneno linebreaks and no indentation
Linebreaks (default)linebreaks, but no indentation
Indentationlinebreads and indentation
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.

falsetransaction ID is not sent in the SOAP header element
true (default)transaction ID is sent in the SOAP Header element
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.

falsecorrelation ID is not sent in the SOAP header element
true (default)correlation ID is sent in the SOAP header element
Advanced
followRedirectsMaximum number of redirects to follow.any integer

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)

dateFormatString

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

Example: %F
optionsSpecify 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

soapVersion

Specify the SOAP version used with this SOAP call.

1.1 (default)use SOAP version 1.1
1.2use SOAP version 1.2
Authentication
userUsername/password.
Proxy
proxyType

Type of the proxy

one of: HTTP, SOCKS5

proxyURL

URL of the proxy server.



proxyUser

Proxy user.



SSL
sslCAInfo

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



sslCertificateFile

Name of the file that contains the client certificate.



sslCertificateType

Type of the certificate.

one of: PEM (default), DER, P12

sslPrivateKeyFile

Name of the file that contains the private key.



sslPrivateKeyPassword

Password for the private key.



sslPrivateKeyType

Type of the private key.


one of: PEM (default), DER, ENG
sslVerifyHost

Whether to verify the host information form the SSL connection.

OnVerification on.
OffVerification off.
ExistenceLimit verification to the mere existence of the host.
sslVerifyPeer

Whether to verify the peer information from the SSL connection.

OnVerification on.
OffVerification off.

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.Accessing HTTP Headers of a SOAP Call

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 Protocol Support for more information on standard xUML 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

  • No labels