Creating a configuration system for SSIS

Do you have a complicated SSIS package that has steps which include configuration where things could change? File locations or rundates that need to be updated regularly and often face a whole world of pain when the infrastructure team adjust something because then you have to update every config reference in your package?

Let’s have a look at how we can use SQL Server to hold the configuration for us and SSIS bring it out at run time.

Note: An assumption has been made that you know how to create a Connection Manager to point to your new database.

First we are going to need a database, if you already have a database where configuration is kept use that otherwise, let’s create one;


Next let’s create some tables in this database to hold our config

CREATE TABLE dbo.Package
	PackageName varchar(100),
	Description varchar(100),

We are going to need a primary key on this table so let’s add that next

Column NameColumn Description
PackageIDUniqueIdentifier of the row in this table, also the primary key
PackageNameThe name of the package as it is in SSIS
PackageGUIDThe Package GUID from SSIS
DescriptionA short description of the package
ActiveIf this package configuration is enabled

Now we need a table to store the configuration for this package, because each package can have multiple configurations we are going to create a new table to hold that information

CREATE TABLE dbo.PackageConfig
	[PackageID] INT NOT NULL,
	[ConfigName] varchar(50) NOT NULL
	[ConfigValue] varchar(50),
	[Active] BIT DEFAULT 1

A foreign key is also needed as we only want configurations to be added for packages that exist

ALTER TABLE dbo.PackageConfig ADD CONSTRAINT FK_PackageConfig_PackageID FOREIGN KEY (PackageID) REFERENCES [dbo].[Package] (PackageID);
Column NameColumn Description
PackageIDReference to the package in dbo.Package
ConfigNameThe name of the configuration item
ConfigValueThe value of the configuration item
ActiveIs the configuration item enabled or not

Now that we have the configuration tables set up in SQL, we need to add the logic to get the configuration from SSIS, at the end we should have something that looks like this

Let’s break this down.


First, we need a couple of variables to store the configuration we receive from SQL

Variable NameVariable Data TypeVariable Description
ConfigNameStringThe name of the configuration item in SQL prefixed with Confg_
ConfigValueStringThe value of the configuration item
ConfigurationsSystem.ObjectAn object to store the results from the query

Get Config

Bring an Execute SQL Task event onto the canvas and double click it

Once open set the result set to Full Result Set because we want to store the results from the query into the Configurations variable object we created earlier.

Click in the SQL Statement box and add the following code



FROM PackageConfig PC 

	ON PC.PackageID = P.PackageID
	p.PackageGUID = ? AND pc.Active = 1

The question mark in the SQL query above will take the value from the Parameter mapping which we will setup in a moment.

Now click Result set from the left hand side of the window

In the ResultName type a name for the results “Configurations” works, then select the Configurations variable we created before.

Click Parameter Mappings from the sidebar

Click Add, and add in the System::PackageID as shown below

Once that is all done, click OK.

Clear Config Values

Bring a script task onto the canvas and double click it

Click the Edit Script button

Inside the Main method we need to put the following code, this is going to clear any of the configuration items so they are ready for use in the event they had already been populated.

Variables pkgVars = Dts.Variables;

foreach(Variable pkgVar in pkgVars)
	string varval = pkgVar.QualifiedName.ToString();
		pkgVar.Value = string.Empty;

In the read write variables box add;

  • User::ConfigName
  • User::ConfigValue
  • User::Configurations

Click OK once that is done.

Set Config Values

Drag a Foreach loop container onto the canvas and double click it

Set the Enumerator to Foreach ADO Enumerator in the ADO object source variable drop down select User::Configurations and make sure Rows in first table is selected

Click the variable mappings from the side bar

Add the following variables

Once done, click OK.

Now that the Foreach loop is setup, drag a script task inside it and name it Set Config

Once it is there, double click it and click Edit Script

In the main method, add the following code, this code is going to set our configuration items

string configName = Dts.Variables["User::ConfigName"].Value.ToString();
string configValue = Dts.Variables["User::ConfigValue"].Value.ToString();

if(Dts.Variables.Contains("confg_" + configName))
	Dts.Variables["User::confg_" + configName].Value = configValue;

Adding a package to SQL

Right click on the SSIS canvas in an empty space and select properties, this should open a new pane which looks like this;

Copy the ID without the { } we need that in a moment.

INSERT INTO dbo.Package ([PackageName],[PackageGUID],[Description])
('Your Package Name','The Package GUID we selected above','A Description)

Adding Configuration Items

Now we want to add the configuration items that are going to be used by this SSIS package, we can do this first in SQL by inserting values into the PackageConfig table like this;

INSERT INTO dbo.PackageConfig (PackageID, ConfigName, ConfigValue)

PackageID will be the ID of the package you are setting the configuration for, this is obtained from dbo.Package.

Now that we have created a value in PackageConfig called rundate we need to add that into SSIS.

All configuration items that are obtained from SQL are prefixed with Confg_ but you don’t need to add the prefix to the ConfigName in SQL itself.

Now we just need to add the new configurations to the Clear Configuration block & Set Configuration blocks.

The Clear configuration block should now look like this;

This Set Configuration Block should now look like this;