Méthodes du connecteur FTP

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 6 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 dans les paramètres, reportez-vous à la section Configurer les propriétés des ports.

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

    Créer un dossier

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

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

    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 Aucun Oui
    Retour Renvoie la valeur Vrai si le dossier est créé, sinon renvoie la valeur Faux. Sortie de données Booléen Aucun Non applicable

    Supprimer le fichier

    Supprime un fichier du serveur FTP.

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

    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?
    CheminDeFichierdistant Chemin d’accès au fichier que vous souhaitez supprimer du File Transfer Protocol serveur. Données dans Chaîne Aucun Oui
    Retour Renvoie la valeur Vrai si le fichier est supprimé, sinon renvoie la valeur Faux. Sortie de données Booléen Non applicable Non applicable

    Dossier de suppression

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

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

    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 d’accès au dossier dans le File Transfer Protocol serveur contenant le nom du dossier. Données dans Chaîne Aucun Oui
    Retour Renvoie la valeur Vrai si le dossier est supprimé, sinon renvoie la valeur Faux. Sortie de données Booléen Non applicable Non applicable

    Fichier de téléchargement

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

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

    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 et le File Transfer Protocol nom du fichier. Données dans Chaîne Aucun Oui
    Fichier local Chemin d’accès dans le lecteur local où le fichier sera téléchargé. Données dans Chaîne Aucun Oui
    TimeOut Heure après laquelle la demande au File Transfer Protocol serveur expire. Données dans Entier Aucun Non
    Retour Renvoie la valeur Vrai si le fichier est téléchargé, sinon renvoie la valeur Faux. Sortie de données Booléen Aucun Non applicable

    Dossier de téléchargement

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

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

    Tableau 6. Paramètres de la 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 d’accès au dossier dans le et nom File Transfer Protocol du dossier. Données dans Chaîne Aucun Oui
    LocalFolderPath (en anglais seulement) Chemin d’accès dans le lecteur local où le dossier sera téléchargé. Données dans Chaîne Aucun Oui
    TimeOut Heure après laquelle la demande au File Transfer Protocol serveur expire. Données dans Entier Aucun Non
    Retour Renvoie la valeur Vrai si le dossier est téléchargé, sinon renvoie la valeur Faux. Sortie de données Booléen Aucun Non applicable

    Obtenir une liste de fichiers

    Renvoie la liste des fichiers d’un dossier sur le File Transfer Protocol serveur.

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

    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 d’accès au dossier dans le et nom File Transfer Protocol du dossier. Données dans Chaîne Aucun Oui
    Retour Renvoie la liste des fichiers du dossier. Sortie de données Chaîne Non applicable Non applicable

    Renommer le fichier

    Renomme un fichier dans le File Transfer Protocol serveur.

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

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

    Renommer le dossier

    Renomme un dossier dans le File Transfer Protocol serveur.

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

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

    Charger un fichier

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

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

    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 du fichier local Chemin d’accès au fichier dans le lecteur local. Données dans Chaîne Aucun Oui
    CheminDeFichierdistant Chemin d’accès à l’emplacement dans le File Transfer Protocol serveur. Données dans Chaîne Aucun Oui
    Retour Renvoie la valeur Vrai si le fichier est chargé, sinon renvoie la valeur Faux. Sortie de données Booléen Non applicable Non applicable

    Charger un dossier

    Charge un dossier du lecteur local vers le File Transfer Protocol serveur.

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

    Tableau 11. Paramètres de la méthode UploadFolder
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire?
    LocalFolderPath (en anglais seulement) Chemin d’accès au dossier dans le lecteur local. Données dans Chaîne Aucun 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 Aucun Oui
    Retour Renvoie la valeur Vrai si le dossier est chargé, sinon renvoie la valeur Faux. Sortie de données Booléen Non applicable Non applicable