Méthodes de connecteur FTP

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 5 minutes de lecture
  • Les méthodes de 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.

    Définir la configuration

    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 la méthode SetConfiguration
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire? Notes
    URL URL de l' File Transfer Protocol Données dans Chaîne Aucun Oui
    Nom d\’utilisateur Nom d’utilisateur pour accéder au File Transfer Protocol serveur. Données dans Chaîne Aucun Oui
    Mot de passe Mot de passe pour 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 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? Notes
    Foldername 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. Données sortantes Booléen Aucun Non applicable

    SupprimerFichier

    Supprime un fichier dans 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 la méthode DeleteFile
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire? Notes
    CheminFichierDistant 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 true si le fichier est supprimé, sinon, renvoie la valeur false. Données sortantes Booléen Non applicable Non applicable

    DeleteFolder (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? Notes
    CheminDossierDistant Chemin vers le 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. Données sortantes 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 aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 5. Paramètres de la méthode DownloadFile
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire? Notes
    RemoteFile (Fichier à distance) Chemin d’accès au fichier dans et 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 File Transfer Protocol demande au serveur expire. Données dans Entier Aucun Non
    Retour Renvoie la valeur true si le fichier est téléchargé, sinon, renvoie la valeur false. Données sortantes 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 aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    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? Notes
    CheminDossierDistant Chemin d’accès au dossier dans et File Transfer Protocol nom du dossier. Données dans Chaîne Aucun Oui
    Chemin d’accès du dossier local 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 File Transfer Protocol demande au 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. Données sortantes Booléen Aucun Non applicable

    GetFileList (Obtenir une liste de fichiers)

    Renvoie la liste des fichiers dans un dossier du 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 la méthode GetFileList
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire? Notes
    CheminDossierDistant Chemin d’accès au dossier dans et File Transfer Protocol nom du dossier. Données dans Chaîne Aucun Oui
    Retour Renvoie la liste des fichiers du dossier. Données sortantes Chaîne Non applicable Non applicable

    Renommer le fichier

    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 la méthode RenameFile
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire? Notes
    CheminFichierDistant Chemin d’accès au fichier dans le File Transfer Protocol serveur et nom du fichier. Données dans Chaîne Aucun Oui
    NouveauNomdeFichier 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 True si le nom du fichier est modifié, sinon, la valeur renvoie la valeur False. Données sortantes Booléen Non applicable Non applicable

    RenommerDossier

    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 la méthode RenameFolder
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire? Notes
    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
    NouveauNomduDossier 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, la valeur Faux. Données sortantes 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 aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    Tableau 10. Paramètres de la méthode UploadFile
    Paramètre Description Type de port de données Type de données Valeur par défaut Obligatoire? Notes
    Chemin d’accès au fichier local Chemin d’accès au fichier dans le lecteur local. Données dans Chaîne Aucun Oui
    CheminFichierDistant Chemin d’accès à l’emplacement dans le File Transfer Protocol serveur. Données dans Chaîne Aucun Oui
    Retour Renvoie la valeur true si le fichier est chargé, sinon, renvoie la valeur false. Données sortantes 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 aux paramètres, reportez-vous à la section Configurer les propriétés du port.

    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? Notes
    Chemin d’accès du dossier local Chemin vers le dossier dans le lecteur local. Données dans Chaîne Aucun Oui
    CheminDossierDistant 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. Données sortantes Booléen Non applicable Non applicable