This guide contains description of creating SFTP1 file transfer task for SSIS using WinSCP scripting. The preferred approach is to use the WinSCP .NET assembly from SSIS script task .NET code.
WinSCP offers scripting interface that you can use to automate file transfers to/from SFTP server.
Before starting you should:
Start by creating WinSCP script file to transfer your files.
Below you can see a basic script example for downloading file from SFTP server. For details see guide to automation or detailed documentation of scripting functionality. You can also have WinSCP [generate a script template](ui_generateurl#script) for you.
In the script you need at least to:
opencommand with specification of SFTP connection in form
sftp://username:password@hostname/or use name of site.
- Replace host key fingerprint after
opencommand with actual fingerprint of your SFTP/SSH server host key;2
- Replace paths after
getcommand with actual paths to remote file to download from and local directory to download to.
Save the script into file accessible from SSIS.
In SSIS/SSDT, add new Execute Process Task to control flow of your package. In the Execute Process Task Editor:
- Put path to WinSCP executable (by default
C:\Program Files (x86)\WinSCP\WinSCP.exe) into Executable;
- In Arguments specify
/script=<pathtoyourscript>(Alternatively you can specify all commands here using
/commandswitch, as used the command-line template that WinSCP can generate for you);
- You may want to set WorkingDirectory to path, where you want to download files to/upload files from, if you do not use absolute paths in your script.