Web service consumer activities
A Web service consumer activity represents an operation of an imported web service. The activity name consists of the operation name followed by "_Consumer".
For each operation of a Web service, there can be one or several consumer activities available. This depends on whether the Web service method can be called by SOAP protocol and/or it supports to be called as a web-style service supporting access via HTTP Get and HTTP Post. The consumer activities available are in different categories (SOAP or HTTP). If there are no categories present, SOAP is used.
If there are complex types in the argument list of a web service operation or if the return type is of a complex type, for example an Order, it is not possible to create an instance of this type directly in the Adapterflow. Instead, you are given an option to serialize the complex type to and from XML according to an XML schema. For the serialization, there are two available activities in the Adapterflow configuration: Serialize Web service object and Deserialize Web service object.
There is always more than one schema generated for a Web service type. This is because the Web service type uses types not defined by the web service itself, for example .Net types such as System.Guid.
The schema can also be imported into the iCPS Developer tool, allowing a Developer to manipulate the complex data type in XML in a iCPS script. For more information, see iCore Developer's Manual 1.2.3 XML Schema Definitions.
SOAP based consumer activities
In parameters
Standard
| Name | Type | Description |
|---|---|---|
| Binding type | BindingBaseSurrogate | The type of binding to use. In addition to the options "Basic Http binding" and "WS Http Binding", a "CustomBinding" (defined from a list of binding elements) can be configured as binding type in a code expression. See also Binding types. Bindable |
| Reuse session | Object | This parameter is used to re-use the already available session of a previous Web service consumer activity. The re-use of a session can be done by binding this parameter to the output session of a previous Web service consumer activity. Note that both Web services must have the same *Endpoint address and same type of binding. Bindable |
| Client credentials | ClientCredentialsSurrogat | Information about client credentials, such as certificate data, client name and password. The credential to be used depends on security settings of the binding. See also Client credentials. Bindable |
| Endpoint address | UriValue | The address to send the request to. Bindable |
| Endpoint identity | EndpointIdentitySurrogate | Provides an identity that enables the authentication of an endpoint by clients who exchange messages with it. See also Endpoint identity. Bindable |
In parameters
The input parameters of the web service operation appear as in-properties of the activity.
note
The in-properties of string type are assigned empty strings by default.
Out parameters
| Name | Description |
|---|---|
| Return value Out | The value returned by the web service method (Appears only in cases where the web service operation returns a value). |
| Used session Out | The session used for the web service call made by the activity. This session can be used by another activity. |
HTTP based consumer activities
In parameters
Standard
| Name | Type | Description |
|---|---|---|
| Client type | ClientTypeOption | Specifies whether the call will be made using HTTP POST or HTTP GET. |
| Reuse session | Object | This parameter is used to re-use the already available session of a previous Web service consumer activity. The re-use of a session can be done by binding this parameter to the output session of a previous Web service consumer activity. Note that both Web services must have the same Endpoint address and same type of binding. Bindable |
| Client credentials | ClientCredentialsSurrogate | Information about client credentials, such as certificate data, client name and password. The credential to be used depends on security settings of the binding. See also Client credentials. Bindable |
| Endpoint address | UriValue | The address to send the request to. Bindable |
In parameters
The input parameters of the web service operation appear as in-properties of the activity.
note
The in-properties of string type are assigned empty strings by default.
Out parameters
| Name | Description |
|---|---|
| Return value Out | The value returned by the web service method (Appears only in cases where the web service operation returns a value). |
| Used session Out | The session used for the web service call made by the activity. This session can be used by another activity. |
See Also
Client credentials
Endpoint identity
Deserialize Web service object
Serialize Web service object