Propriétés du tESBConsumer Standard - 6.5

ESB

author
Talend Documentation Team
EnrichVersion
6.5
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Création et développement > Systèmes tiers > Composants ESB
Gouvernance de données > Systèmes tiers > Composants ESB
Qualité et préparation de données > Systèmes tiers > Composants ESB
EnrichPlatform
Studio Talend

Ces propriétés sont utilisées pour configurer le tESBConsumer s'exécutant dans le framework de Jobs Standard.

Le composant tESBConsumer Standard appartient à la famille ESB.

Le composant de ce framework est disponible dans tous les produits Talend.

Basic settings

Service Configuration

Description des bindings et de la configuration du Service Web. Le champ Endpoint est automatiquement rempli après complétion de la configuration du service.

Input schema et Edit schema

Un schéma est une description de lignes. Il définit le nombre de champs (colonnes) dans le Repository. Lorsque vous créez un Job Spark, évitez le mot réservé line lors du nommage des champs.

Créez le schéma en cliquant sur le bouton Edit Schema. Si le schéma est en mode Repository, trois options sont disponibles :

  • View schema : sélectionnez cette option afin de voir le schéma.

  • Change to built-in property : sélectionnez cette option pour passer le schéma en mode Built-In et effectuer des modifications locales.

  • Update repository connection : sélectionnez cette option afin de modifier le schéma stocké dans le référentiel et décider de propager ou non les modifications à tous les Jobs. Si vous souhaitez propager les modifications uniquement au Job courant, cliquez sur No et sélectionnez à nouveau la métadonnée du schéma dans la fenêtre [Repository Content].

Cliquez sur Sync columns afin de récupérer automatiquement les colonnes du composant précédent.

 

Built-in : Le schéma sera créé et conservé pour ce composant seulement. Voir également le Guide utilisateur du Studio Talend .

 

Repository : Le schéma existe déjà et est stocké dans le Repository. Ainsi, il peut être réutilisé dans divers projets et Jobs. Voir également le Guide utilisateur du Studio Talend .

Response schema et Edit schema

Un schéma est une description de lignes. Il définit le nombre de champs (colonnes) dans le Repository. Lorsque vous créez un Job Spark, évitez le mot réservé line lors du nommage des champs.

Créez le schéma en cliquant sur le bouton Edit Schema. Si le schéma est en mode Repository, trois options sont disponibles :

  • View schema : sélectionnez cette option afin de voir le schéma.

  • Change to built-in property : sélectionnez cette option pour passer le schéma en mode Built-In et effectuer des modifications locales.

  • Update repository connection : sélectionnez cette option afin de modifier le schéma stocké dans le référentiel et décider de propager ou non les modifications à tous les Jobs. Si vous souhaitez propager les modifications uniquement au Job courant, cliquez sur No et sélectionnez à nouveau la métadonnée du schéma dans la fenêtre [Repository Content].

 

Built-in : Le schéma sera créé et conservé pour ce composant seulement. Voir également le Guide utilisateur du Studio Talend .

 

Repository : Le schéma existe déjà et est stocké dans le Repository. Ainsi, il peut être réutilisé dans divers projets et Jobs. Voir également le Guide utilisateur du Studio Talend .

Fault Schema et Edit Schema

Un schéma est une description de lignes. Il définit le nombre de champs (colonnes) dans le Repository. Lorsque vous créez un Job Spark, évitez le mot réservé line lors du nommage des champs.

Créez le schéma en cliquant sur le bouton Edit Schema. Si le schéma est en mode Repository, trois options sont disponibles :

  • View schema : sélectionnez cette option afin de voir le schéma.

  • Change to built-in property : sélectionnez cette option pour passer le schéma en mode Built-In et effectuer des modifications locales.

  • Update repository connection : sélectionnez cette option afin de modifier le schéma stocké dans le référentiel et décider de propager ou non les modifications à tous les Jobs. Si vous souhaitez propager les modifications uniquement au Job courant, cliquez sur No et sélectionnez à nouveau la métadonnée du schéma dans la fenêtre [Repository Content].

 

Built-in : Le schéma sera créé et conservé pour ce composant seulement. Voir également le Guide utilisateur du Studio Talend .

 

Repository : Le schéma existe déjà et est stocké dans le Repository. Ainsi, il peut être réutilisé dans divers projets et Jobs. Voir également le Guide utilisateur du Studio Talend .

Use Service Registry

Cette option est disponible uniquement si vous avez souscrit à l'une des solutions Enterprise ESB de Talend .

Cochez cette case pour activer le Service Registry, permettant ainsi une recherche dynamique d'un endpoint. Cela permet de rediriger les services selon les informations récupérées du registre. Fonctionne uniquement dans le conteneur d'exécution.

Saisissez vos informations d'authentification dans les champs Username et Password.

Si un jeton SAML est enregistré dans le registre du service, vous devez spécifier le rôle du client dans le champ Role. Vous pouvez également cocher la case Propagate Credentials pour effectuer un appel si un utilisateur est déjà authentifié, en propageant les informations d'authentification. Vous pouvez saisir l'identifiant et le mot de passe d'authentification via STS afin de propager les informations d'authentification à l'aide de l'identifiant et du mot de passe, ou vous pouvez fournir l'alias, l'identifiant et le mot de passe à l'aide du certificat. Pour plus d'informations, consultez la description de l'option Use Authentication. Cochez la case Encryption/Signature body pour activer la signature ou le cryptage XML. Pour plus d'informations, consultez le chapitre concernant le Service XKMS dans le guide Talend ESB Infrastructure Services Configuration Guide.

Dans le champ Correlation Value, spécifiez l'ID d'une corrélation ou laissez ce champ vide. Pour plus d'informations, consultez la documentation de l'option Use Business Correlation.

Pour plus d'informations concernant la configuration et l'utilisation du Service Registry, consultez le Guide utilisateur de Talend Administration Center et le Talend ESB Infrastructure Services Configuration Guide (en anglais).

Use Service Locator

Use Service Locator : Maintient la disponibilité du service pour répondre aux demandes et aux accords de niveau de service (Service Level Agreements).

Cette option est indisponible lorsque la case Use Service Registry est cochée.

Use Service Activity Monitor 

Capture les événements et stocke les informations pour permettre des analyses en profondeur de l'activité du service et un suivi des messages à travers une transaction métier. Cette option peut être utilisée, entre autres, pour analyser le temps de réponse du service, identifier les modèles de trafic ou effectuer une analyse de cause racine.

Cette option est désactivée lorsque la case Use Service Registry est cochée, si vous avez souscrit à l'une des solutions Enterprise ESB de Talend .

Use Authentication

Cochez cette case pour activer l'option d'authentification. Choisissez entre Basic HTTP, HTTP Digest, Username Token et SAML Token (ESB runtime only). Saisissez un identifiant et un mot de passe dans les champs correspondants. Les options Basic HTTP, HTTP Digest et Username Token fonctionnent dans le studio et dans le conteneur d'exécution. L'authentification via SAML Token fonctionne uniquement dans le conteneur d'exécution.

Lorsque l'option SAML Token (ESB runtime only) est sélectionnée, vous pouvez fournir les informations d'authentification pour envoyer la requête ou effectuer l'appel si un utilisateur est authentifié, en propageant les informations d'authentification. Sélectionnez :

- : Saisissez l'identifiant et le mot de passe dans les champs correspondants afin d'accéder au service.

Propagate using U/P : Saisissez l'identifiant et le mot de passe utilisés pour vous authentifier via STS.

Propagate using Certificate : Saisissez l'alias et le mot de passe utilisés pour vous authentifier via STS.

Pour saisir le mot de passe, cliquez sur le bouton [...] à côté du champ Password, puis, dans la boîte de dialogue qui s'ouvre, saisissez le mot de passe entre guillemets doubles et cliquez sur OK afin de sauvegarder les paramètres.

Cette option est indisponible lorsque la case Use Service Registry est cochée.

Use Authorization

Cette option est disponible uniquement si vous avez souscrit à l'une des solutions Enterprise ESB de Talend .

Cochez cette case pour activer les appels autorisés. Spécifiez le rôle du client dans le champ Role. Cette option apparaît lorsque l'option SAML Token (ESB runtime only) est sélectionnée dans la liste Use Authentication.

Pour plus d'informations sur la gestion des rôles et les droits des utilisateurs, consultez le Guide utilisateur de Talend Administration Center et le Talend ESB Infrastructure Services Configuration Guide (en anglais).

Encryption/Signature body

Cochez cette case pour activer le cryptage ou la signature XML. Pour plus d'informations, consultez le chapitre concernant le Service XKMS dans le guide Talend ESB Infrastructure Services Configuration Guide.

Cette option s'affiche lorsque l'option SAML Token (ESB runtime only) est sélectionnée dans la liste Use Authentication.

Use Business Correlation

Cochez cette case pour créer un ID de corrélation dans ce composant.

Vous pouvez spécifier un ID de corrélation dans le champ Correlation Value. Dans ce cas, l'ID de corrélation est passé au service qu'il appelle, afin que les appels en chaîne de services soient groupés sous cet ID de corrélation. Si vous laissez ce champ vide, cette valeur est générée automatiquement au moment de l'exécution.

Lorsque cette option est activée, le tESBConsumer extrait également l'ID de corrélation de l'en-tête de réponse et le stocke dans le composant pour usage ultérieur dans le flux.

Cette option est automatiquement activée lorsque la case Use Service Registry est cochée.

Use GZip Compress

Cochez cette case afin de compresser les messages entrants au format GZip avant envoi.

Die on error

Cochez cette case si vous souhaitez arrêter le Job en cas d'erreur.

Advanced settings

Log messages

Cochez cette case pour enregistrer l'échange de messages entre le service et le consommateur.

Service Locator Custom Properties

Cette table apparaît lorsque la case Use Service Locator est cochée. Vous pouvez ajouter autant de lignes que nécessaire afin de personnaliser les propriétés correspondantes. Saisissez entre guillemets le nom et la valeur de chaque propriété dans le champ Property Name et Property Value respectivement.
Service Activity Custom Properties Cette table apparaît lorsque la case Use Service Activity Monitor est cochée. Vous pouvez ajouter autant de lignes que nécessaire afin de personnaliser les propriétés correspondantes. Saisissez entre guillemets le nom et la valeur de chaque propriété dans le champ Property Name et Property Value respectivement.

Connection time out (second)

Configurez une valeur en secondes avant interruption de la connexion au Service Web.

Cette option fonctionne uniquement dans le studio. Pour l'utiliser après le déploiement du composant dans le moteur d'exécution :
  1. Créez un fichier de configuration avec le nom org.apache.cxf.http.conduits-<endpoint_name>.cfg dans le dossier <TalendRuntimePath>/container/etc/.

  2. Spécifiez l'url du service Web et le paramètre client.ConnectionTimeout de délai avant suspension en millisecondes dans le fichier de configuration. Si vous devez utiliser l'option Receive time out, spécifiez le délai client.ReceiveTimeout en millisecondes également. L'url peut être un endpoint ou une expression régulière contenant des caractères de remplacement, par exemple :

    url = http://localhost:8040/*
    client.ConnectionTimeout=10000000
    client.ReceiveTimeout=20000000

    , dans laquelle http://localhost:8040/* correspond à toutes les URL commençant par http://localhost:8040/.

Receive time out (second)

Configurez une valeur en secondes pour la réception de la réponse.

Cette option fonctionne uniquement dans le studio. Pour l'utiliser après le déploiement du composant dans le moteur d'exécution, consultez l'option Connection time out.

Disable Chunking

Cochez cette case pour désactiver l'encodage du payload par morceaux. En général, l'encodage par morceaux est plus efficace car il permet une mise en flux directe. Parfois, avec l'endodage par morceau, les payloads sont tronqués. Si vous obtenez des erreurs inhabituelles lorsque vous essayez d'utiliser un service, essayez de désactiver l'encodage par morceaux pour voir s'il y a une amélioration.

Trust Server with SSL/TrustStore file et TrustStore password

Cochez cette case pour authentifier le serveur auprès du client via un protocole sécurisé SSL et renseignez les champs suivants :

TrustStore file : saisissez le chemin d'accès et le nom du fichier TrustStore contenant la liste des certificats approuvés par le client.

TrustStore password : saisissez le mot de passe utilisé pour vérifier l'intégrité des données TrustStore.

Use http Proxy/Proxy host, Proxy port, Proxy user et Proxy password

Cochez cette case si vous utilisez un serveur proxy et renseignez les informations nécessaires.

Pour saisir le mot de passe, cliquez sur le bouton [...] à côté du champ Password, puis, dans la boîte de dialogue qui s'ouvre, saisissez le mot de passe entre guillemets doubles et cliquez sur OK afin de sauvegarder les paramètres.

HTTP Headers

Cliquez sur [+] autant de fois que nécessaire pour ajouter la ou les paires nom-valeurs pour les en-têtes HTTP afin de définir les paramètres de l'opération HTTP requise.

tStatCatcher Statistics

Cochez cette case pour collecter les données de log, aussi bien au niveau du Job qu'au niveau de chaque composant.

Global Variables

Global Variables 

NB_LINE : nombre de lignes traitées. Cette variable est une variable After et retourne un entier.

CORRELATION_ID : l'ID de corrélation par lequel regrouper les appels de services en chaîne. Cette variable est une variable Flow et retourne une chaîne de caractères.

ERROR_MESSAGE : message d'erreur généré par le composant lorsqu'une erreur survient. Cette variable est une variable After et retourne une chaîne de caractères. Cette variable fonctionne uniquement si la case Die on error est décochée, lorsque le composant contient cette case.

HTTP_RESPONSE_CODE : code HTTP de statut. Cette variable est une variable After et retourne un entier.

HTTP_HEADERS : ensemble des en-têtes HTTP de la réponse. Cette variable est une variable Flow et retourne un objet Map java.util.Map<String, java.util.List<?>>. Le nom de l'en-tête est représenté par la clé Map. Les valeurs des en-têtes sont représentées par java.util.List<?>.

Une variable Flow fonctionne durant l'exécution d'un composant. Une variable After fonctionne après l'exécution d'un composant.

Pour renseigner un champ ou une expression à l'aide d'une variable, appuyez sur les touches Ctrl+Espace pour accéder à la liste des variables. À partir de cette liste, vous pouvez choisir la variable que vous souhaitez utiliser.

Pour plus d'informations concernant les variables, consultez le Guide utilisateur du Studio Talend .

Utilisation

Règle d'utilisation

Ce composant peut être utilisé comme composant intermédiaire. Il nécessite un composant d'entrée et un composant de sortie.

Dynamic settings

Cliquez sur le bouton [+] pour ajouter une ligne à la table et renseignez le champ Code avec une variable de contexte, afin d'activer ou désactiver dynamiquement l'option Use Authentication ou Use HTTP proxy lors de l'exécution. Vous pouvez ajouter deux lignes à la table afin de configurer les deux options.

Une fois qu'un paramètre dynamique est défini, l'option correspondante est mise en relief et devient inutilisable dans les vues Basic settings et Advanced settings.

Pour des exemples relatifs à l'utilisation des paramètres dynamiques, consultez Lire des données dans des bases de données à l'aide de connexions dynamiques basées sur les variables de contexte et Lire des données à partir de différentes bases de données MySQL à l'aide de paramètres de connexion chargés dynamiquement. Pour plus d'informations concernant les paramètres dynamiques et les variables de contexte, consultez le Guide utilisateur du Studio Talend.

Limitation

Une JDK est requise pour que ce composant puisse fonctionner.