Activité FTP Obtenir fichier

A l'exécution, l'activité FTP Obtenir fichier se connecte à un serveur FTP et tente d'obtenir un fichier unique sur un emplacement désigné. Vous pouvez configurer l'activité FTP Obtenir fichier pour renvoyer le contenu du fichier dans une variable de l'orchestration.Par ailleurs, vous pouvez configurer l'activité FTP Obtenir fichier pour renvoyer l'horodatage du fichier renvoyé par le serveur FTP dans une variable de l'orchestration.

L'activité FTP Obtenir fichier diffère de l'activité FTP Interroger répertoire pour les points suivants :
  • L'activité FTP Obtenir fichier ne recherche pas un ou plusieurs fichiers dans le répertoire indiqué. L'activité FTP Obtenir fichier recherche le fichier une seule fois et en cas d'échec, elle envoie une erreur, puis le travail d'orchestration poursuit le traitement.
  • L'activité FTP Obtenir fichier n'est pas une activité de démarrage, elle ne peut donc pas être la première activité d'une orchestration.
  • L'activité FTP Obtenir fichier ne déplace ni ne supprime des fichiers sur le serveur FTP.

Lien symbolique

Le support de liens symboliques par l'activité FTP Obtenir fichier pendant l'exécution dépend des facteurs suivants :  
  • Les types de lien symbolique pris en charge par le système d'exploitation qui héberge le serveur FTP.
  • Les types de lien symbolique pris en charge par le serveur FTP même.
  • Les types de lien symbolique pris en charge par l'activité FTP Obtenir fichier, comme indiqués dans le tableau suivant :
    Tableau 1.
    Liens symboliques vers... Liens en dur Liens symboliques Remarques
    Fichiers Non pris en charge Non pris en charge L'activité FTP Obtenir fichier n'interprète pas les liens symboliques vers des fichiers en tant que fichiers et, par conséquent, les liens symboliques vers des fichiers ne sont pas traités par l'activité FTP Obtenir fichier en phase d'exécution.
    Répertoires Pris en charge Pris en charge  
Pour déterminer le support de lien symbolique spécifique pour un serveur FTP spécifique sur un système d'exploitation spécifique, consultez la documentation de votre système d'exploitation et du serveur FTP.

Ajout d'une activité FTP Obtenir fichier dans l'orchestration

  1. Créez ou ouvrez une orchestration. Une représentation graphique de l'orchestration s'affiche.
  2. Sélectionnez l'onglet Activités et développez le dossier FTP.
  3. Déplacez l'activité Obtenir fichier sur l'orchestration.
  4. Sélectionnez l'activité. La Liste de contrôle est affichée.

Création, sélection ou édition d'un noeud final FTP

  1. Cliquez sur la tâche Sélectionner le noeud final dans la liste de contrôle et sélectionnez l'une des actions suivantes :
    • Sélectionnez un noeud final existant :
      1. Sélectionnez Parcourir. L'explorateur de projets apparaît.
        Avertissement : Si vous spécifiez un nouveau noeud final FTP avec une structure de répertoire différente de celle du noeud final FTP initial, le travail d'orchestration peut échouer en phase d'exécution. Vous devez soit spécifier un nouveau serveur FTP qui correspond à la structure de répertoire du serveur FTP spécifié initialement, soit modifier le répertoire configuré dans la zone Dans le répertoire en cliquant sur Parcourir, comme décrit ci-dessous dans la procédure Configurer l'activité.
      2. Sélectionnez un noeud final existant et cliquez sur OK. Passez à la procédure "Configurer l'activité".
    • Sélectionnez un noeud final existant et éditez-le.
      1. Sélectionnez Parcourir. L'explorateur de projets apparaît.
      2. Sélectionnez un noeud final existant et cliquez sur OK.
        Avertissement : Si vous spécifiez un nouveau noeud final FTP avec une structure de répertoire différente de celle du noeud final FTP initial, le travail d'orchestration peut échouer en phase d'exécution. Vous devez soit spécifier un nouveau serveur FTP qui correspond à la structure de répertoire du serveur FTP spécifié initialement, soit modifier le répertoire configuré dans la zone Dans le répertoire en cliquant sur Parcourir, comme décrit dans la procédure "Configurer l'activité".
      3. Cliquez sur Editer. Le panneau Editer un noeud final apparaît.
    • Créez un noeud final : sélectionnez Nouveau. Le panneau Créer un noeud final apparaît.
  2. Création ou édition d'un noeud final FTP : Création ou édition d'un noeud final FTP

Spécification des règles de distribution

  1. Sélectionnez la tâche Règles de distribution dans la Liste de contrôle. Le panneau Règles de distribution apparaît. Si la sécurité n'est pas activée pour le noeud final FTP, les options Transfert au format texte (ASCII) et Transfert au format binaire (BINARY) sont activées. Si la sécurité est activée pour le noeud final FTP, le type de transfert de fichier est toujours binaire.
  2. Sélectionnez le type de transfert de fichier entre le dispositif d'intégration et le serveur FTP à l'aide de l'une des options suivantes :
    • Transfert au format texte (ASCII) - Seuls sept bits de chaque caractère du fichier sont transférés par le dispositif d'intégration vers le serveur FTP. Cette option est utilisée pour transférer des fichiers ASCII tels que des fichiers HTML et texte.
      ATTENTION :
      L'utilisation de cette option avec des fichiers binaires peut entraîner une perte de données.
    • Transfert au format binaire (BINARY) - Les huit bits de chaque octet du fichier sont transférés par le dispositif d'intégration vers le serveur FTP. Cette option est utilisée pour transférer des fichier binaires.
    Remarque : La définition du mode de transfert dans la tâche Règles de distribution équivaut à définir le mode de transfert via une session de ligne de commande avec un serveur FTP, à l'aide des commandes suivantes :
    • ascii
    • binary
Remarque : Le noeud final SFTP du connecteur FTP Cast Iron ne prend en charge que le protocole SFTP côté client version 3. Par conséquent, le protocole SFTP ne prend pas en charge le transfert de fichiers en mode ASCII/texte. Veillez à paramétrer le Type de transfert de fichier sur Transfert au format binaire (BINARY) dans le panneau Liste de contrôle > Règles de distribution.

Configuration de l'activité

  1. Sélectionnez la tâche Configurer dans la Liste de contrôle. La tâche Configuration apparaît.
  2. Configurez toutes les zones de ce panneau comme décrit dans le tableau suivant :
    Tableau 2.
    Zone Description
    Fichier nommé Cette zone n'est pas utilisée pour cette activité. Vous indiquez le nom du fichier de sortie à l'aide du paramètre d'entrée filename de la tâche Mapper les entrées.
    Répertoire source Indique le répertoire sur le serveur FTP où le dispositif d'intégration place le fichier généré dans cette activité. Vous pouvez indiquer un répertoire à l'aide de l'une des options suivantes:
    • Entrez directement le chemin de répertoire en cliquant dans la zone et en entrant l'un des chemins de répertoire suivants :
      • Chemin de répertoire relatif, par exemple : /output.Considère que le répertoire de base FTP a été configuré pour le compte utilisateur qui se connecte au serveur FTP. Pour plus d'informations, consultez la "Remarque" ci-dessous.
      • Chemin de répertoire complet, par exemple, sur une machine UNIX : /home/user/output.
    • Cliquez sur Parcourir... pour remplir la liste déroulante de répertoires disponibles. Sélectionnez le répertoire approprié dans la liste déroulante.
    Remarque : UNIX : Si vous spécifiez un chemin de répertoire relatif lorsque vous vous connectez à un serveur FTP sur une machine UNIX, vérifiez que le répertoire de base FTP a été correctement spécifié dans le fichier /etc/password pour le compte utilisateur qui se connecte au serveur FTP.
    De type Spécifie comment lire le contenu du fichier - soit en tant que données binaires, soit en tant que texte codé. Si l'option Texte est sélectionnée, définissez le type de codage à l'aide de l'une des options suivantes :
    • Dans la liste déroulante codé avec, sélectionnez l'un des types de codage par défaut.
    • Entrez le type de codage directement en cliquant dans la zone codé avec et en saisissant le type de codage.
     
    Avertissement : Vous devez spécifier l'option Transfert au format texte (ASCII) pour les activités FTP lorsque vous extrayez des fichiers et placez des fichiers texte sur un serveur FTP pour des noeuds finaux qui manipulent des données texte en transférant des données depuis et vers le noeud final FTP en mode ASCII. Par exemple, les noeuds finaux FTP de grand système et DOS manipulent les données ASCII lorsqu'ils transmettent des données en mode ASCII.
    Par exemple, si votre orchestration extrait des fichiers ASCII à l'aide de l'activité FTP Interroger répertoire et place les fichiers ASCII, à l'aide de l'activité FTP Placer fichier, sur un serveur FTP de grand système, vous devez spécifier les options des tâches suivantes dans Studio :
    • Dans la tâche Configurer d'une activité FTP Interroger répertoire, pour la zone De type, sélectionnez l'option Texte.
    • Dans la tâche Règles de distribution d'une activité FTP Interroger répertoire, pour la zone Type de transfert de fichier, sélectionnez l'option Transfert au format texte (ASCII).
    • Dans la tâche Configurer d'une activité FTP Placer fichier, pour la zone De type, sélectionnez l'option Texte.
    • Dans la tâche Règles de distribution d'une activité FTP Placer fichier, pour la zone Type de transfert de fichier, sélectionnez l'option Transfert au format texte (ASCII).

Spécification des options de nouvelle tentative

  1. Sélectionnez la tâche Réessayer dans la Liste de contrôle. Le panneau Réessayer apparaît.
  2. Configurez les options de nouvelle tentative pour la connexion à un serveur FTP. Le tableau suivant définit les options de nouvelle tentative pour une connexion à un serveur FTP :
    Tableau 3.
    Zone Description
    Réessayer  
    1) Attendre ___ seconde(s) entre chaque tentative. Nombre de secondes pendant lesquelles le dispositif d'intégration attend avant de tenter d'établir une connexion avec le serveur FTP.
    2) Tenter de se connecter ___ fois avant l'échec. Indique le nombre de tentatives - le nombre maximum de fois que le dispositif d'intégration tente d'établir une connexion avec le serveur FTP avant d'émettre une erreur et d'arrêter le traitement du travail d'orchestration en cours.

    Si vous déployez une orchestration qui contient une activité FTP Obtenir fichier et que le dispositif d'intégration ne peut pas se connecter au serveur FTP spécifié, le dispositif d'intégration consigne les erreurs de connexion en tant qu'avertissements dans les journaux du système et de l'orchestration jusqu'à ce que la valeur de nombre de tentatives soit atteinte. Lorsque le nombre de tentatives est atteint, le dispositif d'intégration consigne une erreur dans les journaux du système et de l'orchestration et arrête le traitement du travail d'orchestration en cours.

    Par exemple, si vous indiquez la valeur 3 pour le nombre de tentatives, les erreurs de première, seconde et troisième connexions apparaissent dans le journal système en tant qu'avertissements. Le dispositif d'intégration consigne la quatrième erreur de connexion en tant qu'Erreur et arrête le traitement du travail d'orchestration en cours.

Mappage de l'entrée dans l'activité

  1. Sélectionnez la tâche Mapper les entrées dans la Liste de contrôle. Les paramètres d'entrée de l'activité sont affichés dans le panneau Vers l'activité.
  2. Le paramètre filename est le seul paramètre pour lequel vous devez indiquer une valeur dans l'activité. Tous les autres paramètres sont facultatifs. Le paramètre filename spécifie le nom du fichier à obtenir sur le serveur FTP. Vous fournissez une valeur pour le paramètre filename en créant un lien à partir du paramètre d'entrée filename vers une variable ou en définissant une valeur par défaut pour le paramètre d'entrée nom_fichier.

    Si les paramètres d'entrée facultatifs répertoriés dans le tableau suivant ne sont pas affichés dans le panneau Vers l'activité de la fenêtre Mapper les entrées, sélectionnez Mapper > Afficher les paramètres facultatifs dans le menu de la barre d'outils ou cliquez avec le bouton droit de la souris dans le panneau Vers l'activité et sélectionnez l'option Afficher les paramètres facultatifs. Si vous ne pouvez pas sélectionner l'option Mapper > Afficher les paramètres facultatifs dans le menu de la barre d'outils, cliquez sur un noeud dans le panneau Mapper les entrées pour activer cette option.

    Si vous le souhaitez, vous pouvez remplacer les paramètres spécifiés dans la tâche Configurer et Sélectionner le noeud final de la Liste de contrôle, dynamiquement en phase d'exécution, à l'aide des paramètres d'entrée définis dans le tableau suivant.

    Par exemple, vous pouvez définir le répertoire du serveur FTP où le dispositif d'intégration obtient le fichier, dans la tâche Configurer par le répertoire appelé entrée. A l'exécution, le nom du répertoire inputXML peut être transmis à l'activité à l'aide du paramètre d'entrée directory. Le nom du répertoire spécifié dynamiquement pendant l'exécution remplace le paramètre initial, spécifié dans le panneau Configurer. Dans cet exemple, le dispositif d'intégration tente d'obtenir le fichier du répertoire inputXML.

Tableau 4.
Nom de paramètre d'entrée/Noeud Description Remplace le paramètre dans la tâche ?
directory Indique le répertoire sur le serveur FTP où le dispositif d'intégration place le fichier généré dans cette activité. Le paramètre d'entrée directory remplace la zone Répertoire source de la tâche Configurer.
encoding Spécifie comment les données sortantes sont écrites dans le fichier :
  • Si aucun codage n'est requis, spécifiez la chaîne : binary.
  • Si un codage est nécessaire, spécifiez le type de codage qui doit être utilisé pour coder les données sortantes, par exemple, UTF-8, US-ASCII, ISO_8859-1, EBCDIC-US ou SHIFT-JIS.
Le paramètre d'entrée encoding remplace le codage spécifié dans la zone De type de la tâche Configurer mais si l'option Binaire est sélectionnée dans la zone De type de la tâche Configurer, le codage spécifié par le paramètre d'entrée encoding n'est pas pris en compte.
connection/timeout Spécifie le délai de connexion - nombre de secondes avant l'expiration du délai entre la tentative du dispositif d'intégration pour établir une connexion avec le noeud final et le temps nécessaire au noeud final pour répondre à la demande de connexion. Pour l'activité FTP Obtenir fichier, durée pendant laquelle le dispositif d'intégration tente d'établir une connexion avec le serveur FTP avant l'expiration du délai. Le noeud de délai du paramètre d'entrée de connexion remplace la zone Délai de connexion - Dépassement de délai après ___ seconde(s) lors de l'établissement d'une connexion avec le noeud final du noeud final FTP.
connection/host Spécifie le nom d'hôte ou l'adresse IP du serveur FTP. Le noeud host du paramètre d'entrée connection remplace la zone Nom d'hôte du noeud final FTP.
connection/port Spécifie le numéro de port attribué au nom d'hôte spécifié. Le port standard pour le trafic FTP est 21. Le port par défaut pour le trafic SFTP est 22. Le noeud port du paramètre d'entrée connection remplace la zone Port du noeud final FTP.
connection/username Spécifiez le nom d'utilisateur du compte utilisé pour la connexion au serveur FTP. Le noeud username du paramètre d'entrée connection remplace la zone Nom d'utilisateur du noeud final FTP.
connection/password Spécifiez le mot de passe du compte utilisé pour la connexion au serveur FTP. Le noeud password du paramètre d'entrée connection remplace la zone Mot de passe du noeud final FTP.

Mappage de la sortie de l'activité

  1. Sélectionnez la tâche Mapper les sorties dans la Liste de contrôle. Les paramètres de sortie de l'activité sont affichés dans le panneau Depuis l'activité, comme décrit dans le tableau suivant :
    Tableau 5.
    Nom de paramètre de sortie Description
    data Contenu du fichier.
    timestamp Contient l'horodatage du fichier renvoyé par le serveur FTP, généralement la date de création ou celle de dernière modification du fichier.
  2. Mappez les paramètres de sortie souhaités sur des variables.