Méthodes du connecteur FTP

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 5 minutes de lecture

    • Les méthodes du connecteur FTP effectuent diverses actions sur le serveur dans le File Transfer Protocol cadre d’une automatisation. Pour activer les méthodes, vous devez fournir les paramètres appropriés.

    SetConfiguration

    Définit les détails d’accès au File Transfer Protocol serveur. Vous devez d’abord exécuter cette méthode.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 1. Paramètres de méthode SetConfiguration
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    URL URL de la File Transfer Protocol Données dans Chaîne Aucune Oui
    Nom d'utilisateur Nom d’utilisateur permettant d’accéder au File Transfer Protocol serveur. Données dans Chaîne Aucune Oui
    Mot de passe Mot de passe pour accéder au File Transfer Protocol serveur. Données dans Chaîne Aucune Oui

    Créer un dossier

    Crée un dossier sur le File Transfer Protocol serveur.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 2. Paramètres de la méthode CreateFolder
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Nom du dossier Chemin d’accès dans le File Transfer Protocol serveur où le dossier sera créé avec le nom du dossier. Données dans Chaîne Aucune Oui
    Retour Renvoie la valeur Vrai si le dossier est créé, sinon renvoie la valeur Faux. Données sorties Booléen Aucune Non applicable

    Fichier supprimé

    Supprime un fichier sur le serveur FTP.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 3. Paramètres de méthode DeleteFile
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Chemin d’accès au fichier distant Chemin d’accès au fichier que vous souhaitez supprimer du File Transfer Protocol serveur. Données dans Chaîne Aucune Oui
    Retour Renvoie la valeur Vrai si le fichier est supprimé, sinon renvoie la valeur Faux. Données sorties Booléen Non applicable Non applicable

    Supprimer le dossier

    Supprime le dossier spécifié dans le File Transfer Protocol serveur.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 4. Paramètres de la méthode DeleteFolder
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Chemin d’accès du dossier distant Chemin vers le dossier dans le File Transfer Protocol serveur contenant le nom du dossier. Données dans Chaîne Aucune Oui
    Retour Renvoie la valeur Vrai si le dossier est supprimé, sinon renvoie la valeur Faux. Données sorties Booléen Non applicable Non applicable

    DownloadFile (Télécharger)

    Télécharge un fichier du File Transfer Protocol serveur sur le disque local.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 5. Paramètres de méthode DownloadFile
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Fichier distant Chemin d’accès au fichier dans le File Transfer Protocol et le nom du fichier. Données dans Chaîne Aucune Oui
    Fichier local Chemin d’accès dans le lecteur local où le fichier sera téléchargé. Données dans Chaîne Aucune Oui
    TimeOut Délai après lequel la demande au File Transfer Protocol serveur expire. Données dans Entier Aucune Non
    Retour Renvoie la valeur Vrai si le fichier est téléchargé, sinon renvoie la valeur Faux. Données sorties Booléen Aucune Non applicable

    Dossier de téléchargement

    Télécharge un dossier du File Transfer Protocol serveur sur le disque local.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 6. Paramètres de méthode DownloadFolder
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Chemin d’accès du dossier distant Chemin vers le dossier dans File Transfer Protocol le et le nom du dossier. Données dans Chaîne Aucune Oui
    Chemin d’accès du dossier local Chemin sur le lecteur local où le dossier sera téléchargé. Données dans Chaîne Aucune Oui
    TimeOut Délai après lequel la demande au File Transfer Protocol serveur expire. Données dans Entier Aucune Non
    Retour Renvoie la valeur Vrai si le dossier est téléchargé, sinon renvoie la valeur Faux. Données sorties Booléen Aucune Non applicable

    GetFileList

    Renvoie la liste des fichiers contenus dans un dossier dans le File Transfer Protocol serveur.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 7. Paramètres de méthode GetFileList
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Chemin d’accès du dossier distant Chemin vers le dossier dans File Transfer Protocol le et le nom du dossier. Données dans Chaîne Aucune Oui
    Retour Renvoie la liste des fichiers contenus dans le dossier. Données sorties Chaîne Non applicable Non applicable

    RenommerFichier

    Renomme un fichier dans le File Transfer Protocol serveur.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 8. Paramètres de méthode RenameFile
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Chemin d’accès au fichier distant Chemin d’accès au fichier dans le File Transfer Protocol serveur et nom du fichier. Données dans Chaîne Aucune Oui
    NewNameofFile Chemin d’accès au fichier dans le File Transfer Protocol serveur et nouveau nom du fichier. Données dans Chaîne Aucune Oui
    Retour Renvoie la valeur Vrai si le nom du fichier est modifié, sinon renvoie la valeur Faux. Données sorties Booléen Non applicable Non applicable

    RenommezDossier

    Renomme un dossier dans le File Transfer Protocol serveur.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 9. Paramètres de méthode RenameFolder
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Dossier distant Le chemin vers le dossier dans le File Transfer Protocol serveur et le nom du dossier. Données dans Chaîne Aucune Oui
    NewNameofFolder Chemin vers le dossier dans le File Transfer Protocol serveur et le nouveau nom du dossier. Données dans Chaîne Aucune Oui
    Retour Renvoie la valeur Vrai si le nom du dossier est modifié, sinon renvoie la valeur Faux. Données sorties Booléen Non applicable Non applicable

    UploadFile

    Télécharge un fichier du disque local vers le File Transfer Protocol serveur.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 10. Paramètres de méthode UploadFile
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Chemin d’accès au fichier local Chemin d’accès au fichier sur le lecteur local. Données dans Chaîne Aucune Oui
    Chemin d’accès au fichier distant Chemin d’accès à l’emplacement dans le File Transfer Protocol serveur. Données dans Chaîne Aucune Oui
    Retour Renvoie la valeur Vrai si le fichier est chargé, sinon renvoie la valeur Faux. Données sorties Booléen Non applicable Non applicable

    Dossier de chargement

    Télécharge un dossier du lecteur local vers le File Transfer Protocol serveur.

    Pour fournir des entrées aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 11. Paramètres de méthode UploadFolder
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire ?
    Chemin d’accès du dossier local Chemin d’accès au dossier sur le lecteur local. Données dans Chaîne Aucune Oui
    Chemin d’accès du dossier distant Chemin d’accès à l’emplacement dans le File Transfer Protocol serveur. Données dans Chaîne Aucune Oui
    Retour Renvoie la valeur Vrai si le dossier est téléchargé, sinon renvoie la valeur Faux. Données sorties Booléen Non applicable Non applicable