Skip to main content

SOAP Request

SOAP Request invokes an operation on a service defined by a WSDL resource. The request body is mapped from the workflow, and the response — or the fault the service returns instead — comes back on the Output tab.

The call travels over one of two transports. HTTP(S) posts to the endpoint in the WSDL, or to an override you supply. JMS sends the request to a queue and correlates the reply through a temporary queue.

Security is configured across three tabs. TLS secures the transport, WS-Security authenticates the caller with a UsernameToken, and Signing applies an XML Signature to the message.

The activity has eight tabs: Configuration, Endpoint, TLS, WS-Security, Signing, Advanced, Input, and Output.

Configuration

FieldRequiredDescription
NameOptionalName of the component.
DescriptionOptionalDescription of the component.
WSDLOptionalThe WSDL resource that defines the service.
ServiceOptionalWSDL service name. Optional if unambiguous.
PortOptionalWSDL port or binding. Optional if unambiguous.
OperationOptionalThe operation to invoke.
SOAP VersionOptionalAuto (from WSDL), SOAP 1.1, or SOAP 1.2. Defaults to Auto (from WSDL).
TransportOptionalHTTP(S) or JMS. Defaults to HTTP(S).

Service and Port may be left blank when the WSDL declares only one of each. SOAP Version is taken from the WSDL binding unless overridden.

Endpoint

FieldRequiredDescription
Endpoint URL (override)OptionalOverrides the WSDL soap:address. Mapping and vault values are supported.
Basic Auth UsernameOptionalUsername for HTTP Basic authentication.
Basic Auth PasswordOptionalPassword for HTTP Basic authentication.
Connect Timeout (ms)OptionalDefaults to 15000.
Read / Reply Timeout (ms)OptionalHTTP read timeout, or JMS request-reply wait timeout. Defaults to 30000.
JMS ConnectionOptionalThe JMS connection resource, for SOAP-over-JMS.
JMS DestinationOptionalRequest queue. The reply arrives via a temporary queue and correlation.

JMS Connection and JMS Destination apply when Transport is JMS. The remaining fields apply to HTTP(S), except Read / Reply Timeout (ms), which bounds the wait on both transports.

TLS

FieldRequiredDescription
Configure TLS / mTLSOptionalEnables the settings below. Defaults to cleared.
Server Certificate TrustOptionalSystem Trust (public CAs), Certificate Resource, or Trust All (dev/test only). Defaults to System Trust (public CAs).
Verify Server HostnameOptionalVerify that the SOAP endpoint hostname matches the server certificate. Defaults to selected.
Server Trust CertificateOptionalCertificate resource containing the CA or certificate used to validate the SOAP server.
Client Identity Certificate (mTLS)OptionalCertificate resource containing the client certificate and private key presented to the SOAP server.

HTTPS uses system trust automatically. Enable Configure TLS / mTLS only to configure certificate trust, mTLS, or hostname verification.

warning

Trust All (dev/test only) skips server certificate validation. Keep Verify Server Hostname enabled outside controlled testing.

WS-Security

FieldRequiredDescription
AuthenticationOptionalNone or UsernameToken. Defaults to None.
UsernameOptionalUsername sent in the WS-Security UsernameToken.
PasswordOptionalPassword resolved from a variable or vault-backed value.
Password TypeOptionalPassword Text or Password Digest. Defaults to Password Text.
Add TimestampOptionalAdd a WS-Security timestamp to limit the validity period of the request. Defaults to cleared.
Timestamp Validity (seconds)OptionalHow long the generated WS-Security timestamp remains valid. Defaults to 300.
Timestamp IDOptionalTimestamp identifier. Leave empty unless required for interoperability or signing.
Must UnderstandOptionalRequire the receiving SOAP service to process the WS-Security header or return a fault. Defaults to cleared.

Password Digest avoids transmitting the plaintext password, and includes a nonce and creation time.

Signing

FieldRequiredDescription
Sign SOAP MessageOptionalApply a WS-Security XML Signature to the outbound SOAP message. Defaults to cleared.
Signing CertificateOptionalCertificate resource containing the signing certificate and private key.
Sign SOAP BodyOptionalInclude the SOAP Body in the XML Signature. Defaults to selected.
Add Signature TimestampOptionalAdd a timestamp to the signed WS-Security header. Defaults to selected.
Sign TimestampOptionalInclude the generated timestamp in the XML Signature. Defaults to selected.
Timestamp Validity (seconds)OptionalHow long the signature timestamp remains valid. Defaults to 300.

Advanced

FieldRequiredDescription
Custom SOAP HeadersOptionalAdditional namespaced headers, for example WS-Addressing.

Input

FieldRequiredDescription
InputsOptionalThe request body, from the WSDL operation.

The shape of the request body is not fixed by the activity. It is derived from the WSDL operation selected in Configuration.

Output

The activity returns a soapResponse object holding response metadata and the decoded body.

FieldData TypeDescription
bodyObjectThe WSDL operation response body.
faultObjectThe SOAP fault returned by the service, when there is one.
statusCodeIntegerTransport status code for the call.
endpointStringThe endpoint the request was sent to.
transportStringhttp or jms.
transportMetadataObjectTransport-specific metadata for the call.

fault

FieldData TypeDescription
codeStringFault code.
subCodeStringSOAP 1.2 fault subcode.
reasonStringFault reason.
actorStringSOAP 1.1 faultactor or SOAP 1.2 Role.
nodeStringThe node that generated the fault.
detailStringFault detail.