Task Factory Secure FTP

Connection Manager

Secure FTP Connection Manager

The SFTP Connection Manager is used to create a connection manager with an SFTP site. Used with Secure FTP Task.

General Tab

Task Factory SFTP Connection Settings General tab

OptionDescription
Connection TypeThere are three types of connection types that are supported:

  • SSH FTP
  • Explicit SFTP
  • Implicit SFTP
HostThe IP Address or URL of the FTP server.
PortThe port used for the FTP server.
User nameThe user name used to login to the FTP server.
AuthenticateSelect how you authenticate the connection.

  • By Password
  • By Key File
PasswordThis option is available if By Password is selected in the Authenticate section.
Key FileAvailable if By Key File is selected in the Authenticate section. You can use the file browser to locate the file.
PassphraseAvailable if By Key File is selected in the Authenticate section.
Timeout (secs)The number of seconds before the application stops trying to make a connection if it cannot connect.
Test Connection buttonUse this button to test whether a connection can be made using the settings in the General and Advanced tab.

Advanced Tab

Task Factory SFTP Connection Settings Advanced tab

OptionsDescription
Default Remote DirectoryThe default remote directory tells the connection to change directories on the FTP server for each connection made to the server. You must use backslashes to define the directory.
Transfer Buffer Size (bytes)Specify the buffer size.
 SSL VersionSelect the SSL version

  • AutoDetect
  • SSL3
  • TLS1
  • TLS1 1
  • TLS1 2
Use binary transferSelecting this option switches the mode of transfer from Ascii to Binary. Select this option if you are primarily working with non-text files.
 
Note:  Use binary transfer is only applicable to legacy connections.
Use passive modeUnselecting this option switches to active mode.
Ignore server IPUse when the server is sending back incorrect IP addresses.
Reuse Connection Across All TasksSelect this to make the connection reusable for all tasks.

Proxy Tab

Task Factory SFTP Connection Settings Proxy tab

OptionDescription
Use ProxySelecting this allows the use of a proxy, to use the proxy you must fill in the information below the check box.
Secure FTP Control Flow Task

Secure FTP Task

Task IconTask Description
Task Factory Secure FTP Task IconThe Secure FTP Task allows the user to interact with a secure FTP server. See the Secure FTP Connection Manager to learn more about setting up the connection manager.

Task Factory Secure FTP Task

Task Settings

OptionDescription
What will this task do?Choose what the task does:

  • 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
Stop package on failure?This fails the package if the selected action fails to complete successfully.

Local Directory or File Settings

OptionDescription
Local path store in a variable?Choose if the path is in a variable, selecting this changes the Local Connection Manager drop down to Select Variable.
Local connection managerAvailable if Local path stored in a variable is not selected. Choose or create a connection manager.
File FilterUse for Upload directory to server task. By using the symbol you can specify different filters.

For example to only upload XML files you would use  *.xml .
Include SubdirectoriesChoose whether or not to include subdirectories for this task.
Overwrite local file(s)?This allows the task to overwrite the files if they already exist.

Remote Connection and Directory or File Settings

Important:   When configuring the component to rename a file, the New File Name must include the path. For example, renaming a file in the documents folder is configured /Documents/RenamedFile.ext.

OptionDescription
SFP Connection ManagerSelect an existing or create a new SFTP Connection Manager.
Remote path stored in a variable?Selecting this option changes the Directory on server to upload file: drop down context to <select variable>.
Directory on server to upload fileDepending 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.
File FilterThis option is used to define a filter when using the Download directory from server option.
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
Select Result VariableTo use this action you must select a variable to contain the result of the file check. Once the SFTP Task completes, the selected variable contains the result.
Include SubdirectoriesChoose whether or not to include subdirectories for this task.
Overwrite local file(s)?This allows the task to overwrite the files if they already exist.
Video Tutorials

Configure an SFTP Task In Under One Minute

Read Metadata From an SFTP Task Using a Script Task

SFTP Upload Using A File Filter 

SFTP Get Files With Metadata

SFTP Download Files Using File Filter