web

Web Request

Icon
Use When	A web service (either REST or WSDL) needs to be called to perform an action such as retrieving or writing data
Samples	WSDL Service Call, DB Request to WSDL to DB results
Description	The web component allows REST or WSDL based web services to be called, sending the response data to downstream components. The Web component can be used to call either WSDL or REST based services. The Web component takes a text based message as input. This text based input message is formatted XML that represents the web service request. Thus, the web component is frequently used with the XML Formatter component which takes entity data and formats it into an xml formatted text message.
Inbound Message Type	Text Based Message
Output Message Type	Text Based Message
Control Message Handling	Input: When a control message is received and 'Run When' is 'PER UNIT OF WORK' start the processing of this component or when any message other than a control is received and 'Run When' is not 'PER UNIT OF WORK'. Output: A single control message will be forwarded to downstream components once all files have been processed through this step.

Properties

Name	Description
Resource	An Http resource where the service resides and can be called
Error Suspense Step	Whether to forward failed messages and continue processing. This is the name of a linked component to forward the failed messages to.
Enabled
Run When	When providing the web service request message set this to PER UNIT OF WORK. When the request message is received from a prior component set this to PER MESSAGE
HTTP Method	Method to use with this Web call such as GET, PUT, PATCH, POST, DELETE
Append to URL	Text that will be appended to to the Connection url forming the base url for the web service call
Body From	Either 'Message' or 'Provided'. If Message the body of the web service request message will come from the inbound message. If 'Provided" the body of the web service request message will come from the Body Text parameter
Body Text	If the Body From parameter is 'Provided', this parameter is used to specify the body of the text message for the web service request
Http Headers	A list of line feed separated Http Headers that will be passed in the web request. The name value pairs should be separated by a colon (:).
Http Parameters	A list of line feed separated Http Parameters that will be passed on the URL of the web request. The name value pairs should be separated by a colon (:).
Parameter replacement	Enables token replacement for the Command. Message headers and flow parameters can be token replaced. The following token formats can be used: $(HeaderKey) or $(FlowParameter). Note that you can link:Stamp entity and text message values in a message header if you want to use message values.
Encoding
Log Input
Log Output
Inbound Queue Capacity