Secure FTP

Parent Previous Next


Secure FTP Task


The "Secure FTP Task" allows the user to interact with a secure FTP server. See the Secure FTP Connection Manager page to learn more about setting up the connection manager.



  Task Settings

o   What will this task do? - Choose what the task will do.

  Upload file to server

  Download file from server

  Create directory on server

  Delete directory on server

  Delete file on server

  Upload directory to server

  Download directory from server

  Check if files exists on server

  Get list of files

  Rename file

  Delete directory files on server

o   Stop package on failure? - This will fail the package if the selected action fails to complete successfully.

 Local Directory or File Settings

o  Local path store in a variable? - Choose if the path is in a variable, selecting this will change the "Local Connection Manager" drop down to "Select Variable"

o  Local connection manager - Available if "Local path stored in a variable" is not selected. Choose or create a connection manager.

o  File Filter - Use for "Upload directory to server" task. Using the * symbol you can specify different filters, for example to only upload XML files you would use " *.xml ".

o  Include Subdirectories - Choose whether or not to include subdirectories for this task.

o  Overwrite local file(s)? - This will allow the task to overwrite the files if they already exist.

 Remote Connection and Directory or File Settings

o  SFP Connection Manager - Select an existing or create a new SFTP Connection Manager.

o  Remote path stored in a variable? - Selecting this option will change the "Directory on server to upload file:" drop down context to <select variable>.

o  Directory on server to upload file - Depending on what action is selected, this option is used to define the directory or file to be used on the remote server to complete the selected action.

o  File Filter - This option is used to define a filter when using the "Download directory from server" option.

o  New name of file on server - (enables when Upload file to server option is selected) Users can create or rename the destination file. Best practice is to include the file's extension. (Example: Source file UploadThisFile.txt can be renamed to the destination server as SameFileWithDifferentName.txt)

o  Select Result Variable - To use this action you must select a variable to contain the result of the file check. Once the SFTP Task completes, the selected variable will contain the result.

o  Include Subdirectories - Choose whether or not to include subdirectories for this task.

o  Overwrite local file(s)? - This will allow the task to overwrite the files if they already exist.


Important Note

When configuring the component to rename a file, the "New File Name" must include the path. (E.g. renaming a file in the documents folder is configured "/Documents/RenamedFile.ext")