SFTP Integration in SSIS package Using WinSCP DLL

 

In this blog, I am planning to write about SSIS SFTP Task details and reference sites, upload and download the files from SFTP server using SSIS package with help of the winscp library.

Steps to configure the winscp DLL and Download Files

1.       Please download the DLL and required files from below path

https://winscp.net/eng/downloads.php#additional

2.       Once Downloaded, use the below comments to add in Local GAC

"Path to the gacutil exe \gacutil.exe" /i WinSCPnet.dll

3.       Please use the below URL as guide to implement the SSIS script task to download the files from SFTP using winscp as library

https://winscp.net/eng/docs/library_ssis

4.       I am just briefing the steps based on the above URL what we can try in SSIS package.

5.       Please create the below variables in SSIS package which we need to pass into the Script Task as a variable

·       Host Name

·       SFTP Username

·       SFTP Password

·       SFTP Source Path – From where we need to download the files

·       Destination Path – To which location we need to transfer the file

·       Winscp Executable Path – Download winscp execution path

6.       Please add script Task and click edit.

7.       Once Added the variables in Read Write Variables. Please click Edit to edit Script the C# code.

 

 

8.    Please add the reference for the DLL by right clicking the reference section solution explorer. 

Please browse the DLL path download in step one and add it in reference.

9.       Once added we have ready to add the code for move the files.

public void Main()

        {

            // Setup session options

            string HostName = (string)Dts.Variables["User::HostName"].Value;

            string UserName = (string)Dts.Variables["User::UserName"].Value;

            string Password = (string)Dts.Variables["User::Password"].Value;

            string SSHPath = (string)Dts.Variables["User::SSHPath"].Value;

            if (SSHPath == null) {

                SSHPath = String.Empty;

            }

           

            //User::DestinationPath,User::HostName,User::Password,User::SourcePath,User::SSHPath,User::UserName

            MessageBox.Show("Please FinD the Host Name"+HostName+"_"+ UserName+"_"+Password+"_"+SSHPath);

            SessionOptions sessionOptions = new SessionOptions

            {

                Protocol = Protocol.Sftp,

                // To setup these variables, go to SSIS > Variables.

                // To make them accessible from the script task, in the context menu of the

                // task, choose Edit. On the Script task editor on Script page,

                // select ReadOnlyVariables, and tick the below properties.

                HostName = HostName,

                UserName = UserName,

                Password = Password

               

            };

            sessionOptions.SshHostKeyPolicy = SshHostKeyPolicy.GiveUpSecurityAndAcceptAny;

       

            try

            {

                using (Session session = new Session())

                {

                    // If WinSCP .NET assembly has been stored in GAC to be used with SSIS,

                    // you need to set path to WinSCP.exe explicitly.

                    // This is not needed if you have subscribed AppDomain.AssemblyResolve event

                    // and the WinSCP.exe is in the same location as WinSCPnet.dll.

                    string ExecutablePath= (string)Dts.Variables["User::WinscpExecutablesPath"].Value;

                    session.ExecutablePath = (string)Dts.Variables["User::WinscpExecutablesPath"].Value;

                    string destinationFilePath= (string)Dts.Variables["User::DestinationPath"].Value;

                    string sourceFilePath= (string)Dts.Variables["User::SourcePath"].Value;

                    MessageBox.Show("Please FinD the Host Name 3" + ExecutablePath+"_"+destinationFilePath+sourceFilePath);

                    // Connect

                    session.Open(sessionOptions);

 

                    // Upload files

                    TransferOptions transferOptions = new TransferOptions();

                    transferOptions.TransferMode = TransferMode.Binary;

 

                    /* TransferOperationResult transferResult = session.PutFiles(

                         destinationFilePath, sourceFilePath, false, transferOptions);

                    */

 

                    TransferOperationResult transferResult = session.GetFiles(sourceFilePath, destinationFilePath, false, transferOptions);

 

                    // Throw on any error

                    transferResult.Check();

 

                    // Print results

                    bool fireAgain = false;

                    foreach (TransferEventArgs transfer in transferResult.Transfers)

                    {

                        Dts.Events.FireInformation(0, null,

                            string.Format("Upload of {0} succeeded", transfer.FileName),

                            null, 0, ref fireAgain);

                    }

                }

 

                Dts.TaskResult = (int)DTSExecResult.Success;

            }

            catch (Exception e)

            {

                Dts.Events.FireError(0, null,

                    string.Format("Error when using WinSCP to upload files: {0}", e),

                    null, 0);

 

                Dts.TaskResult = (int)DTSExecResult.Failure;

            }

        }

10.   Please use the above code in Visual studio editor and save the details. Please run and check.