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. It is used with the Secure FTP task.

General Tab

Task Factory Secure FTP Connection Manager General By Password
General - By Password

Task Factory Secure FTP Connection Manager General By Key File
General - By Key File
OptionDescription
Connection TypeThere are five connection types that are supported:

  • SFTP - SSH FTP (Note:  This supports SSH2)
  • FTPS - FTP over implicit TLS or SSL
  • FTPES - FTP over explicit TLS or SSL
  • FTP

Important:  The SFTP - SSH FTP, FTPS - FTP over implicit TLS or SSL, FTPES - FTP over explicit TLS or SSL, and FTP connection types use the Chilkat connection service.

Additional Information: For more information about the Chilkat connection service, see Chilkat.

  • SFTP - SSH FTP Legacy 

Important:  The SSH FTP Legacy connection type uses the edtFTPnet/PRO connection services. Use this connection type if you are using a version of Task Factory from 2017 or older.

Additional Information: For more information about the edtFTPnet/PRO connection service, see edtFTPnet/PRO.

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 file.

Note:  Use binary transfer is only applicable to legacy connections.
Use passive modeDeselecting 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.

Configuring the SFTP Connection Manager

To configure the Task Factory SFTP connection manager in your Visual Studio Package, complete the following steps:

Note:  This example uses the free demo SFTP servers that can be found on Free Public SFTP Servers.

1. Create a new, or open an existing, Visual Studio Integration Services project.

Task Factory New BIDS project
Task Factory Open existing BIDS project

2. Right Click the Connection Managers pane, and then select New Connection to open the Add SSIS Connection Manager window.

Task Factory New Connection

3. Select the Task Factory SFTP Connection, then select Add to open the TF-SFTP Connection Settings configuration window.

Task Factory Add SFTP Connection Manager

4. Select your Connection Type from the drop down list. Enter your connection's Host address and port number in the appropriate fields. 

Task Factory SFTP Connection Settings Connection Type
Task Factory SFTP Connection Settings Host information

5. Enter the User name and Password associated with your connection, then select Test Connection to ensure that you can connect successfully to your SFTP server.

Task Factory SFTP Connection Settings enter Username and Password
Task Factory SFTP Connection Settings Test Connection

Note:  A Connected Successfully message prompt displays if your connection was successful. Select OK to close the prompt.

Task Factory SFTP Connection Settings Connected Successfully prompt

6. Select OK to save your TF SFTP connection manager.

Task Factory SFTP Connection Settings Ok

Note:  For more information about Advanced Settings, or using a Proxy for your connection, see the Advanced Settings, and Proxy sections of this article.

Secure FTP Task

Secure FTP Task

Task IconTask Description
Task Factory Secure FTP Task IconThe Secure FTP Task interacts with a secure FTP server. See the Secure FTP Connection Manager tab 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:
OptionDescription

Upload file to server

Uploads a selected file to your desired server connection.
Download file from serverDownloads a selected file from your desired server connection.

For a detailed example on configuring the Download file from sever action in the Secure FTP task to download a list of files from an SFTP server, see the following support article: SFTP Task Download list of files from SFTP Server.
Create directory on serverCreates a directory on the desired server connection.
Delete directory on serverDeletes the directory on the desired server connection.

Note:  You must delete all the files in the selected directory before that directory can be deleted with the Secure FTP Task.
Delete file on serverDeletes a selected file on the desired server connection.
Upload directory to serverUploads a selected directory to the desired server connection.
Download directory from serverDownloads the selected directory from the desired server connection.
Check if files exists on serverSearches for a selected file on the desired server connection.
Get list of filesRetrieves a list of files with metadata from the desired server connection.

Additional Information: You can configure the Get list of files action in the Secure FTP task to retrieve a desired file type from a specified directory. For a detailed example on configuring the Get list of files action, see the following support article: Secure FTP Task - Get List of Files with Metadata.  
Rename fileRenames the selected file on the desired server connection.

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.
Delete directory files on serverDeletes the directory files from a selected directory on the desired server connection.
Stop package on failure?This fails the package if the selected action fails to complete successfully.

Note:  This option is selected by default.

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 sub-directories 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 serverEnabled 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 remote file(s)?This allows the task to overwrite the files if they already exist.

Configuring a Secure FTP Task

Note:  You need to configure an SFTP connection manager for your Secure FTP Task. For more information about configuring an SFTP Connection Manger, go to the Connection Manager tab.

To configure a Secure FTP Task in your BIDS package, complete the following steps:

1. Create a new, or open an existing, Visual Studio Integration Services project.

Task Factory New BIDS project
Task Factory Open existing BIDS project

2. Configure your TF SFTP Connection Manager

Task Factory SFTP Connection Manager configured

Note:  For information about configuring an SFTP Connection Manager, see the Connection Manager tab.

3. Drag the TF Secure FTP Task component into your package Control Flow. Select the task, then select Edit to begin configuring the task properties.

Task Factory Secure FTP Task Edit properties

4. Select what you want the task to do from the What will this task do drop-down list. Task Factory Secure FTP Task What will this task do

Note:  For a detailed list of actions this task can take, see Task Settings table in above.

Important:  Your selection will change the configurable task options.

5. Select the connection manager for the task from the applicable drop-down list, and then enter your specifications for the remaining applicable settings.

Task Factory Secure FTP Task Connection Manager
Task Factory Secure FTP Task finish configuration

6. Select OK to finish configuring your Task Factory Secure FTP Task.Task Factory Secure FTP Task select Ok

Note:  For more specific Task Factory Secure FTP Task tutorials, see the Video Tutorials tab.

Troubleshooting

Troubleshooting

Warning:  You must use the same version of Task Factory across all your environments (dev, production, qa, etc.) to ensure optimal performance of Task Factory components.

Additional Information: If you are encountering any issues with the Secure FTP Connection Manager, or Secure FTP Task, you can begin Creating a log file to help identify the problems you're having. 

Important:  If your organization has changed any of the ciphers, or algorithms within your packages, you may need to upgrade your version of Task Factory. If you aren't fully committed to an upgrade, or want to test an upgrade first, see Testing the upgrade.

Video Tutorials

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