Skip to main content

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.

Labels:

Comments

Post a Comment

Popular posts from this blog

Data type precedence - SQL Server

       In SQL Server, data type precedence determines which data type takes precedence over others when two or more data types are combined or compared. It is important to understand data type precedence to ensure that the correct data type is used and that data is not lost or truncated during operations. In this blog, we will discuss data type precedence in SQL Server with examples. Data type precedence levels SQL Server has 16 data type precedence levels, with the highest level being 1 and the lowest level being 16. The data type with the lowest precedence is considered to be the "weakest" data type and is most likely to be converted to a higher precedence data type during operations. Here is the list of data types in SQL Server, ordered by their precedence levels: user-defined data types (highest precedence) sql_variant xml datetimeoffset datetime2 datetime smalldatetime date time float real decimal/numeric money/smallmoney bigint/i...
Post a Comment
Read more

Synonyms, Trigger & Sequences - SQL Server

  Synonyms In SQL Server, a synonym is an alternative name for a database object, such as a table, view, stored procedure, or function. Synonyms can be useful for simplifying complex object names, abstracting the underlying object structure, or providing a layer of indirection between objects and their callers. Creating a synonym in SQL Server is straightforward. Here's an example:               CREATE SYNONYM MyTable FOR AdventureWorks2019 . dbo . MyTable ; In this example, we're creating a synonym called MyTable that points to a table called MyTable in the AdventureWorks2019 database. Now, instead of referring to the table as AdventureWorks2019.dbo.MyTable, we can simply use the synonym name MyTable. To modify a synonym in SQL Server, you can use the ALTER SYNONYM statement. Here's an example:               ALTER SYNONYM MyTable RENA...
Post a Comment
Read more

Table Data Type- SQL Server

       In SQL Server, the table data type is a structured data type that allows you to define a table as a variable. It can be useful in scenarios where you need to store data temporarily or pass data between stored procedures or functions. In this blog, we will explore the table data type in SQL Server and provide an example of how it can be used. Introduction to the table data type The table data type is a structured data type that allows you to define a table as a variable. It can be used to store data temporarily or pass data between stored procedures or functions. The table variable behaves like a regular table in SQL Server, but it is stored in memory rather than on disk. Creating a table variable in SQL Server To create a table variable in SQL Server, you need to declare the variable and define the table structure. The following code demonstrates how to declare a table variable and define the table structure: DECLARE @MyTable TABLE (   ...
Post a Comment
Read more