SOAP Receiver
SOAP Receiver is an event source. It exposes one operation from a WSDL resource and starts a workflow when a request for that operation arrives.
Configure one receiver binding per operation. The workflow that starts should end by returning either SOAP Reply for a successful response, or SOAP Fault for a contract-compliant error.
Requests arrive over HTTP(S) at a path, or over JMS from a request queue. On JMS,
replies are sent to the inbound JMSReplyTo using the request correlation ID.
The activity has three tabs: Configuration, WS-Security, and Output.
Configuration
| Field | Required | Description |
|---|---|---|
| Name | Optional | Name of the component. |
| Description | Optional | Description of the component. |
| WSDL | Optional | The WSDL resource this service implements. |
| Service | Optional | WSDL service name. |
| Port | Optional | WSDL port or binding. |
| Operation | Optional | The operation this workflow handles. Configure one receiver binding per operation. |
| Transport | Optional | HTTP(S) or JMS. Defaults to HTTP(S). |
| Path | Optional | Service path, prefixed at deployment by /{org}/{workspace}/{app}. Requests are routed by path and operation. |
| JMS Connection | Optional | JMS connection used by the SOAP-over-JMS receiver. |
| JMS Destination | Optional | Request queue. Replies are sent to JMSReplyTo using the request correlation ID. |
| JMS Receive Timeout (ms) | Optional | Defaults to 30000. |
Path applies to HTTP(S). The three JMS fields apply when Transport is JMS.
WS-Security
| Field | Required | Description |
|---|---|---|
| Require UsernameToken | Optional | Require and verify a WS-Security UsernameToken on every inbound request. Defaults to cleared. |
| Expected Username | Optional | Expected UsernameToken username, resolved from a variable or vault-backed value. |
| Expected Password | Optional | Expected UsernameToken password, resolved from a variable or vault-backed value. |
| Allowed Clock Skew (seconds) | Optional | The token creation time must be within this window. Defaults to 300. |
Replayed nonce and timestamp combinations are rejected.
Output
| Field | Data Type | Description |
|---|---|---|
| body | Object | The WSDL operation request body. |
| operation | String | Resolved WSDL operation name. |
| transport | String | Inbound SOAP transport used for this request: HTTP or JMS. |
| soapAction | String | SOAPAction, or the SOAP 1.2 action parameter, when present. |
| soapHeaders | Object | Inbound SOAP envelope headers decoded by local name. |
| soapVersion | String | SOAP envelope version detected for the inbound request: 1.1 or 1.2. |
| replyTo | String | JMS only: inbound JMSReplyTo destination. |
| messageId | String | JMS only: inbound JMSMessageID. |
| correlationId | String | JMS only: inbound JMSCorrelationID. |
replyTo, messageId, and correlationId are shown only when Transport is JMS.