Reference: HTTP-Out Transport Properties
Common Tab
Property | XML Attribute Name | Description |
|---|---|---|
Id
| id
| The unique ID of the http-out transport within the assembly. |
Routes Response To
| routes-response-to
| The destination of the response message for the http-out transport.
The http-out transport populates the MediationContext property http.response.status with the standard HTTP response codes returned by the remote server. Examples: 202 (Accepted), 403 (Forbidden). The assembly can use the value in this property to determine handling for different responses. |
Execute When
| execute-when
| A condition that determines whether the http-out transport executes. |
Endpoint
| endpoint
| The target HTTP URL address towards which the http-out transport directs the request message.
Example: http://myhost.example.org/MyService |
Http Method
| http-method
| The HTTP request method supported by the http-out transport. Example: DELETE , GET , POST , PUT , and PATCH .
To use the PATCH method, you must set the wd.http.client property to apache . If you don't want downstream transports to also use the Apache HTTP client, reset the wd.http.client property to null .If you don't specify a method for this property, Studio uses the POST method. |
Advanced Tab
Property | XML Attribute Name | Description |
|---|---|---|
Store Message
| store-message
| Specify none unless otherwise advised by Workday Support.
To store messages, use Studio's store step. |
Transport Class
| transport-class
| Specifies an alternative implementation class on a per-assembly basis, if required.
You can globally change the implementation classes by editing the WEB-INF/classes/spring/assembly-bean.xml file. |
Ignore Dynamic Endpoints
| ignore-dynamic-endpoints
| Specifies whether to ignore the dynamic WS-Addressing (WSA) value in the incoming message's header or use it to override the value in the transport's Endpoint property.
Use the set-dynamic-endpoint step to specify WS-Addressing details. |
Connect Timeout
| connect-timeout
| Specifies, in milliseconds, a timeout period for establishing a connection with an HTTP server. If you don't specify a value, the session times out after 300000 ms (5 minutes). |
Response Timeout
| response-timeout
| Specifies, in milliseconds, a timeout period for awaiting a response from an HTTP server. If you don't specify a value, the session time depends on your assembly version:
If the HTTP connection remains unresponsive for longer than this period, the http-out transport fails. |
Error As Response
| error-as-response
| Enables you to copy an error response message from a server to the message on the http-out transport. |
Close Connection
| close-connection
| Adds a Connection: close header to an outgoing http-out transport message. |
Streaming
| streaming
| Enables HTTP streaming using PUT and POST HTTP methods. |
Auto Inproc
| auto-inproc
| Specifies whether to use in-process transport communication for http-out request messages. Enables you to send messages directly to assembly endpoints located within the same server without using the network I/O capabilities of the local host. |
Retries
| retries
| Specifies the number of retry attempts that the http-out transport makes if a transport exception occurs. |
Retry Delay
| retry-delay
| Specifies in milliseconds a delay period between each retry attempt.
Workday complies with the Retry-After or RateLimit-Reset header value in an external endpoint’s 429 Too Many Requests response provided it’s shorter than the default maximum of 5 minutes or the retry-delay value you specify here.
If the response header value is missing, Workday uses the retry-delay value.If both the retry-delay and header values are missing, Workday uses the 5 minute default.An integration will be unable to determine a retry delay and will fail if the header value is larger than both the retry-delay value and the default maximum. |
Log Retries
| log-retries
| Enables you to log HTTP retry attempts to the server log file. |
Accept Gzip
| accept-gzip
| Specifies whether to include an HTTP accept-encoding=gzip field in the http-out request header, which indicates whether to accept gzip content in the response. |
Gzip Content
| gzip-content
| Specifies whether to include an HTTP content-encoding=gzip field in the http-out request header, which indicates whether to gzip the message content in the outgoing request. |
Accept
| accept
| Specifies the accept header value to send with an HTTP request, which defines 1 or more content types that are acceptable in the response from an HTTP server. |
For Amazon S3 transports, add a tag to your IAM user with a key of
workday-type
and a value of
integration
. This tag is case sensitive and doesn’t ignore whitespace.