HTTP Client Shared Resource

You can use the HTTP Client shared resource to create an HTTP connection to invoke the Workday web services.

General

In the General panel, you can specify the general information of the HTTP Client shared resource.

The following table lists the configurations in the General panel of the HTTP Client shared resource:

Field Module Property? Description
Package No The name of the package where the new shared resource is added.
Name No The name to be displayed as the label for the shared resource in the process.
Description No A short description for this shared resource.

HTTP Client

In the HTTP Client panel, you can specify the connection pooling, detailed connection configurations, default host and port, and so on.

The following table lists the configurations in the HTTP Client panel of the HTTP Client shared resource:

Field Module Property? Description
Implementation Library No The implementation library to be used:
  • Apache Commons(Supported by HTTP and SOAP): must be used for SOAP binding.
  • Apache HttpComponents(Supported by HTTP and REST): must be used for REST binding.

The default value is Apache Commons(Supported by HTTP and SOAP).

Note: Use Apache Commons(Supported by HTTP and SOAP) for Workday.
Disable Connection Pooling Yes The single or multi-threaded connection manager to be used.

This check box is not selected by default.

Maximum Total Connections Yes The maximum number of simultaneous active connection that this resource instance uses. Increase the value for the application that creates many long-lived connections.

The default value is 200.

Idle Connection Timeout (ms) Yes Keep-alive time in milliseconds for idle HTTP connection in the persistent connection pool.
Maximum Total Connections Per Host/Route Yes The maximum number of simultaneous active connections to the same host or on the same route that this resource instance uses.

The default value is 20.

Note: This number cannot be greater than the value in the Maximum Total Connections field.
Stale Check Yes The stale connection check.

Selecting this check box determines whether the stale connection check is to be used or not. Not using the stale connection check can result in slight performance improvement at the risk of getting an I/O error, when executing a request over a connection that has been closed at the server side.

Default Host Yes The name of the host that accepts the incoming requests.

For machines that have only one network card, the default local host specifies the current machine. For machines with more than one network card, this field specifies the host name of the card used to accept the incoming HTTP requests.

Default Port Yes The port number on which to invoke outgoing HTTP requests.
Thread Pool No A queue of threads available to run a queue of tasks.

Thread pools are used to improve performance when executing large numbers of asynchronous tasks by reducing each task invocation overhead, provide a means of bounding, and managing the resources consumed when executing a collection of tasks.

Advanced

In the Advanced panel, you can specify timeout, retry, HTTP proxy, and so on.

The following table lists the configurations in the Advanced panel of the HTTP Client shared resource:

Field Module Property? Description
Socket Timeout (ms) Yes The amount of time in milliseconds to wait for data transfer before disconnecting the socket.
Connection Timeout (ms) Yes The amount of time in milliseconds to wait for the HTTP server to respond.
Accept Redirect Yes HTTP redirects followed by the HTTP method.

Select this check box when client connection receives the redirect responses from server like moved permanently, moved temporarily, temporary redirect, and so on.

This check box is not selected by default.

Retry Count Yes The maximum number of retry attempts for connecting to the server if an exception occurs.
Use Single Cookie Header Yes A single non-repeating Cookie header element to be used.

Select this check box if multiple name/value pairs must be sent in a single non-repeating Cookie header element for outgoing HTTP requests.

This check box is not selected by default.

Use Non-Preemptive Authentication Yes Non-preemptive authentication to be used.

Select this check box if you want to use non-preemptive authentication.

This check box is not selected by default.

HTTP Proxy No The HTTP proxy server to be used to gain access outside of a firewall.

Security

In the Security panel, you can specify timeout, retry, HTTP proxy, and so on.

The following table lists the configurations in the Security panel of the HTTP Client shared resource:

Field Module Property? Description
Authentication No The authentication of messages to be used.

Authentication can be performed with user names and passwords.

Identity Provider: provides user name and password credentials encapsulated in an Identity Provider shared resource. Select this check box activates the Identity Provider shared resource.

This check box is not selected by default.

Note: This function is only supported in TIBCO ActiveMatrix BusinessWorks.
Confidentiality No Encryption or decryption of messages to be used.

Select this check box when encrypting or decrypting messages. When you select this check box, the SSL Client Configuration field is displayed.

This check box is selected by default.

SSL Client Configuration No SSL parameters for the HTTP Client shared resource.

This field is only displayed when you select the Confidentiality check box.

For details, see SSL Client Shared Resource.