SSIS Script Component as Source

The Script Component is one of the most important, and powerful item in SQL Server Integration Services. We can use this component as a Source, Destination, and Transformation. In this article we will show you, How to use the SSIS Script Component as Source with practical example.

You can also look into following links:

• SSIS Script Component as Transformation
• SSIS Script Component as Destination

Configuring SSIS Script Component as Source

STEP 1: Drag and drop the Data Flow Task from toolbox to control flow region, and rename it as the SSIS Script Component as Source.

Double click on it and it will open the data flow tab.

STEP 2: Drag and drop Script Component from SSIS toolbox to data flow region. Once you drop the Script component on data flow region, a new pop up window called Select Script Content Type will be opened as shown below. In this example we want to demonstrate about the script component as a source so, we are selecting the Source option

STEP 3: Double click on the Script component will open the following editor to configure the properties. Though there are many properties, we will explore few important properties that we use in our daily coding

• Name: Please provide the Unique Name
• Description: Briefly describe the Script Functionality. It is always a good practice to provide the valid description.
• ReadOnlyVariables: Please select the variables that you want to use in the Script, and they may be user defined variables or System default variables. Remember, variables selected as ReadOnlyVariables are used for Read-only purpose (we can’t alter them)
• ReadWriteVariables: Please select the variables you want to use in the Script. Remember, variables selected as ReadWriteVariables can be altered according to our requirement

STEP 4: Within the Input and Outputs tab, Go to Output Columns, and under output columns we are going add these columns: ID, Name, Country using Add Column button

First we added the Country Column, and then changed the Data type from Integer (default) to string [DT_STR]

Similarly, we added the remaining columns. Remember, you can use the Name property to change the Column names as per your requirement.

Next, we are changing the Output name to Myoutput using the Name property. It is not mandatory to change so, it is up to you

STEP 5: Within the Script tab, please click on the Edit Script.. button to write the actual C# Script

TIP: You can change the language to VB.Net using ScriptLanguage property.

Once you click on the Edit Script, it will open the main.cs class file to write the C# code. In order to send some code we have to write our custom code inside the CreateNewOutputRows() function

STEP 6: Add your custom C# code here. For this example, we declared two string arrays, and then we used the for loop to assign each array element to individual row.

Code that we used in the above screenshot is:

C# CODE

public override void CreateNewOutputRows()
 {
   /*
      Add rows by calling the AddRow method on the member variable named "<Output Name>Buffer".
      For example, call MyOutputBuffer.AddRow() if your output was named "MyOutput".
   */
   //int[] Identity = new int[] { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
   
   // Creating String array holding the Country Names 
   string[] CountryNames = new string[] { "India", "USA", "China", "UK", "Canada", 
                                         "Australia", "Japan", "Russia", "South Africa", "Brazil"};
   // Creating String array holding the Names
   string[] CustomerNames = new string[] { "Tutorial", "Gateway", "Yong", "John", 
                                           "Dave", "David", "Xing", "Mike", "Joseph", "Ronaldo"};

   for (int i = 0; i < CountryNames.Length; i++)
   {
      /* Myoutput is the Name that we given in Script component.
         Please provide the name that you see, or assigned in Script Component
      */
      MyoutputBuffer.AddRow();
      MyoutputBuffer.ID = i; // Identity[i];
      MyoutputBuffer.Country = CountryNames[i];
      MyoutputBuffer.Name = CustomerNames[i];
   }
 }

STEP 7: Once you finished editing the Script, Please close the main.cs file. Next, drag and drop OLE DB Destinations on to the data flow region, and then drag the script component Output Arrow to this new OLE DB Destination

STEP 8: Double click on OLE DB Destination will open the OLE DB Destination Editor.

STEP 9: Select the OLE DB Connection manager that you already created (if not, create new one using New button). Here we are selecting the [SSIS Script Component as Source] table present in the [SSIS Tutorials] Database.

STEP 10: Click on Mappings tab to check whether the source columns are exactly mapped to the destination columns.

Click OK to finish creating our Package.

STEP 11: Right click on the SSIS Script Component as Source Package in the Solution Explorer, and select Execute Package.

From the above screenshot you can observe that our Package has executed successfully. Let’s open the SQL Server Management Studio and write the following query to view the data

T-SQL

USE [SSIS Tutorials]
GO

SELECT [ID]
      ,[Name]
      ,[Country]
  FROM [SSIS Script Component as Source]

OUTPUT

Thank you for Visiting Our Blog