Web Service Request Agent(3.1)

Owned by Jenni Wallin
May 10, 2023
3 min read


The Web Service Request agent works in the same way as a Service Requester, or a client, that sends a Web Service request to a server, where a certain service is available. The response, if any, can then be routed into the workflow.

In a synchronous operation, when the processing agent receives a reply, it delivers the reply to its configured output.

In an asynchronous operation, the requester does not receive any reply and does not deliver one either.

The Web Service Requester

The Web Service Requester - asynchronous operation

To configure the Web Service Request agent:

  • Open the Web Service Request agent configuration dialog from a workflow configuration: Right-click the agent icon and select Configuration..., or double-click the agent icon.
SettingDescription

Web Service Profile

Click the Browse button and select a predefined Web Service profile.

Response Timeout (ms)

The timeout value specifies the maximum allowed response time in milliseconds (ms) back to the Request agent after a request is sent to the service. If the response time is exceeded, the Request agent times out and an error message is logged in the System Log. The WSCycleUDR is routed out from the agent with the errorMessage field set.

Support CDATA encapsulated content

Select to always send content encapsulated with CDATA tag without escape characters in the SOAP message.

Note!

The content must be completely encapsulated by CDATA tag for correct output. No leading or trailing characters are allowed, for example:

data = "<![CDATA[This will be output as CDATA]]>"

HTTP Tab

SettingDescription

Extract Profile Settings

Click the Extract Profile Settings button to automatically fill in the settings from the Service Port Definition in the profile.

HTTP Address

Enter the complete URL address for the web service used to connect to the information provider.

Enable Basic Access Authentication

Select this check box to enable Basic Access Authentication.

Username

Enter the username to use when making a request with Basic Access Authentication.

Password

Enter the password to use when making a request with Basic Access Authentication.

Note!

To be recognized as carrying SOAP error information, a SOAP message MUST contain a single SOAP Fault element information item as the only child element information item of the SOAP Body. When generating a fault, SOAP senders MUST NOT include additional element information items in the SOAP Body. A message whose Body contains a Fault plus additional element information items has no SOAP-defined semantics.

Input/Output Data

Input Data

WSCycle_[operation name] UDR

Output Data

WSCycle_[operation name] UDR

Meta Information Model

For information about the  MIM and a list of the general MIM parameters, see Meta Information Model.

The agent does not publish nor access any MIM parameters.

Agent Message Events

MessageDescription
about to send

Reported right before a request is sent to a Web Service provider.

done

Reported after a response is received from a Web Service provider. Also reported when a timeout occurs.