Configuring the Talend ESB Web Service Client connector - 7.1

Talend Connectors for BPM Reference Guide

author
Talend Documentation Team
EnrichVersion
7.1
EnrichProdName
Talend Data Fabric
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
task
Design and Development
EnrichPlatform
Talend Studio

Before you begin

You have created a BPM process or task in your Talend Studio and added the Talend ESB Web Service Client connector to it.

Procedure

  1. Select the Talend ESB Web Service Client connector in the process or task, click Edit in the Connectors tab of the General view to open a configuration wizard
  2. Provide basic information for the connector.
    Field Description

    Name*

    Specify the name of the connector.

    Description

    Provide descriptive information for the connector.

    Select event*

    Specify the event that triggers the connector:

    • enter: event occurs when the flow enters this process step;
    • start: event occurs when the flow starts;
    • suspend/resume: event occurs when the user presses the suspend/resume button on the web-form;
    • finish: event occurs when the flow exits this process step

    If connector fails...

    Specify what to do if the connector fails consuming the Web service:

    • Puts in failed state: puts the step in failed state and terminates the process;
    • Ignore error and continue process: continues the process ignoring the error;
    • Throw error event: throws a user-specified error.

    Named Error

    Specify the name of the error that should be thrown if the connector fails. Available only if the Throw error event option is selected.

    Note: Fields followed by an asterisk (*) are required.
  3. Click Next to go to the next step of the wizard, and select an option:
    • Use WSDL file:

      This option allows you to select the WSDL file which describes the Talend ESB Web service. It is possible to browse to a file location of the WSDL file or to specify a ?WSDL URL where the WSDL can be directly retrieved from the Service Provider.

    • Use Service Locator:

      This option allows you to select the particular ESB Web service from the Talend ESB Service Locator, which provides a list of all services available within the Talend ESB.

  4. Click Next to go to the next step and define the Port, Operation and the related request mapping.
    Field Description

    WSDL URL

    URL where the WSDL is served (as specified in previous step).

    Service

    Service name which should be consumed (the selection box shows only the values defined in the selected WSDL).

    Port

    Service port (the selection box shows only the values defined in the selected WSDL).

    Operation

    Name of the operation which will be called. The control allows selecting only available operations (as defined in the selected WSDL).

    Parameters

    Table which contains the parameters for the operation:

    • Parameter: parameter name which shows the request xml in a structured way.
    • Value: parameter value which provides different options to use static values, expressions or process variables for the request pmeters.
      Note: For a parameter dealing with data of type Date that needs to be converted to a string, you may use javax.xml.bind.DatatypeConverter for the conversion to avoid possible errors related to your locale setting.
  5. Click Next to go to the next step and configure Talend ESB Infrastructure services for this consumer request if needed.
    Field / option Description

    Service Registry

     

    Use Service Registry

    Select this check box to enable the Service Registry feature, which provides dynamic endpoint lookup and allows services to be redirected based upon information retrieved from the registry.

    This feature works in Talend ESB Runtime only.

    With the Service Registry feature enabled, all the settings for the Service Activity Monitoring, Security, and Business Correlation features will be ignored.

    Authentication Username and Password

    Enter the user name and password for authentication.

    This credential information will not be used if Propagate using Certificate is selected from the Propagate Type list.

    Authentication Role Name

    If SAML token is registered in the Service Registry, specify the client's role if required.

    Security Token

    Specify a security token string or select a variable that contains the desired token string to pass to the service the connector calls.

    Propagate Type

    Select between:

    • Propagate using U/P (default): Security Token Service authentication using authentication username and password.

      This option works only when a Security Token is specified.

    • Propagate using Certificate: Security Token Service authentication using an alias and certificate password pair.

    Alias and Certificate Password

    Enter the certificate alias and password for Security Token Service authentication.

    This credential information is used only if Propagate using Certificate is selected from the Propagate Type list.

    Correlation ID

    Specify your correlation ID or select a process variable for your correlation ID to pass to the service the connector calls, in case Business Correlation is enabled based on the policies applied for the service.

    If you leave this field empty, and if Business Correlation is enabled, a random UUID will be generated automatically at runtime.

    Service Locator

     

    Use Service Locator

    Select this check box to enable the Service Locator feature.

    With this feature enabled, the provider endpoint (URL) will be requested at runtime from the Talend ESB Service Locator. This way, the process is loosely coupled to the provider so the provider can be used based on availability, regardless of where they are hosted.

    Service Locator Properties

    (Optional) Additional metadata can be set as a filter for the list of service providers. For example, if the provider uses a location metadata to specify the data center location they are running with (values EU and US for example), a row in this table with 'locator' values EU would only retrieve an endpoint where the provider is located in a EU data center.

    Service Activity Monitoring

     

    Use Service Activity Monitoring

    Select this check box to enable monitoring the service calls with Service Activity Monitoring. This way, a request from the process to an ESB Provider is also tracked as a Service Activity event.

    If the Service Registry feature is enabled, this check box does not work.

    Service Activity Monitoring Custom Info

    This option allows you to secure the Web service call by standard-based security mechanism as provided by Talend ESB.

    If the Service Registry feature is enabled, this check box does not work.

    Security Type

    Select between:

    • Basic: Basic HTTP authentication
    • SAML Token: SAML Token authentication (using the Talend ESB Security Token Service)
    • Username Token: Username-Token authentication

    Username and Password

    Enter the user name and password for authentication.

    This credential information will not be used if Propagate using Certificate is selected from the Propagate Type list.

    Use Authorization

    Select this check box to enable authorized call.

    This option works when SAML Token is selected from the Security Type list.

    For more information about the management of user roles and rights, see the Talend Administration Center User Guide and Talend ESB Infrastructure Services Configuration Guide.

    Role Name

    With the Use Authorization check box selected, specify the client's role if required.

    Security Token

    Specify a security token string or select a variable that contains the desired token string to pass to the service the connector calls.

    Propagate Type

    Select between:

    • Propagate using U/P (default): Security Token Service authentication using authentication username and password. This option works only when a Security Token is specified.
    • Propagate using Certificate: Security Token Service authentication using alias and certificate password.

    Alias and Certificate Password

    Enter the certificate alias and password for Security Token Service authentication.

    Business Correlation

     

    Use Business Correlation

    Select this check box to enable the Business Correlation feature. This will pass the specified correlation ID via the request message header to the service the connector calls, so that chained service calls will be grouped under this correlation ID.

    With this feature enabled, the connector will also extract the correlation ID from the response message header and store it in the process variable specified in the next step for further use in the process.

    If the Service Service Registry is enabled, this check box does not work.

    Correlation ID

    Specify your correlation ID or select a process variable for your correlation ID to pass to the service the connector calls.

    If you leave this field empty, a random UUID will be generated automatically at runtime.

  6. Click Next to go to the next step set the parameters as follows to map the Web service response to variables/data types of the process, and then click Finish.
    Field Description

    Connector output

    Select the connector output or its part for storing it in the specified variable. The list also allows you to open a dialog box which provides a structured view of the response parameter.

    Destination variable

    Select or create a variable where the connector output should be stored.