Créer une activité SFTP

Créez une activité qui exécute des commandes SFTP de base sur un serveur distant.

Avant de commencer

Rôles requis : activity_creator ou workflow_admin

Pourquoi et quand exécuter cette tâche

Vous pouvez créer une activité personnalisée qui gère les fichiers et les répertoires sur un hôte cible ou copie un fichier d’un serveur SFTP à un autre. Le contenu du fichier est diffusé via un MID Server, ce qui évite d’avoir à stocker les données sur le disque dur de la machine hôte du MID Server.

Remarque :

Cette activité nécessite les informations d’identification d’un utilisateur qui peut exécuter des commandes SFTP sur l’hôte source. L’activité Copier le fichier , fournie dans le pack d’activités, nécessite des informations d’identification distinctes pour accéder à l’hôte cible.

Procédure

1. Créez une activité personnalisée.
   Cette action crée une activité personnalisée à l’aide d’un modèle.
2. Après avoir configuré les propriétés générales et créé des variables d’entrée, configurez la commande d’exécution SFTP.

   Option	Description
   Commande	Type d’activité à créer. Les choix possibles sont les suivants : Copier le fichier Créer un répertoire Obtenir la liste de fichiers Supprimer un fichier ou un répertoire Renommer un fichier ou un répertoire Définir les attributs de fichier Remarque : Les champs qui s’affichent sur le formulaire dépendent de la commande que vous sélectionnez.
   Hôte source	Nom ou adresse IP du serveur contenant les fichiers ciblés par l’activité.
   Port source	Numéro de port à utiliser pour communiquer avec le serveur source. Le numéro de port par défaut est 22.
   Chemin d’accès au fichier source	Chemin complet vers un fichier (/temp/test_data_file.txt) ou un répertoire (/temp/test_dir) sur un hôte source en fonction de la commande sélectionnée. Champ disponible sur les commandes suivantes : Copier le fichier Supprimer un fichier ou un répertoire Définir les attributs de fichier
   Répertoire source	Chemin d’accès au répertoire où se trouvent les fichiers source. Champ disponible sur les commandes suivantes : Créer un répertoire Obtenir la liste de fichiers
   Fichiers sources	Noms des fichiers sources spécifiques à inclure dans le transfert de fichier. Séparez les noms de fichiers par des points-virgules. Ce champ prend en charge une liste de modèles génériques séparés par des points-virgules. Par exemple : *.txt ; a ?cd.pdf. Si ce champ est vide, tous les fichiers sont inclus. Champ disponible sur la commande suivante : Obtenir la liste de fichiers Remarque : Pour plus d’informations sur la façon dont les valeurs de ce champ affectent les options d’autres champs, reportez-vous à l’explication logique qui suit.
   Est un répertoire	Si cette option est activée, spécifie que le chemin d’accès au fichier est un répertoire. Champ disponible sur la commande suivante : Supprimer un fichier ou un répertoire
   Balise d'informations d'identification pour la sou	Balise d’informations d’identification spécifique que cette activité doit utiliser pour exécuter des commandes SFTP sur l’hôte source.
   Balise d'informations d'identification pour la cib	Balise d’informations d’identification spécifique que cette activité doit utiliser pour exécuter des commandes SFTP sur l’hôte cible. Champ disponible sur la commande suivante : Copier le fichier
   Fichiers exclus	Noms des fichiers sources spécifiques à exclure du transfert de fichier. L’activité agit sur tous les autres fichiers trouvés dans le répertoire source ou les sous-dossiers. Séparez les noms de fichiers par des virgules. Ce champ prend en charge les listes séparées par des virgules des modèles génériques. Par exemple : *.txt, un ?cd.pdf.. Champ disponible sur la commande suivante : Obtenir la liste de fichiers Remarque : Pour plus d’informations sur la façon dont les valeurs de ce champ affectent les options d’autres champs, reportez-vous à l’explication logique qui suit.
   Inclure les sous-dossiers	Si cette option est cochée, inclut les fichiers des sous-dossiers du répertoire source. Champ disponible sur la commande suivante : Obtenir la liste de fichiers Remarque : Pour plus d’informations sur la façon dont votre sélection affecte les autres champs du formulaire, consultez l’explication logique qui suit.
   Hôte cible	Nom ou adresse IP du serveur vers lequel les fichiers sont transférés. Champ disponible sur la commande suivante : Copier le fichier
   Port cible	Numéro de port à utiliser pour communiquer avec l’hôte cible. Le numéro de port par défaut est 22. Champ disponible sur la commande suivante : Copier le fichier
   Chemin de fichier cible	Chemin d’accès complet à un fichier sur un hôte cible. Champ disponible sur les commandes suivantes : Copier le fichier Renommer un fichier ou un répertoire
   Suffixe pour fichier temporaire	Si un fichier existe sur un hôte cible, cette commande active l’utilisation d’un suffixe temporaire pour un nom de fichier. Si ce champ contient une valeur, l’activité copie d’abord le fichier source dans un fichier temporaire sur l’hôte cible en l’appelant targetFilePath + tempFileSuffix comme nom. Une fois l’opération terminée, l’activité renomme le fichier avec le nom de fichier cible réel. Si ce champ est vide, l’activité copie le fichier source directement dans le fichier cible et le remplace, s’il existe. Champ disponible sur la commande suivante : Copier le fichier
   UID	Attribut d’ID d’utilisateur à appliquer à un fichier ou à un répertoire. Les valeurs UID et GID doivent être définies ensemble comme une paire ou elles sont ignorées. Les numéros UID et GID sont des valeurs internes renvoyées par l’activité Obtenir la liste de fichiers. En règle générale, vous utilisez d’abord l’activité Obtenir la liste de fichiers pour renvoyer une liste de fichiers et de leurs attributs. Ensuite, vous pouvez déplacer un fichier d’un hôte source vers un hôte cible et définir les attributs du fichier source sur le fichier cible. Ce flux est illustré dans le Workflow de transfert de fichiers SFTPfichier . Champ disponible sur la commande suivante : Définir les attributs de fichier
   GID	Attribut d’ID de groupe à appliquer à un fichier ou à un répertoire. Les valeurs UID et GID doivent être définies ensemble comme une paire ou elles sont ignorées. Les numéros UID et GID sont des valeurs internes renvoyées par l’activité Obtenir la liste de fichiers. En règle générale, vous utilisez d’abord l’activité Obtenir la liste de fichiers pour renvoyer une liste de fichiers et de leurs attributs. Ensuite, vous pouvez déplacer un fichier d’un hôte source vers un hôte cible et définir les attributs du fichier source sur le fichier cible. Ce flux est illustré dans le Workflow de transfert de fichiers SFTPfichier . Champ disponible sur la commande suivante : Définir les attributs de fichier
   Autorisations	Autorisations de fichier ou de répertoire à définir pour l’utilisateur et le groupe spécifiés. Cette valeur doit être exprimée sous la forme d’un nombre entier, par exemple 16877, qui définit ces autorisations : rwxr-xr-x. Les numéros d’autorisation sont des valeurs internes renvoyées par l’activité Obtenir la liste de fichiers. En règle générale, vous utilisez d’abord l’activité Obtenir la liste de fichiers pour renvoyer une liste de fichiers et de leurs attributs. Ensuite, vous pouvez déplacer un fichier d’un hôte source vers un hôte cible et définir les attributs du fichier source sur le fichier cible. Ce flux est illustré dans le Workflow de transfert de fichiers SFTPfichier . Champ disponible sur la commande suivante : Définir les attributs de fichier
   Horodatage d’accès	Remplacez l’horodatage du dernier accès au fichier ou au répertoire. Les horodatages d’accès et de modification doivent être définis ensemble en tant que paire. Champ disponible sur la commande suivante : Définir les attributs de fichier
   Horodatage de modification	Remplacez l’horodatage lors de la dernière modification du fichier ou du répertoire. Les horodatages d’accès et de modification doivent être définis ensemble en tant que paire. Champ disponible sur la commande suivante : Définir les attributs de fichier
   Taille en octets	Taille d’un fichier, exprimée en octets. Champ disponible sur la commande suivante : Définir les attributs de fichier
   Options de Serveur MID requises	Serveur MID avec les options de serveur MID appropriées pour la connexion aux serveurs source et cible.

   Le système utilise cette logique pour déterminer les fichiers à déplacer à partir de l’hôte source :

   • Si le champ Fichiers sources est vide, le système sélectionne tous les fichiers du répertoire source. Dans le cas contraire, il ne sélectionne que les fichiers dont les noms correspondent à l’un des modèles de nom de fichier indiqués dans le champ.
   • Si le champ Fichiers exclus est vide, le système n’exclut rien. Dans le cas contraire, il exclut les fichiers dont les noms correspondent à l’un des modèles de nom de fichier donnés dans le champ.
   • La règle d’exclusion a une préférence plus élevée que la règle d’inclusion. Si un nom de fichier correspond à l’un des modèles de nom de fichier dans le champ Fichiers exclus, il n’entre pas dans la sélection, quelle que soit la règle d’inclusion.
   • Lorsque la case Inclure les sous-dossiers n’est pas cochée, le système recherche uniquement dans le répertoire source les fichiers à inclure ou à exclure. Sinon, il recherche dans le répertoire source et l’un de ses sous-dossiers les fichiers à inclure ou à exclure.

   Remarque :

   Vous pouvez mapper automatiquement les valeurs des paramètres d’une charge utile de test aux variables de l’onglet Sorties . Reportez-vous à la section Variables de sortie de mappage automatique.

Que faire ensuite

• Utiliser le mappage automatique pour générer des sorties et des règles d’analyse (recommandé pour JDBC)
• Si vous n’utilisez pas le mappage automatique, vous pouvez créer manuellement des variables de sortie et créer des règles d’analyse

Paramètres d’exécution du modèle SFTP

Vous utilisez des paramètres d’exécution pour créer le script de processus d’entrée dans le formulaire de prétraitement .

Pour obtenir une description des champs de commande, reportez-vous à la section Configurer la commande d’exécution SFTP.

Remarque :

Vous devez utiliser le préfixe executionParam. avec toutes les variables de cette table.

Tableau 1. Paramètres d’exécution SFTP

Nom	Variable	Type	Utilisation
Commande	commande	Chaîne	Identifie la fonction de cette activité. Les commandes possibles sont les suivantes : Copier le fichier Créer un répertoire Obtenir la liste de fichiers Supprimer un fichier ou un répertoire Renommer un fichier ou un répertoire Définir les attributs de fichier
Source	source	Chaîne	Identifie l’hôte source.
Port source	source_port	Entier	Identifie le port utilisé pour communiquer avec l’hôte source.
Répertoire source	source_directory	Chaîne	Chemin d’accès au répertoire source des fichiers à déplacer.
Fichiers sources	source_files	Chaîne	Noms des fichiers sur la source à déplacer.
Fichiers exclus	excluded_files	Chaîne	Répertorie les fichiers exclus de l’opération.
Chemin d’accès au fichier source	source_file_path	Chaîne	Chemin d’accès aux fichiers sources à déplacer.
Hôte cible	target_host	Chaîne	Identifie l’hôte cible.
Port cible	target_port	Entier	Identifie le port utilisé pour communiquer avec l’hôte cible.
Répertoire cible	target_directory	Chaîne	Chemin d’accès complet au répertoire cible sur l’hôte cible.
Chemin de fichier cible	target_file_path	Chaîne	Chemin d’accès complet à un fichier ou à un répertoire sur l’hôte source ou sur l’hôte cible. Par exemple, cette valeur est utilisée dans l’activité Renommer un fichier ou un répertoire dans le pack d’activités.
Préfixe du fichier temporaire	temp_file_postfix	Chaîne	Extension de nom de fichier temporaire utilisée par l’activité Copier un fichier lors du déplacement d’un fichier. Si ce champ contient une extension, le fichier source est copié dans un fichier temporaire à l’aide target file name + temp_file_postfixde , avant d’être renommé en fichier cible réel. Si ce champ est vide, le fichier source est copié directement dans le fichier cible.
Est un répertoire	is_directory	Booléen	Indique si le chemin d’accès au fichier donné est un répertoire.
Inclure les sous-dossiers	include_subfolders	Booléen	Indique si le système recherche dans les sous-dossiers du répertoire source les fichiers à inclure et à exclure.
UID d’attribut de fichier	file_attribute_uid	Entier	ID d’utilisateur associé à un fichier ou à un répertoire.
GID d’attribut de fichier	file_attribute_gid	Entier	ID de groupe associé à un fichier ou à un répertoire.
Autorisations d’attributs de fichiers	file_attribute_permissions	Entier	Autorisations de fichier ou de répertoire pour l’utilisateur et le groupe spécifiés.
Atime d’attribut de fichier	file_attribute_atime	Entier	Accédez à l’horodatage à partir des attributs du fichier.
Attribut de fichier mtime	file_attribute_mtime	Entier	Horodatage de modification à partir des attributs du fichier.
Taille d’attribut de fichier	file_attribute_size	Entier	Taille du fichier, en octets.
Balise d’informations d’identification source	source_credential_tag	Chaîne	Alias d’informations d’identification pour les activités d’orchestration utilisées pour exécuter la commande sur l’hôte source.
Balise d’informations d’identification cible	target_credential_tag	Chaîne	Balise d’informations d’identification utilisée pour exécuter la commande sur l’hôte cible.
Capacités MID	Capacités MID	Chaîne (séparée par des virgules)	Liste des options de Serveur MID requises.

Paramètres de post-traitement SFTP et analyse de la charge utile

Utilisez ces paramètres pour créer un script de post-traitement, une analyse de la charge utile et un balisage.

Tableau 2. Paramètres de post-traitement SFTP

Nom	Variable	Type	Utilisation
Sortie	sortie	Chaîne	Contient les données de sortie renvoyées par la requête.
EccSysId (en anglais seulement)	eccSysId	Chaîne	Contient l’ID de référence associé au message d’entrée File d’attente ECC.
Messages d’erreur	Messages d’erreur	Chaîne	Contient les messages d’erreur renvoyés par la requête. Si aucun message d’erreur n’est renvoyé, cette valeur est nulle.
Balises	balises	Carte de hachage des valeurs de balises renvoyées par la commande SSH	Contient les balises utilisées pour extraire la sortie à l’aide des commandes SSH. La sortie de la balise est délimitée par des signes de pourcentage doubles, comme dans %%tagname%% ... %%. Configurez la commande à l’aide du format suivant : %%tagname1%% output1 line 1 output1 line 2 … %% %%tagname2%% output2 line 1 output2 line 2 … %% Les balises renvoyées sont des objets de carte de hachage JavaScript dans lesquels chaque clé est préfixée par une balise accompagnée du tagname. {"__text__": "", "tagtagname1":"output1 line1\noutput1 line2\n", "tagtagname2":"output2 line1\noutput2 line2\n"}

Configurer la commande d’exécution SFTP

Utilisez les variables d’entrée que vous avez créées pour configurer la commande qu’Orchestration exécute sur la cible SFTP.

Avant de commencer

Créez les variables d’entrée dont vous avez besoin dans le formulaire Entrées avant de pouvoir passer à l’étape Commande d’exécution .

Rôle requis : activity_creator, admin

Remarque :

Vous pouvez tester la connexion JDBC entre le serveur MID et la cible sans avoir à exécuter l’activité dans un contexte de workflow. Pour plus d’informations, consultez les sorties des modèles de test.

Procédure

1. Faites glisser les variables de la liste des entrées et déposez-les dans les champs de commande.
   Le système formate la variable dans la syntaxe appropriée pour la commande.

   Figure 1. Commande d’exécution SFTP

   

2. Renseignez les champs affichés dans la table.

   Tableau 3. Champs de commande SFTP

   Champ	Description	Commande
   Commande	Type d’activité à créer. Les choix possibles sont les suivants : Copier le fichier Créer un répertoire Obtenir la liste de fichiers Supprimer un fichier ou un répertoire Renommer un fichier ou un répertoire Définir les attributs de fichier Remarque : Les champs affichés sur le formulaire dépendent de la commande sélectionnée.	Tout
   Hôte source	Nom ou adresse IP du serveur contenant les fichiers ciblés par l’activité.	Tout
   Port source	Numéro de port à utiliser pour communiquer avec le serveur source. Le numéro de port par défaut est 22.	Tout
   Chemin d’accès au fichier source	Chemin d’accès complet à un fichier sur un hôte source.	Copier le fichier Supprimer un fichier ou un répertoire Définir les attributs de fichier
   Répertoire source	Chemin d’accès au répertoire où se trouvent les fichiers source.	Créer un répertoire Obtenir la liste de fichiers
   Fichiers sources	Noms des fichiers sources spécifiques à inclure dans l’action de gestion. Séparez les noms de fichiers de cette liste par des points-virgules. Ce champ prend en charge l’utilisation de caractères génériques. Si ce champ est vide, tous les fichiers sont inclus. Pour plus d’informations sur la façon dont les valeurs de ce champ sont affectées par les options d’autres champs, reportez-vous à la section située sous le tableau.	Obtenir la liste de fichiers
   Est un répertoire	Case à cocher qui détermine si le chemin d’accès spécifié est un répertoire.	Supprimer un fichier ou un répertoire
   Balise d'informations d'identification pour la sou	Alias d’informations d’identification spécifiques pour les activités d’orchestration que cette activité doit utiliser pour exécuter des commandes SFTP sur l’hôte source.	Tout
   Balise d'informations d'identification pour la cib	Balise d’informations d’identification spécifique que cette activité doit utiliser pour exécuter des commandes SFTP sur l’hôte cible.	Copier le fichier
   Fichiers exclus	Noms des fichiers sources spécifiques à exclure de l’action de gestion. L’activité agit sur tous les autres fichiers trouvés dans le répertoire source ou les sous-dossiers. Séparez les noms de fichiers de cette liste par des points-virgules. Ce champ prend en charge l’utilisation de caractères génériques. Pour plus d’informations sur la façon dont les valeurs de ce champ sont affectées par les options d’autres champs, reportez-vous à la section située sous le tableau.	Obtenir la liste de fichiers
   Inclure les sous-dossiers	Cochez la case pour gérer les fichiers à partir de sous-dossiers dans le répertoire source. Pour plus d’informations sur la façon dont votre sélection affecte les autres champs du formulaire, consultez la section sous le tableau.	Obtenir la liste de fichiers
   Hôte cible	Nom ou adresse IP du serveur vers lequel les fichiers sont transférés.	Copier le fichier
   Port cible	Numéro de port à utiliser pour communiquer avec l’hôte cible. Le numéro de port par défaut est 22.	Copier le fichier
   Chemin de fichier cible	Chemin d’accès complet à un fichier sur un hôte cible.	Copier le fichier Renommer un fichier ou un répertoire
   Suffixe pour fichier temporaire	Suffixe temporaire à utiliser pour un nom de fichier si le fichier existe déjà sur un hôte cible. Si ce champ contient une valeur, l’activité supprime le fichier cible en double, s’il existe, puis copie le fichier source dans un fichier temporaire en utilisant targetFilePath + tempFileSuffix comme nom. Une fois l’opération terminée, l’activité renomme le fichier avec le nom de fichier cible réel. Si ce champ est vide, l’activité copie le fichier source directement dans le fichier cible et le remplace, s’il existe déjà.	Copier le fichier
   UID	Attribut d’ID d’utilisateur à appliquer à un fichier ou à un répertoire. Les valeurs UID et GID doivent être définies ensemble comme une paire ou elles sont ignorées.	Définir les attributs de fichier
   GID	Attribut d’ID de groupe à appliquer à un fichier ou à un répertoire. Les valeurs UID et GID doivent être définies ensemble comme une paire ou elles sont ignorées.	Définir les attributs de fichier
   Autorisations	Autorisations de fichier ou de répertoire à définir pour l’utilisateur et le groupe spécifiés. Cette valeur doit être exprimée sous la forme d’un nombre entier, par exemple 16877, qui définit ces autorisations : rwxr-xr-x. Le numéro d’autorisation est une valeur interne renvoyée par l’activité Obtenir la liste de fichiers. En règle générale, vous utilisez d’abord l’activité Obtenir la liste de fichiers pour renvoyer une liste de fichiers et de leurs attributs. Ensuite, vous pouvez déplacer un fichier d’un hôte source vers un hôte cible et définir les attributs du fichier source sur le fichier cible. Ceci est démontré dans le Workflow de transfert de fichiers SFTPfichier .	Définir les attributs de fichier
   Horodatage d’accès	Remplacez l’horodatage du dernier accès au fichier ou au répertoire. Les horodatages d’accès et de modification doivent être définis ensemble en tant que paire.	Définir les attributs de fichier
   Horodatage de modification	Remplacez l’horodatage lors de la dernière modification du fichier ou du répertoire. Les horodatages d’accès et de modification doivent être définis ensemble en tant que paire.	Définir les attributs de fichier
   Taille en octets	Taille d’un fichier, exprimée en octets.	Définir les attributs de fichier
   Options de Serveur MID requises	Serveur MID avec les options de serveur MID appropriées pour la connexion aux serveurs source et cible. Par défaut, le système sélectionne un Serveur MID SSH.	Tout

   Le système utilise cette logique pour déterminer les fichiers à déplacer à partir de l’hôte source :

   • Si le champ Fichiers sources est vide, le système sélectionne tous les fichiers du répertoire source. Dans le cas contraire, il ne sélectionne que les fichiers dont les noms correspondent à l’un des modèles de nom de fichier indiqués dans le champ.
   • Si le champ Fichiers exclus est vide, le système n’exclut rien. Dans le cas contraire, il exclut les fichiers dont les noms correspondent à l’un des modèles de nom de fichier donnés dans le champ.
   • La règle d’exclusion a une préférence plus élevée que la règle d’inclusion. Un fichier dont le nom correspond à l’un des modèles de nom de fichier dans le champ Fichiers exclus n’entre pas dans la sélection, même s’il serait sélectionné par la règle d’inclusion.
   • Lorsque la case Inclure les sous-dossiers n’est pas cochée, le système recherche uniquement dans le répertoire source les fichiers à inclure ou à exclure. Sinon, il recherche dans le répertoire source et l’un de ses sous-dossiers les fichiers à inclure ou à exclure.
3. Cliquez sur Enregistrer.
4. Cliquez sur Continuer pour passer à l’étape Sorties .