Définir les variables de contexte pour un Job - 6.3

Talend Open Studio for Data Integration Guide utilisateur

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Data Integration
task
Création et développement
EnrichPlatform
Studio Talend

Vous pouvez définir les variables de contexte pour un Job par deux moyens :

Définir les variables de contexte dans la vue Contexts

La vue Contexts se situe parmi les onglets de configuration sous l'espace de modélisation.

Note

Si la vue Contexts n'apparaît pas dans le fenêtre du Studio Talend, cliquez sur le menu Window > Show view > Talend, puis sélectionnez Contexts.

La vue Contexts montre toutes les variables qui ont été définies pour chaque composant dans le Job courant, ainsi que les variables de contexte importées dans le Job courant.

A partir de cette vue, vous pouvez gérer vos variables built-in (local) :

  • Créer et gérer les contextes built-in.

  • Créer, éditer et supprimer les variables built-in.

  • Réorganiser les variables de contexte.

  • Ajouter les variables de contexte built-in dans le Repository.

  • Importer les variables à partir d'une source contexte du Repository.

  • Éditer les variables de contexte stockées dans le Repository et mettre à jour les changements dans le Repository.

  • Supprimer les variables stockées dans le Repository importées du Job courant.

  • Réorganiser les variables de contexte.

L'exemple suivant montre comment définir deux contextes appelés Prod et Test ainsi qu'une série de variables (host, port, database, username, password et table_name) sous ces deux contextes pour un Job.

Définir les contextes
  1. Ouvrez le Job dans l'espace de modélisation graphique.

  2. Sélectionnez la vue Contexts et cliquez sur le bouton [+] dans le coin supérieur droit de la vue.

    La boîte de dialogue [Configure Contexts] s'ouvre. Un contexte appelé Default a été créé et défini par le système comme étant le contexte par défaut.

  3. Sélectionnez le contexte Default, cliquez sur le bouton Edit... et saisissez Prod dans la boîte de dialogue [Rename Context] qui s'ouvre pour renommer le contexte Default en Prod.

    Cliquez ensuite sur OK pour fermer la boîte de dialogue.

  4. Cliquez sur le bouton New... et saisissez Test dans la boîte de dialogue [New Context]. Cliquez ensuite sur OK pour fermer la boîte de dialogue.

  5. Cochez la case précédant le contexte que vous souhaitez définir comme contexte par défaut. Vous pouvez également définir le contexte par défaut en sélectionnant le nom du contexte dans la liste Default context environment dans la vue Contexts.

    Si nécessaire, vous pouvez déplacer un contexte vers le haut ou vers le bas en le sélectionnant et en cliquant sur le bouton Up ou Down.

    Dans cet exemple, définissez Test comme contexte par défaut et déplacez-le vers le haut.

  6. Cliquez sur OK pour valider le contexte que vous avez défini et fermer la boîte de dialogue [Configure Context].

    Les contextes nouvellement créés sont montrés dans la table des variables de contexte de la vue Contexts.

Définir les variables
  1. Cliquez sur le bouton [+] en bas de la vue Contexts pour ajouter une ligne de paramètre dans la table.

  2. Cliquez dans le champ Name et saisissez le nom de la variable que vous créez, host dans cet exemple.

  3. Dans la liste Type, sélectionnez le type de la variable correspondant au champ de composant dans lequel cette variable sera utilisée. Dans cet exemple, il s'agit du type String pour la variable host.

  4. Si nécessaire, cliquez dans le champ Comment et saisissez un commentaire pour décrire la variable.

  5. Cliquez dans le champ Value et saisissez la valeur de la variable sous chaque contexte.

    Selon le type de variable, le champ Value différera légèrement lorsque vous cliquerez dedans et fonctionnera de manière différente :

    Type

    Champ de valeur

    Valeur par défaut

    String (type par défaut)

    Champ de texte éditable

    null

    Boolean

    Liste déroulante avec deux options : true et false

    Character, Double, Integer, Long, Short, Object, BigDecimal

    Champ de texte éditable

    Date

    Champ de texte éditable, avec un bouton pour ouvrir la boîte de dialogue [Select Date & Time].

    File

    Champ de texte éditable, avec un bouton pour ouvrir la boîte de dialogue [Open] pour la sélection de fichiers.

    Directory

    Champ de texte éditable, avec un bouton pour ouvrir la boîte de dialogue [Browse for Folder] pour la sélection de dossiers.

    List of Value

    Champ de texte éditable, avec un bouton pour ouvrir la boîte de dialogue [Configure Values] pour la création et la configuration de listes.

    (Vide)

    Password

    Champ de texte éditable. Le texte saisi est crypté.

    Avertissement

    Il est recommandé d'entourer les valeurs des variables de type String par des guillemets doubles afin d'éviter d'éventuelles erreurs lors de l'exécution du Job.

  6. Si nécessaire, cochez la case à côté de la variable qui vous intéresse et saisissez le message Prompt dans le champ Prompt correspondant. Cela vous permet de voir un message Prompt pour la valeur de la variable et de l'éditer lors de l'exécution.

    Vous pouvez afficher ou cacher une colonne Prompt de la table en cliquant sur le triangle noir pointant vers la droite ou la gauche, à côté du nom du contexte correspondant.

  7. Répétez les étapes décrites ci-dessus pour définir toutes les variables dans cet exemple.

    • port, de type String,

    • database, de type String,

    • username, de type String,

    • password, de type Password,

    • table_name, de type String.

    Toutes les variables créées et leurs valeurs sous les différents contextes sont affichées dans la table et prêtes à être utilisées dans votre Job. Vous pouvez continuer d'éditer les variables dans cette vue si nécessaire.

    Vous pouvez également ajouter une variable de contexte built-in dans le Repository afin de pouvoir la réutiliser dans d'autres Jobs. Pour plus d'informations, consultez Ajouter une variable de contexte built-in dans le Repository.

Définir les variables à partir de la vue Component

La manière la plus rapide de créer une seule variable de contexte est d'appuyer sur la touche F5 à partir de la vue Component :

  1. Dans le champ Component correspondant, placez votre curseur dans le champ que vous souhaitez paramétrer.

  2. Appuyez sur F5 pour afficher la boîte de dialogue [New Context Parameter] :

  3. Donnez un nom à cette nouvelle variable dans le champ Name, renseignez le champ Comment si nécessaire et choisissez le Type.

  4. Saisissez un message Prompt à afficher pour confirmer l'utilisation de cette variable lors de l'exécution du Job courant (généralement utilisé comme test), puis cochez la case Prompt for value pour afficher le message Prompt et le champ de valeur éditable lors de l'exécution.

  5. Si vous avez déjà renseigné le champ correspondant dans la vue Component du composant, cette valeur est automatiquement reprise dans le champ Default value. Sinon, saisissez la valeur par défaut que vous souhaitez utiliser.

  6. Cliquez sur Finish pour valider.

  7. Les nouvelles variables que vous venez de créer apparaissent dans la liste des variables de contexte de l'onglet Contexts.

Note

Le nom de la variable doit respecter certaines règles de saisie et ne doit contenir aucun caractère interdit, notamment les espaces.

La variable créée est automatiquement stockée dans tous les contextes existants, mais vous pourrez par la suite changer la valeur de manière indépendante dans chaque contexte.

Pour plus d'informations concernant la création ou l'édition d'un contexte, consultez Définir les contextes.