Web Service Call builder inputs for an HTTP service

Portlet Factory, Version 6.1.2

Web Service Call builder inputs for an HTTP service

This topic describes the inputs for the Web Service Call builder for an HTTP service.

Table 1. Web Service Call builder inputs for an HTTP service
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Service Call Type Enable HTTP to configure a service call to an HTTP service.
Service Information

URL Enter the URL for the service.
HTTP Request Type GET or POST. By default, HTTP service calls have a request type of GET unless you specifically enter POST.
Arguments In the Arguments list, enter each argument name and use the reference chooser to set the value of the argument, or enter a text string directly.
HTTP Reply Schema Type If the reply is expected to be XML, use this input to schema-type the reply variable according to some schema defined in the model. This allows the reply variable to be integrated with the data page builder.
Advanced

(optional) Timeout (in seconds) Default value is 15 seconds. You can set this value higher to allow more time for a response from the service call.
Follow Redirect Enabled by default. If you do not want the service request to follow any redirections, disable this checkbox.
(optional) Force Content type to If the response from the HTTP service is something other than HTML, set the content type to the appropriate value, such as text/xml.
(optional) Parse all Reply Tags Enabled by default. If the structure returned is very complex, you disable this checkbox to keep IBM® WebSphere Portlet Factory from examining all the tags in the structure returned by the service call.
Wrap reply in <html/Document> tag Enable this check box (default) to wrap returned HTTP response data in a <htmlDocument> tag. This will yield <htmlDocument><HTML>...</HTML>... and any other content prior to the </htmlDocument> end tag.
Disable this check box to return the first child element of the response IXml. This is useful in situations where you are expecting "text/xml" to be returned and can thus get back only the XML content not wrapped.
(optional) HTTP Headers In the HTTP header list, enter any HTTP header names and set the header values using the Choose Reference dialog, or enter a text string directly.
(optional) HTTP Cookies Enter the name for the cookie to include with the request and select the variable or method that contains or returns the cookie object.
Note: The list widget can accept a string of the form "name=value" or an IXml object with a <Value> child in it.
(optional) Logging Select the type of logging, if any, that you want the builder to perform. Information is written to the application server console as well as WebSphere Portlet Factory log file and can help in debugging problems with the service.
You can choose:

None

To disable logging.

Inputs and outputs only

To dump the inputs and the response.

Envelopes only

To dump the SOAP request and response envelopes for a WSDL/SOAP service call.

All

To dump all the above information.

(optional) Dummy/Stub Result Supply a value to be returned instead of actually calling the service.
For example, you might enable this functionality for testing purposes during application development so that you can run the model without requiring the other target model to be in place.
(optional) Basic Auth User Name If the service requires basic user authentication, enter the user name to use for the request here.
(optional) Basic Auth Password If the service requires basic user authentication, enter the password for the specified user here.

Parent topic: Web Service Call builder

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Service Call Type	Enable HTTP to configure a service call to an HTTP service.
Service Information
URL	Enter the URL for the service.
HTTP Request Type	GET or POST. By default, HTTP service calls have a request type of GET unless you specifically enter POST.
Arguments	In the Arguments list, enter each argument name and use the reference chooser to set the value of the argument, or enter a text string directly.
HTTP Reply Schema Type	If the reply is expected to be XML, use this input to schema-type the reply variable according to some schema defined in the model. This allows the reply variable to be integrated with the data page builder.
Advanced
(optional) Timeout (in seconds)	Default value is 15 seconds. You can set this value higher to allow more time for a response from the service call.
Follow Redirect	Enabled by default. If you do not want the service request to follow any redirections, disable this checkbox.
(optional) Force Content type to	If the response from the HTTP service is something other than HTML, set the content type to the appropriate value, such as text/xml.
(optional) Parse all Reply Tags	Enabled by default. If the structure returned is very complex, you disable this checkbox to keep IBM® WebSphere Portlet Factory from examining all the tags in the structure returned by the service call.
Wrap reply in <html/Document> tag	Enable this check box (default) to wrap returned HTTP response data in a <htmlDocument> tag. This will yield <htmlDocument><HTML>...</HTML>... and any other content prior to the </htmlDocument> end tag. Disable this check box to return the first child element of the response IXml. This is useful in situations where you are expecting "text/xml" to be returned and can thus get back only the XML content not wrapped.
(optional) HTTP Headers	In the HTTP header list, enter any HTTP header names and set the header values using the Choose Reference dialog, or enter a text string directly.
(optional) HTTP Cookies	Enter the name for the cookie to include with the request and select the variable or method that contains or returns the cookie object. Note: The list widget can accept a string of the form "name=value" or an IXml object with a <Value> child in it.
(optional) Logging	Select the type of logging, if any, that you want the builder to perform. Information is written to the application server console as well as WebSphere Portlet Factory log file and can help in debugging problems with the service. You can choose: None To disable logging. Inputs and outputs only To dump the inputs and the response. Envelopes only To dump the SOAP request and response envelopes for a WSDL/SOAP service call. All To dump all the above information.
(optional) Dummy/Stub Result	Supply a value to be returned instead of actually calling the service. For example, you might enable this functionality for testing purposes during application development so that you can run the model without requiring the other target model to be in place.
(optional) Basic Auth User Name	If the service requires basic user authentication, enter the user name to use for the request here.
(optional) Basic Auth Password	If the service requires basic user authentication, enter the password for the specified user here.