SSIS Script Task

The SSIS Script Task allows one to implement functions that are not available or possible in the toolbox (both in built-in Tasks and transformations). The script task utilizes the Microsoft VSTA (Visual Studio Tools for Applications) as the code environment where you can write the C# or VB code.

TIP: SSIS Script Task VSTA provides all the standard futures available in the general Visual Studio Environment.

SSIS Script Task Send Email

Drag and drop the Script Task from the toolbox into the Control Flow region

Drag Data Flow Task to Control Flow Region 1

Before we start configuring the SSIS Script task, let us create four variables. To create a variable, right-click on the control flow region, and it will open the context menu to select the variable option. Once you choose the variable option, it will open a new window called Variables to create the new variable.

Here you can create n variables.

  • EmailFrom: Please specify the Email ID from which you want to send the Email.
  • EmailTo: Please specify the Email ID to whom you want to send the Email.
  • EmailSubject: Please specify the Subject you want to include
  • EmailBody: Please specify the Message. It can be Plain Text or HTML Message
Script Task in SSIS 2

Double click on the SSIS Script task will open the following editor to configure the components

  • EntryPoint: Please specify the Method name that the SSIS run-time calls as the entry point. The method name you specify here must be in ScriptMain class. Remember, you can change the name as per your requirement, and when you change it, you have to change it in ScriptMain class
Open Editor 3

SSIS Script Task General tab

Please click on the General tab to change the default Name and Description.

  • Name: Please provide the Unique Name
  • Description: Briefly describe the Script Task Functionality. It is always a good practice to provide a valid description.
Add name and Description under General tab 4

ScriptLanguage: Microsoft provides two of its popular languages: Visual Basic (VB) and C#, to use. I am very much familiar with C#, so we selected C# as the language.

Choose C# or Visual Basic Language 5
  • ReadOnlyVariables: Please select the variables you want to use in the SSIS Script Task, which may be user-defined or System default variables. Remember, variables selected as ReadOnlyVariables are used for the Read-only purpose (we can’t alter them)
  • ReadWriteVariables: Please select the variables you want to use in this task, which may be user-defined or System default variables. Remember, variables selected as ReadWriteVariables can alter according to our requirement.

Please click on the Eclipse (…) button ReadOnlyVariables option to select the variables.

Script Task in SSIS 6

Once you click on the Eclipse (…) button, the Select the Variables window will open. Please select the previously created variables.

Choose the Variables 7

Add C# code in SSIS Script Task.

Once you have selected the required variable, please click on the Edit Script.. button to write the actual C# Script

Script Task in SSIS 8

Once you click on the Edit Task, SSIS will open the ScriptMain.cs class file to write the C# script.

To send an email from C#, we need to add two references or import references called: using System.Net; and using System.Net.Mail;

TIP: If you are a VB developer, then it should be something like ScriptMain.vb

C# Code 9

Next, within the Main() function, add your Code. Remember, if your code is long or robust, try to divide the code by creating methods

Send Email using C# Code 10

C# code we used for this Script Task in the above screenshot is:

// C# code
String SendMailFrom = Dts.Variables["EmailFrom"].Value.ToString();
String SendMailTo = Dts.Variables["EmailTo"].Value.ToString();
String SendMailSubject = Dts.Variables["EmailSubject"].Value.ToString();
String SendMailBody = Dts.Variables["EmailBody"].Value.ToString();

try
  {
     MailMessage email = new MailMessage();
     SmtpClient SmtpServer = new SmtpClient("smtp.gmail.com");
     // START
     email.From = new MailAddress(SendMailFrom);
     email.To.Add(SendMailTo);
     email.Subject = SendMailSubject;
     email.Body = SendMailBody;
     //END

     SmtpServer.Port = 587;
     SmtpServer.Credentials = new System.Net.NetworkCredential(SendMailFrom, "your password");
     SmtpServer.EnableSsl = true;

     SmtpServer.Send(email);
     MessageBox.Show("Email was Successfully Sent ");
  }
catch (Exception ex)
  {
      MessageBox.Show(ex.ToString());
  }
Dts.TaskResult = (int)ScriptResults.Success;

If you forgot to create Variables (or if you find it difficult to create variables), then you can remove the first four lines of code and replace the code between //Start… END with the below-shown code

// Example
email.From = new MailAddress("xxxxxxxxxxxx@gmail.com");
email.To.Add("xxxxxxxxxxxxxy@gmail.com");
email.Subject = "Test Mail";
email.Body = "This Email is coming from SSIS Script Task";

Once you have finished editing it, Please close the ScriptMain.cs file and Script Task Editor. Let us run the package.

SSIS Script Task 11

From the above screenshot, you can observe that Script Task is successful, and we got the message box saying that the Email was Successfully sent. Let me open my Gmail.

Gmail 12

From the above screenshot, you can see that we got the Email with the specified message.

Points to Remember :

  • If you want to send an email to your Manager (or to yourself) after every Data Load, then you can use this SSIS Script task along with the Data Flow Task.
  • Always use the Variables for storing Emails, Passwords, Subjects, or SMTP credentials.
  • If there is an Error stating Secure Connection, then Go To Less Secure Apps in your Gmail account settings and Turn on the Access for Less Secure Apps option.

Comments are closed.