Creating a Meta Data Driven SSIS Solution with Biml – 5. Creating the Master Package

In this last post in a series of 5 on creating a meta data driven ssis solution I”m going to create the master package. The master package will start the other table packages in the right order.

10. Deploy the Table Packages

Before you’ll create the master package publish the packages to sql server:

  • In the Solution Explorer (BIDS) right click the project and select Properties from the context menu.
  • Select Deploy under Configuration Properties in the treeview.
  • Change the DeploymentType to SqlServerDestination and the DestinationServer to localhost.
Project property Pages
  • In the Solution Explorer (BIDS) right click the project and select Deploy from the context menu.
The Master Package

I will group the Execute Package Tasks in Sequence Containers that correspond with the PackageGroup in the SsisPacakges Table.

Final result will look like this:

Masterpackage
The Biml script

The Biml Script uses two connection: one to the meta database and one to the MSDB database where the packages are stored. And before we loop through the rows in the SsisPackages table and create the tasks I will use Package Configurations to handle future deployment issues. To create this package I’ll use the following script:

<#@ template language=”C#” hostspecific=”true”#>
<#@ import namespace=”System.Data” #>
<Biml xmlns=”http://schemas.varigence.com/biml.xsd”>
      <Connections>
            <OleDbConnection Name=”metaDB”
                                   ConnectionString=”Data Source=.;Initial Catalog=MyDwh_meta;Provider=SQLNCLI10.1;Integrated Security=SSPI;”
                                   CreatePackageConfiguration=”true”></OleDbConnection>
            <OleDbConnection Name=”msdb”
                                   ConnectionString=”Data Source=.;Initial Catalog=msdb;Provider=SQLNCLI10.1;Integrated Security=SSPI;”
                                   CreatePackageConfiguration=”true”></OleDbConnection>
      </Connections>
      <Packages>
            <Package Name=”MasterPackage MyDwh” ConstraintMode=”Linear” AutoCreateConfigurationsType=”None”>
                  <!–Package Configurations–>
                  <PackageConfigurations>
                        <PackageConfiguration Name=”MetaDB” >
                             <EnvironmentVariableInput EnvironmentVariable=”Northwind_Config”></EnvironmentVariableInput>
                             <ConfigurationValues>
                                   <ConfigurationValue DataType=”String”
                                                                 PropertyPath=”\Package.Connections[metaDB].Properties[ConnectionString]”
                                                                 Name=”metaDB”
                                                                 Value=”Data Source=.;Initial Catalog=ROCWB_MIS_config;Provider=SQLNCLI10.1;Integrated Security=SSPI;”>
                                   </ConfigurationValue>
                             </ConfigurationValues>
                        </PackageConfiguration>
                        <PackageConfiguration Name=”msdb” ConnectionName=”metaDB”>
                             <ExternalTableInput Table=”[dbo].[SsisConfiguration]” />
                        </PackageConfiguration>
                  </PackageConfigurations>
                  <!–Tasks–>
                  <Tasks>
                        <# string sPackageGroup=””; #>
                        <# string IsFirstRow=”True”; #>
                        <# string sConn = “Provider=SQLNCLI10;Server=.;Initial Catalog=MyDwh_meta;Integrated Security=SSPI;”; #>
                        <# string sSQL = “SELECT PackageGroup, PackageName FROM SsisPackages”; #>
                        <# DataTable tblPackages = ExternalDataAccess.GetDataTable(sConn,sSQL); #>
                        <# foreach (DataRow row in tblPackages.Rows){ #>
                        <# if(sPackageGroup!=row[“PackageGroup”].ToString()) { #>
                             <# sPackageGroup=row[“PackageGroup”].ToString();#>
                             <# if(IsFirstRow==”True”) { #>
                                   <# IsFirstRow=”False”; #>
                                   <!–Start new container–>
                                   <Container Name=”SEQC – <#=row[“PackageGroup”]#>” ConstraintMode=”Parallel”>
                                         <Tasks>
                             <# }else { #>
                                   <!–Close container and start new container–>
                                         </Tasks>
                                   </Container>
                                   <Container Name=”SEQC – <#=row[“PackageGroup”]#>” ConstraintMode=”Parallel”>
                                         <Tasks>
                        <# }}#>
                                   <ExecutePackage Name=”EPT – <#=row[“PackageName”]#>”>
                                         <SqlServer ConnectionName=”msdb” PackagePath=”\<#=row[“PackageName”]#>” />
                                   </ExecutePackage>
                        <# }#>     
                             <!–Close container–>
                             </Tasks>
                        </Container>
                  </Tasks>
            </Package>
      </Packages>
</Biml>

11. Final steps: Create the masterpackage
  • In Solution Explorer (BIDS) right click the project and select Add New Biml File
  • Rename the Biml File to Create master package.biml
  • Copy the biml script above to the new biml file
  • In Solution Explorer (BIDS) right click the Create master package.biml file and select Generate SSIS Packages.
Final thoughts

In this series we created a complete SSIS Solution with

  • a logging and lineage method
  • package configurations to easily port the package to another environment (development, test, production)
  • an enforced standard way to import data: (Try Bulk-load, Try any error row RowByRow, and write any remaining errors to an error file)
  • a master package that can start the packages in the correct order

You could easily change this to fit your needs…

Creating a Meta Data Driven SSIS Solution with Biml – 4. Creating the Table Packages

In part 3 of this series I created a Biml file and used it to create the desired SSIS package. In this part I am going to take it one step further: Í will use Biml script to loop through a number of rows in the SsisPackages table and create a package for every row.

Before we start creating the Biml script let’s examine the SsisPackage table we created in part 2 and add some rows to it. The following columns are used in this table:

  • PackageID, a unique number identifying the package
  • PackageType, we will use 1 for this example. If you want to use another template you can use this column. If you have made manual changes to the package change this field into 0. This package won’t be recreated.
  • PackageName, the name of the package
  • PackageGroup, this used to group related packages. e.g.: 1. Staging, 2 Dimensions etc. This will play an important role when we create the master package in part 5.
  • SourceInput, a sql statement that selects the rows in the source database.
  • SourceConnection, the name used as source connection
  • DestinationName, the name of the destination table.
  • DestinationConnection, the name used as destination connection.
  • ErrorFile, the full path and name for the raw error file.
  • TruncateDestination, a flag to indicate if you want to truncate the destination table.

Now, let’s add some rows to this table…

8. Add rows to SsisPackages Table

Execute the following SQL query in Management Studio:

USE [MyDwh_meta]
GO
TRUNCATE TABLE [dbo].[SsisPackages];
INSERT INTO [dbo].[SsisPackages] ([PackageType], [PackageName]
      , [PackageGroup], [SourceInput], [SourceConnection], [DestinationName]
      , [DestinationConnection], [ErrorFile], [TruncateDestination])
SELECT 1, N'Import_Northwind_Categories', N'1 Staging'
      , N'SELECT CategoryID, CategoryName FROM [dbo].[Categories]'
      , N'Northwind', N'[dbo].[Northwind_Categories]', N'stagingDB'
      , N'c:\SSISErrors\Categories.raw', 1
UNION ALL
SELECT 1, N'Import_Northwind_Customers', N'1 Staging'
      , N'SELECT CustomerID, CompanyName, City, Country FROM [dbo].[Customers]'
      , N'Northwind', N'[dbo].[Northwind_Customers]', N'stagingDB'
      , N'c:\SSISErrors\Customers.raw', 1
UNION ALL
SELECT 1, N'Import_Northwind_Employees', N'1 Staging'
      , N'SELECT EmployeeID, LastName, FirstName, Title, ReportsTo FROM [dbo].[Employees]'
      , N'Northwind', N'[dbo].[Northwind_Employees]', N'stagingDB'
      , N'c:\SSISErrors\Employees.raw', 1
UNION ALL
SELECT 1, N'Import_Northwind_OrderDetails', N'1 Staging'
      , N'SELECT OrderID, ProductID, UnitPrice, Quantity, Discount FROM [dbo].[Order Details]'
      , N'Northwind', N'[dbo].[Northwind_OrderDetails]', N'stagingDB'
      , N'c:\SSISErrors\OrderDetails.raw', 1
UNION ALL
SELECT 1, N'Import_Northwind_Orders', N'1 Staging'
      , N'SELECT OrderID, CustomerID, EmployeeID, OrderDate FROM [dbo].[Orders]'
      , N'Northwind', N'[dbo].[Northwind_Orders]', N'stagingDB'
      , N'c:\SSISErrors\Orders.raw', 1
UNION ALL
SELECT 1, N'Import_Northwind_Products', N'1 Staging'
      , N'SELECT ProductID, ProductName, SupplierID, CategoryID FROM [dbo].[Products]'
      , N'Northwind', N'[dbo].[Northwind_Products]', N'stagingDB'
      , N'c:\SSISErrors\Products.raw', 1
UNION ALL
SELECT 1, N'Import_Northwind_Suppliers', N'1 Staging'
      , N'SELECT SupplierID, CompanyName FROM [dbo].[Suppliers]'
      , N'Northwind', N'[dbo].[Northwind_Suppliers]', N'stagingDB'
      , N'c:\SSISErrors\Suppliers.raw', 1
UNION ALL
SELECT 1, N'Import_DimCustomer', N'2 Dimensions'
      , N'SELECT * FROM [dbo].[vwDimCustomer]'
      , N'DWH', N'[dbo].[dimCustomer]', N'DWH'
      , N'c:\SSISErrors\dimCustomer.raw', 1
UNION ALL
SELECT 1, N'Import_DimEmployee', N'2 Dimensions'
      , N'SELECT * FROM [dbo].[vwDimEmployee]'
      , N'DWH', N'[dbo].[dimEmployee]', N'DWH'
      , N'c:\SSISErrors\dimEmployee.raw', 1
UNION ALL
SELECT 1, N'Import_DimProduct', N'2 Dimensions'
      , N'SELECT * FROM [dbo].[vwDimProduct]'
      , N'DWH', N'[dbo].[dimProduct]', N'DWH'
      , N'c:\SSISErrors\dimProduct.raw', 1
UNION ALL
SELECT 1, N'Import_FactOrder', N'3 Fact tables'
      , N'SELECT * FROM [dbo].[vwFactOrder]'
      , N'DWH', N'[dbo].[factOrder]', N'DWH'
      , N'c:\SSISErrors\factOrder.raw', 1;

SELECT * FROM [dbo].[SsisPackages];

You will see the following results:

clip_image001
The Biml code to Create the packages

Next I will implement Biml.script to loop through these rows. Biml script is enclosed in the following tag: <# script #>

I used the xml code created in part 3 and changed it into:

<#@ template language=”C#” hostspecific=”true”#>
<#@ import namespace=”System.Data” #>
<Biml xmlns=”http://schemas.varigence.com/biml.xsd”>
       <Connections>
             <OleDbConnection Name=”metaDB”
                              ConnectionString=”Data Source=.;Initial Catalog=MyDwh_meta;Provider=SQLNCLI10.1;Integrated Security=SSPI;”
                              CreatePackageConfiguration=”true”></OleDbConnection>
             <OleDbConnection Name=”Northwind”
                              ConnectionString=”Data Source=.;Initial Catalog=Northwind;Provider=SQLNCLI10.1;Integrated Security=SSPI;”
                              CreatePackageConfiguration=”true”></OleDbConnection>
             <OleDbConnection Name=”stagingDB”
                              ConnectionString=”Data Source=.;Initial Catalog=MyDwh_st;Provider=SQLNCLI10.1;Integrated Security=SSPI;”
                              CreatePackageConfiguration=”true”></OleDbConnection>
             <OleDbConnection Name=”DWH”
                              ConnectionString=”Data Source=.;Initial Catalog=MyDwh;Provider=SQLNCLI10.1;Integrated Security=SSPI;”
                              CreatePackageConfiguration=”true”></OleDbConnection>
       </Connections>
     <Packages>
<# string sConn = “Provider=SQLNCLI10;Server=.;Initial Catalog=MyDwh_meta;Integrated Security=SSPI;”; #>
         <# string sSQL = “SELECT * FROM SsisPackages WHERE PackageType=1”; #>
         <# DataTable tblPackages = ExternalDataAccess.GetDataTable(sConn,sSQL); #>
         <# foreach (DataRow row in tblPackages.Rows){ #>
            <Package Name=”<#=row[“PackageName”]#>” ConstraintMode=”Linear” AutoCreateConfigurationsType=”None”>
                   <!–Variables–>
                   <Variables>
                         <Variable Name=”AuditID” DataType=”Int32″ Namespace=”User” >0</Variable>
                         <Variable Name=”PackageID” DataType=”Int32″ Namespace=”User” ><#=row[“PackageID”]#></Variable>
                         <Variable Name=”RcStart” DataType=”Int32″ Namespace=”User” >0</Variable>
                         <Variable Name=”RcExtract” DataType=”Int32″ Namespace=”User” >0</Variable>
                         <Variable Name=”RcInsert” DataType=”Int32″ Namespace=”User” >0</Variable>
                         <Variable Name=”RcUpdate” DataType=”Int32″ Namespace=”User” >0</Variable>
                         <Variable Name=”RcError” DataType=”Int32″ Namespace=”User”>0</Variable>
                         <Variable Name=”RcEnd” DataType=”Int32″ Namespace=”User”>0</Variable>
                         <Variable Name=”ErrorFile” DataType=”String” Namespace=”User”><#=row[“ErrorFile”]#></Variable>
                   </Variables>
                   <!–Package Configurations–>
                   <PackageConfigurations>
                         <PackageConfiguration Name=”MetaDB” >
                              <EnvironmentVariableInput EnvironmentVariable=”Northwind_Config”></EnvironmentVariableInput>
                              <ConfigurationValues>
                                    <ConfigurationValue DataType=”String”
                                                                  PropertyPath=”\Package.Connections[metaDB].Properties[ConnectionString]”
                                                                  Name=”metaDB”
                                                                  Value=”Data Source=.;Initial Catalog=MyDwh_meta;Provider=SQLNCLI10.1;Integrated Security=SSPI;”>
                                    </ConfigurationValue>
                              </ConfigurationValues>
                         </PackageConfiguration>
                         <PackageConfiguration Name=”<#=row[“SourceConnection”]#>” ConnectionName=”metaDB”>
                              <ExternalTableInput Table=”[dbo].[SsisConfiguration]” />
                         </PackageConfiguration>
<#if (row[“SourceConnection”].ToString()!=row[“DestinationConnection”].ToString()) {#>
                        <PackageConfiguration Name=”<#=row[“DestinationConnection”]#>” ConnectionName=”metaDB”>
                              <ExternalTableInput Table=”[dbo].[SsisConfiguration]” />
                         </PackageConfiguration>
<#}#>
                  </PackageConfigurations>
                   <!–Tasks–>
                   <Tasks>
                         <!–Get Inital RowCount–>
                         <ExecuteSQL Name=”SQL – Get Initial RowCount” ConnectionName=”<#=row[“DestinationConnection”]#>” ResultSet=”SingleRow”>
                              <DirectInput>SELECT COUNT(*) AS RcStart FROM <#=row[“DestinationName”]#></DirectInput>
                              <Results>
                                    <Result Name=”RcStart” VariableName=”User.RcStart” />
                              </Results>
                         </ExecuteSQL>
<# if((bool)row[“TruncateDestination”]){ #>
                        <!–Truncate Table–>
                         <ExecuteSQL Name=”SQL – Truncate Destination Table” ConnectionName=”<#=row[“DestinationConnection”]#>” ResultSet=”None”>
                              <DirectInput>TRUNCATE TABLE <#=row[“DestinationName”]#></DirectInput>
                         </ExecuteSQL>
<# } #>
                        <!–Get auditID–>
                         <ExecuteSQL Name=”SQL – Create AuditRow and Get AuditID” ConnectionName=”metaDB” ResultSet=”SingleRow”>
                              <DirectInput>EXEC [dbo].[uspNewAuditRow] ?,?,?,?,?,?</DirectInput>
                              <Parameters>
                                    <Parameter Name=”0″ Direction=”Input” DataType=”Int32″ VariableName=”User.PackageID” />
                                    <Parameter Name=”1″ Direction=”Input” DataType=”Guid” VariableName=”System.PackageID” />
                                    <Parameter Name=”2″ Direction=”Input” DataType=”Guid” VariableName=”System.VersionGUID” />
                                    <Parameter Name=”3″ Direction=”Input” DataType=”Guid” VariableName=”System.ExecutionInstanceGUID” />
                                    <Parameter Name=”4″ Direction=”Input” DataType=”DateTime” VariableName=”System.StartTime” />
                                    <Parameter Name=”5″ Direction=”Input” DataType=”Int32″ VariableName=”User.RcStart” />
                              </Parameters>
                              <Results>
                                    <Result Name=”0″ VariableName=”User.AuditID” />
                              </Results>
                         </ExecuteSQL>
                         <!–Import Table–>
                         <Dataflow Name=”DFT – <#=row[“PackageName”]#>“>
                              <Transformations>
                                    <OleDbSource Name=”ODS – <#=row[“SourceConnection”]#>” ConnectionName=”<#=row[“SourceConnection”]#>“>
                                          <DirectInput><#=row[“SourceInput”]#></DirectInput>
                                    </OleDbSource>
                                    <RowCount Name=”RC – Extracted Rows”  VariableName=”User.RcExtract” />
                                    <DerivedColumns Name=”DC – Add Metadata”>
                                          <Columns>
                                                <Column Name=”InsertAuditID” DataType=”Int32″ ReplaceExisting=”false”>@AuditID</Column>
                                                <Column Name=”UpdateAuditID” DataType=”Int32″ ReplaceExisting=”false”>@AuditID</Column>
                                                <Column Name=”RowStartDate” DataType=”DateTime” ReplaceExisting=”false”>@StartTime</Column>
                                                <Column Name=”RowEndDate” DataType=”DateTime” ReplaceExisting=”false”>(DT_dbDATE)”12/31/9999″</Column>
                                          </Columns>
                                    </DerivedColumns>
                                    <OleDbDestination Name=”ODD-BulkLoad <#=row[“DestinationConnection”]#>” ConnectionName=”<#=row[“DestinationConnection”]#>“>
                                          <ExternalTableOutput Table=”<#=row[“DestinationName”]#>“/>
                                          <ErrorHandling ErrorRowDisposition=”RedirectRow” TruncationRowDisposition=”RedirectRow” />
                                    </OleDbDestination>
                                    <OleDbDestination Name=”ODD-RowbyRow <#=row[“DestinationConnection”]#>” ConnectionName=”<#=row[“DestinationConnection”]#>” UseFastLoadIfAvailable=”false” >
                                          <InputPath OutputPathName=”ODD-BulkLoad <#=row[“DestinationConnection”]#>.Error” />
                                          <ExternalTableOutput Table=”<#=row[“DestinationName”]#>“/>
                                          <ErrorHandling ErrorRowDisposition=”RedirectRow” TruncationRowDisposition=”RedirectRow” />
                                    </OleDbDestination>
                                    <RowCount Name=”RC – Error Rows” VariableName=”User.RcError”>
                                          <InputPath OutputPathName=”ODD-RowbyRow <#=row[“DestinationConnection”]#>.Error” />
                                    </RowCount>
                                    <RawFileDestination Name=”RTF – Error File”>
                                          <FileFromVariableOutput VariableName=”User.ErrorFile”/>
                                    </RawFileDestination>
                              </Transformations>
                         </Dataflow>
                         <!–Get Final RowCount–>
                         <ExecuteSQL Name=”SQL – Get Final RowCount” ConnectionName=”<#=row[“DestinationConnection”]#>” ResultSet=”SingleRow”>
                              <DirectInput>SELECT COUNT(*) AS RcEnd FROM <#=row[“DestinationName”]#></DirectInput>
                              <Results>
                                    <Result Name=”RcEnd” VariableName=”User.RcEnd” />
                              </Results>
                         </ExecuteSQL>
                         <!–Update Audit Row–>
                         <ExecuteSQL Name=”SQL – Update Audit Row” ConnectionName=”metaDB” ResultSet=”None”>
                              <DirectInput>EXEC [dbo].[uspUpdateAuditRow] ?,?,?,?,?,?</DirectInput>
                              <Parameters>
                                    <Parameter Name=”0″ Direction=”Input” DataType=”Int32″ VariableName=”User.AuditID” />
                                    <Parameter Name=”1″ Direction=”Input” DataType=”Int32″ VariableName=”User.RcExtract” />
                                    <Parameter Name=”2″ Direction=”Input” DataType=”Int32″ VariableName=”User.RcInsert” />
                                    <Parameter Name=”3″ Direction=”Input” DataType=”Int32″ VariableName=”User.RcUpdate” />
                                    <Parameter Name=”4″ Direction=”Input” DataType=”Int32″ VariableName=”User.RcError” />
                                    <Parameter Name=”5″ Direction=”Input” DataType=”Int32″ VariableName=”User.RcEnd” />
                              </Parameters>
                         </ExecuteSQL>
                   </Tasks>
             </Package>
<# } #>
       </Packages>
</Biml>

9. Create the packages – and test them.
  • In BIDS right click the project in solution explorer and select Add New Biml File.
  • Rename the file to: Create the packages.biml
  • Copy the Biml code on this page to the newly created biml.file.
  • Right click the Create the packages.biml in Solution Explorer and select Generate SSIS Packages.
  • Open one of the newly created package Import_Northwind_Categories.dtsx and examine the contents.
  • Test the package by Executing the package

Creating a Meta Data Driven SSIS Solution with Biml – 3. Creating a Table Package

In this third blogpost on creating a meta data driven ssis solution I’ll create a biml document with which you can create a package that will import the contents of a query in the source database to a table in the destination database. In blogpost 4 I will enhance this document to include biml script that loops through the entries in the meta data table SsisPackages and create a package for every entry  in this table.

The design of the TablePackage is loosely based on the design used by Joy Mundy and Warren Thornthwaite in their book:
The Microsoft Data warehouse Toolkit With SQL Server 2008 R2. So it will include a system for logging results, adding lineage to the imported rows in the data warehouse and creates error files if appropriate.

The Control Flow
image

The control flow consist of:

  1. An Execute SQL Task, retrieving the number of rows in the destination table at the start of the package.
  2. (Optional, depends on a setting in metadata table) An Execute SQL Task, Truncating the destination table.
  3. An Execute SQL statement to the meta database, creating a new row in the SsisAudit table and returning the AuditID of the created row. Which is used for Lineage in the Data Flow.
  4. The Data Flow, see next paragraph
  5. An Execute SQL Task, retrieving the number of rows in the destination table at the end of the package.
  6. An Execute SQL Task to update the audit row with the end time and several row counters.
The Data Flow

The data flow will first try to import the data with a bulk-load setting (step 4). It will try to load any error rows using a row by row setting. (step5) Any remaining errors rows will be written to a raw text file.(step 7) In the data flow we will also count the extracted rows(step 2) and any error rows (step 6). The package will also add the meta data (AuditID and time stamps) to the data flow (step 3)

The Biml code

<Biml xmlns="http://schemas.varigence.com/biml.xsd">
    <Connections>
        <OleDbConnection Name="metaDB"
                         ConnectionString="Data Source=.;Initial Catalog=MyDwh_meta;Provider=SQLNCLI10.1;Integrated Security=SSPI;"
                         CreatePackageConfiguration="true"></OleDbConnection>
        <OleDbConnection Name="Northwind"
                         ConnectionString="Data Source=.;Initial Catalog=Northwind;Provider=SQLNCLI10.1;Integrated Security=SSPI;"
                         CreatePackageConfiguration="true"></OleDbConnection>
        <OleDbConnection Name="stagingDB"
                         ConnectionString="Data Source=.;Initial Catalog=MyDwh_st;Provider=SQLNCLI10.1;Integrated Security=SSPI;"
                         CreatePackageConfiguration="true"></OleDbConnection>
        <OleDbConnection Name="DWH"
                         ConnectionString="Data Source=.;Initial Catalog=MyDwh;Provider=SQLNCLI10.1;Integrated Security=SSPI;"
                         CreatePackageConfiguration="true"></OleDbConnection>
    </Connections>
    <Packages>
        <Package Name="Import_Northwind_Categories" ConstraintMode="Linear" AutoCreateConfigurationsType="None">
            <!--Variables-->
            <Variables>
                <Variable Name="AuditID" DataType="Int32" Namespace="User" >0</Variable>
                <Variable Name="PackageID" DataType="Int32" Namespace="User" >99</Variable>
                <Variable Name="RcStart" DataType="Int32" Namespace="User" >0</Variable>
                <Variable Name="RcExtract" DataType="Int32" Namespace="User" >0</Variable>
                <Variable Name="RcInsert" DataType="Int32" Namespace="User" >0</Variable>
                <Variable Name="RcUpdate" DataType="Int32" Namespace="User" >0</Variable>
                <Variable Name="RcError" DataType="Int32" Namespace="User">0</Variable>
                <Variable Name="RcEnd" DataType="Int32" Namespace="User">0</Variable>
                <Variable Name="ErrorFile" DataType="String" Namespace="User">c:\myErrorFile.raw</Variable>
            </Variables>
            <!--Package Configurations-->
            <PackageConfigurations>
                <PackageConfiguration Name="MetaDB" >
                    <EnvironmentVariableInput EnvironmentVariable="Northwind_Config"></EnvironmentVariableInput>
                    <ConfigurationValues>
                        <ConfigurationValue DataType="String"
                                            PropertyPath="\Package.Connections[metaDB].Properties[ConnectionString]"
                                            Name="metaDB"
                                            Value="Data Source=.;Initial Catalog=ROCWB_MIS_config;Provider=SQLNCLI10.1;Integrated Security=SSPI;">
                        </ConfigurationValue>
                    </ConfigurationValues>
                </PackageConfiguration>
                <PackageConfiguration Name="Northwind" ConnectionName="metaDB">
                    <ExternalTableInput Table="[dbo].[SsisConfiguration]" />
                </PackageConfiguration>
                <PackageConfiguration Name="stagingDB" ConnectionName="metaDB">
                    <ExternalTableInput Table="[dbo].[SsisConfiguration]" />
                </PackageConfiguration>
                <PackageConfiguration Name="DWH" ConnectionName="metaDB">
                    <ExternalTableInput Table="[dbo].[SsisConfiguration]" />
                </PackageConfiguration>
            </PackageConfigurations>
            <!--Tasks-->
            <Tasks>
                <!--Get Inital RowCount-->
                <ExecuteSQL Name="SQL - Get Initial RowCount" ConnectionName="stagingDB" ResultSet="SingleRow">
                    <DirectInput>SELECT COUNT(*) AS RcStart FROM [dbo].[Northwind_Categories]</DirectInput>
                    <Results>
                        <Result Name="RcStart" VariableName="User.RcStart" />
                    </Results>
                </ExecuteSQL>
                <!--Truncate Table-->
                <ExecuteSQL Name="SQL - Truncate Destination Table" ConnectionName="stagingDB" ResultSet="None">
                    <DirectInput>TRUNCATE TABLE [dbo].[Northwind_Categories]</DirectInput>
                </ExecuteSQL>
                <!--Get auditID-->
                <ExecuteSQL Name="SQL - Create AuditRow and Get AuditID" ConnectionName="metaDB" ResultSet="SingleRow">
                    <DirectInput>EXEC [dbo].[uspNewAuditRow] ?,?,?,?,?,?</DirectInput>
                    <Parameters>
                        <Parameter Name="0" Direction="Input" DataType="Int32" VariableName="User.PackageID" />
                        <Parameter Name="1" Direction="Input" DataType="Guid" VariableName="System.PackageID" />
                        <Parameter Name="2" Direction="Input" DataType="Guid" VariableName="System.VersionGUID" />
                        <Parameter Name="3" Direction="Input" DataType="Guid" VariableName="System.ExecutionInstanceGUID" />
                        <Parameter Name="4" Direction="Input" DataType="DateTime" VariableName="System.StartTime" />
                        <Parameter Name="5" Direction="Input" DataType="Int32" VariableName="User.RcStart" />
                    </Parameters>
                    <Results>
                        <Result Name="0" VariableName="User.AuditID" />
                    </Results>
                </ExecuteSQL>
                <!--Import DIM_KOSTENPLAATS-->
                <Dataflow Name="DFT - Import_Northwind_Categories">
                    <Transformations>
                        <OleDbSource Name="ODS - Northwind" ConnectionName="Northwind">
                            <DirectInput>SELECT CategoryID, CategoryName FROM [dbo].[Categories]</DirectInput>
                        </OleDbSource>
                        <RowCount Name="RC - Extracted Rows"  VariableName="User.RcExtract" />
                        <DerivedColumns Name="DC - Add Metadata">
                            <Columns>
                                <Column Name="InsertAuditID" DataType="Int32" ReplaceExisting="false">@AuditID</Column>
                                <Column Name="UpdateAuditID" DataType="Int32" ReplaceExisting="false">@AuditID</Column>
                                <Column Name="RowStartDate" DataType="DateTime" ReplaceExisting="false">@StartTime</Column>
                                <Column Name="RowEndDate" DataType="DateTime" ReplaceExisting="false">(DT_dbDATE)"12/31/9999"</Column>
                            </Columns>
                        </DerivedColumns>
                        <OleDbDestination Name="ODD-BulkLoad stagingDB" ConnectionName="stagingDB">
                            <ExternalTableOutput Table="[dbo].[Northwind_Categories]"/>
                            <ErrorHandling ErrorRowDisposition="RedirectRow" TruncationRowDisposition="RedirectRow" />
                        </OleDbDestination>
                        <OleDbDestination Name="ODD-RowbyRow stagingDB" ConnectionName="stagingDB" UseFastLoadIfAvailable="false" >
                            <InputPath OutputPathName="ODD-BulkLoad stagingDB.Error" />
                            <ExternalTableOutput Table="[dbo].[Northwind_Categories]"/>
                            <ErrorHandling ErrorRowDisposition="RedirectRow" TruncationRowDisposition="RedirectRow" />
                        </OleDbDestination>
                        <RowCount Name="RC - Error Rows" VariableName="User.RcError">
                            <InputPath OutputPathName="ODD-RowbyRow stagingDB.Error" />
                        </RowCount>
                        <RawFileDestination Name="RTF - Error File">
                            <FileFromVariableOutput VariableName="User.ErrorFile"/>
                        </RawFileDestination>
                    </Transformations>
                </Dataflow>
                <!--Get Final RowCount-->
                <ExecuteSQL Name="SQL - Get Final RowCount" ConnectionName="stagingDB" ResultSet="SingleRow">
                    <DirectInput>SELECT COUNT(*) AS RcEnd FROM [dbo].[Northwind_Categories]</DirectInput>
                    <Results>
                        <Result Name="RcEnd" VariableName="User.RcEnd" />
                    </Results>
                </ExecuteSQL>
                <!--Update Audit Row-->
                <ExecuteSQL Name="SQL - Update Audit Row" ConnectionName="metaDB" ResultSet="None">
                    <DirectInput>EXEC [dbo].[uspUpdateAuditRow] ?,?,?,?,?,?</DirectInput>
                    <Parameters>
                        <Parameter Name="0" Direction="Input" DataType="Int32" VariableName="User.AuditID" />
                        <Parameter Name="1" Direction="Input" DataType="Int32" VariableName="User.RcExtract" />
                        <Parameter Name="2" Direction="Input" DataType="Int32" VariableName="User.RcInsert" />
                        <Parameter Name="3" Direction="Input" DataType="Int32" VariableName="User.RcUpdate" />
                        <Parameter Name="4" Direction="Input" DataType="Int32" VariableName="User.RcError" />
                        <Parameter Name="5" Direction="Input" DataType="Int32" VariableName="User.RcEnd" />
                    </Parameters>
                </ExecuteSQL>
            </Tasks>
        </Package>
    </Packages>
</Biml>

7. Create a package – and test it.
image
  • Open Business Intelligence Development Studio and create a new Integration Services Project.
  • Right click  the project in solution explorer and select Add New Biml File.
  • Rename the file to: Create a package.biml
  • Copy the Biml code on this page to the newly created biml.file.
  • Right click the Create a package.biml in Solution Explorer and select Generate SSIS Packages.
  • Open the newly created package Import_Northwind_Categories.dtsx and examine the contents.
  • Test the package by Executing the package

Creating a Meta Data Driven SSIS Solution with Biml – 2. Setting the stage

This is the second blogpost on the creation of a Meta Data Driven SSIS Solution using Biml. In this post we are settings the stage. We are going to create a simple Kimball based data warehouse with 3 dimensions:

  • dimCustomer
  • dimEmployee
  • dimProduct

and one fact table: factOrder.

Furthermore we’ll implement a staging area and a meta database.

1. Create the databases:

USE [master]
GO
CREATE DATABASE [MyDwh]
GO
CREATE DATABASE [MyDwh_st]
GO
CREATE DATABASE [MyDwh_meta]
GO

2. Create the staging tables:

USE [MyDwh_st]
GO
CREATE TABLE [dbo].[Northwind_Suppliers](
   [SupplierID] [int] NOT NULL,
   [CompanyName] [nvarchar](40) NOT NULL,
   [InsertAuditID] [int] NULL,
   [UpdateAuditID] [int] NULL,
   [RowStartDate] [datetime] NULL,
   [RowEndDate] [datetime] NULL);
CREATE TABLE [dbo].[Northwind_Products](
   [ProductID] [int] NOT NULL,
   [ProductName] [nvarchar](40) NOT NULL,
   [SupplierID] [int] NULL,
   [CategoryID] [int] NULL,
   [InsertAuditID] [int] NULL,
   [UpdateAuditID] [int] NULL,
   [RowStartDate] [datetime] NULL,
   [RowEndDate] [datetime] NULL);
CREATE TABLE [dbo].[Northwind_Orders](
   [OrderID] [int] NOT NULL,
   [CustomerID] [nchar](5) NULL,
   [EmployeeID] [int] NULL,
   [OrderDate] [datetime] NULL,
   [InsertAuditID] [int] NULL,
   [UpdateAuditID] [int] NULL,
   [RowStartDate] [datetime] NULL,
   [RowEndDate] [datetime] NULL);
CREATE TABLE [dbo].[Northwind_OrderDetails](
   [OrderID] [int] NOT NULL,
   [ProductID] [int] NOT NULL,
   [UnitPrice] [money] NOT NULL,
   [Quantity] [smallint] NOT NULL,
   [Discount] [real] NOT NULL,
   [InsertAuditID] [int] NULL,
   [UpdateAuditID] [int] NULL,
   [RowStartDate] [datetime] NULL,
   [RowEndDate] [datetime] NULL);
CREATE TABLE [dbo].[Northwind_Employees](
   [EmployeeID] [int] NOT NULL,
   [LastName] [nvarchar](20) NOT NULL,
   [FirstName] [nvarchar](10) NOT NULL,
   [Title] [nvarchar](30) NULL,
   [ReportsTo] [int] NULL,
   [InsertAuditID] [int] NULL,
   [UpdateAuditID] [int] NULL,
   [RowStartDate] [datetime] NULL,
   [RowEndDate] [datetime] NULL);
CREATE TABLE [dbo].[Northwind_Customers](
   [CustomerID] [nchar](5) NOT NULL,
   [CompanyName] [nvarchar](40) NOT NULL,
   [City] [nvarchar](15) NULL,
   [Country] [nvarchar](15) NULL,
   [InsertAuditID] [int] NULL,
   [UpdateAuditID] [int] NULL,
   [RowStartDate] [datetime] NULL,
   [RowEndDate] [datetime] NULL);
CREATE TABLE [dbo].[Northwind_Categories](
   [CategoryID] [int] NOT NULL,
   [CategoryName] [nvarchar](15) NOT NULL,
   [InsertAuditID] [int] NULL,
   [UpdateAuditID] [int] NULL,
   [RowStartDate] [datetime] NULL,
   [RowEndDate] [datetime] NULL);

3. Create the dimension and fact tables

USE [MyDwh]
GO
CREATE TABLE dimCustomer (
   CustomerKey INT IDENTITY(1,1) NOT NULL
   ,CustomerID NCHAR(5) NOT NULL
   ,CustomerName NVARCHAR(40)
   ,City NVARCHAR(15)
   ,Country NVARCHAR(15)
   ,InsertAuditID INT
   ,UpdateAuditID INT
   ,RowStartDate DATETIME
   ,RowEndDate DATETIME);
GO
CREATE TABLE dimEmployee (
   EmployeeKey INT IDENTITY(1,1) NOT NULL
   ,EmployeeID INT NOT NULL
   ,EmployeeName NVARCHAR(50)
   ,Title NVARCHAR(30)
   ,Manager NVARCHAR(50)
   ,InsertAuditID INT
   ,UpdateAuditID INT
   ,RowStartDate DATETIME
   ,RowEndDate DATETIME);
GO
CREATE TABLE dimProduct (
   ProductKey INT IDENTITY(1,1) NOT NULL
   ,ProductID INT NOT NULL
   ,ProductName NVARCHAR(40)
   ,Category NVARCHAR(15)
   ,Supplier NVARCHAR(40)
   ,InsertAuditID INT
   ,UpdateAuditID INT
   ,RowStartDate DATETIME
   ,RowEndDate DATETIME);
GO
CREATE TABLE factOrder (
   OrderDateKey INT NOT NULL
   ,CustomerKey INT NOT NULL
   ,EmployeeKey INT NOT NULL
   ,ProductKey INT NOT NULL
   ,OrderQuantity INT
   ,OrderAmount money
   ,DiscountAmount money
   ,InsertAuditID INT
   ,UpdateAuditID INT
   ,RowStartDate DATETIME
   ,RowEndDate DATETIME);
GO

4. Create the views for the dimensions and fact tables

USE [MyDwh]
GO
CREATE VIEW [dbo].[vwDimCustomer] AS
SELECT [CustomerID]
      ,[CompanyName] AS CustomerName
      ,[City]
      ,[Country]
FROM  MyDwh_st.dbo.Northwind_Customers;
GO

CREATE VIEW vwDimProduct AS
SELECT pr.ProductID
   , pr.ProductName
   , ca.CategoryName AS Category
   , su.CompanyName AS Supplier
FROM MyDwh_st.dbo.Northwind_Categories AS ca
INNER JOIN MyDwh_st.dbo.Northwind_Products AS pr ON ca.CategoryID = pr.CategoryID
INNER JOIN MyDwh_st.dbo.Northwind_Suppliers AS su ON pr.SupplierID = su.SupplierID;
GO

CREATE VIEW vwDimEmployee AS
SELECT em.[EmployeeID]
      ,em.[FirstName] + ' ' + em.[LastName] AS EmployeeName
      ,em.Title
      ,ma.[FirstName] + ' ' + ma.[LastName] AS Manager
FROM MyDwh_st.dbo.Northwind_Employees em
LEFT OUTER JOIN  MyDwh_st.dbo.Northwind_Employees ma ON ma.[EmployeeID]=em.[ReportsTo];
GO

CREATE VIEW vwFactOrders AS
SELECT OrderDateKey=YEAR(o.OrderDate)*10000+MONTH(o.OrderDate)*100+DAY(o.OrderDate)
   , CustomerKey=ISNULL(cu.CustomerKey,-1)
   , EmployeeKey=ISNULL(em.EmployeeKey,-1)
   , ProductKey=ISNULL(pr.ProductKey,-1)
   , OrderQuantity=od.Quantity
   , OrderAmount=od.Quantity * od.UnitPrice
   , DiscountAmount=CONVERT(money, od.Quantity * od.UnitPrice * od.Discount)
FROM  MyDwh_st.dbo.[Northwind_OrderDetails] od
INNER JOIN MyDwh_st.dbo.Northwind_Orders o ON o.OrderID = od.OrderID
LEFT OUTER JOIN dbo.dimCustomer cu ON cu.CustomerID=o.CustomerID AND cu.RowEndDate>o.OrderDate
LEFT OUTER JOIN dbo.dimEmployee em ON em.EmployeeID=o.EmployeeID AND em.RowEndDate>o.OrderDate
LEFT OUTER JOIN dbo.dimProduct pr ON pr.ProductID=od.ProductID AND pr.RowEndDate>o.OrderDate;
GO

5. Create the objects for the meta database

USE [MyDwh_meta]
GO

CREATE TABLE [dbo].[SsisPackages](
   [PackageID] [int] IDENTITY(1,1) NOT NULL,
   [PackageType] [int] NULL,
   [PackageName] [nvarchar](50) NULL,
   [PackageGroup] [nvarchar](50) NULL,
   [SourceInput] [nvarchar](MAX) NULL,
   [SourceConnection] [nvarchar](50) NULL,
   [DestinationName] [nvarchar](50) NULL,
   [DestinationConnection] [nvarchar](50) NULL,
   [ErrorFile] [nvarchar](MAX) NULL,
   [TruncateDestination] [bit] NULL,
CONSTRAINT [PK_ssisPackages] PRIMARY KEY CLUSTERED
(  [PackageID] ASC));
GO
CREATE TABLE [dbo].[SsisConfiguration](
   [ConfigurationFilter] [nvarchar](255) NOT NULL,
   [ConfiguredValue] [nvarchar](1000) NULL,
   [PackagePath] [nvarchar](255) NOT NULL,
   [ConfiguredValueType] [nvarchar](20) NOT NULL);
GO
CREATE TABLE [dbo].[SsisAudit](
   [AuditID] [int] IDENTITY(1,1) NOT NULL,
   [PackageID] [int] NOT NULL,
   [PackageGUID] [uniqueidentifier] NULL,
   [PackageVersionGUID] [uniqueidentifier] NULL,
   [ExecutionID] [uniqueidentifier] NULL,
   [PackageStartDate] [datetime] NULL,
   [PackageEnddate] [datetime] NULL,
   [ExtractRowCount] [int] NULL,
   [InsertRowCount] [int] NULL,
   [UpdateRowCount] [int] NULL,
   [ErrorRowCount] [int] NULL,
   [TableInitialRowCount] [int] NULL,
   [TableFinalRowCount] [int] NULL,
   [IsProcessed] [bit] NULL,
CONSTRAINT [PK_SsisAudit] PRIMARY KEY CLUSTERED
(  [AuditID] ASC));
GO

CREATE PROCEDURE [dbo].[uspUpdateAuditRow]
    @AuditID INT
    ,@ExtractRowCount INT
    ,@InsertRowCount INT
    ,@UpdateRowCount INT
    ,@ErrorRowCount INT
    ,@TableFinalRowCount INT
AS
UPDATE [dbo].[SsisAudit]
SET [PackageEnddate]=SYSDATETIME()
    ,[ExtractRowCount]=@ExtractRowCount
    ,[InsertRowCount]=@InsertRowCount
    ,[UpdateRowCount]=@UpdateRowCount
    ,[ErrorRowCount]=@ErrorRowCount
    ,[TableFinalRowCount]=@TableFinalRowCount
    ,[IsProcessed]=1
WHERE [AuditID]=@AuditID;
GO

CREATE PROCEDURE [dbo].[uspNewAuditRow]
    @PackageID INT
    ,@PackageGUID UNIQUEIDENTIFIER
    ,@PackageVersionGUID UNIQUEIDENTIFIER
    ,@ExecutionID UNIQUEIDENTIFIER
    ,@PackageStartDate DATETIME
    ,@TableInitialRowCount INT
AS
INSERT INTO [dbo].[SsisAudit]
           ([PackageID]
           ,[PackageGUID]
           ,[PackageVersionGUID]
           ,[ExecutionID]
           ,[PackageStartDate]
           ,[TableInitialRowCount]
           ,[IsProcessed])
VALUES
           (@PackageID
           ,@PackageGUID
           ,@PackageVersionGUID
           ,@ExecutionID
           ,@PackageStartDate
           ,@TableInitialRowCount
           ,0);
     
SELECT CAST(SCOPE_IDENTITY() AS INT) AS AuditID
GO

6. Create an environment variable to store the connection

I’ll use package configurations to make it easier to deploy the solution to different servers (production, test, development) These package configuration will hold the information for the several connections. The connection to the meta database is stored in an environment variable. The other package configurations will be stored in the SsisConfigurations table in the meta database.

So create an environment variable with the name Northwind_Config and value Data Source=.;Initial Catalog=MyDwh_meta;Provider=SQLNCLI10.1;Integrated Security=SSPI;

Windows Explorer – right click the (my)computer node – select Properties – under tab Advanced click the buttton Environment Variables – under System variables click New.

Creating a Meta Data Driven SSIS Solution with Biml – 1. Overview

In this series of blog posts I’ll describe and walk you through the creation of a simple meta data driven SSIS solution using Biml.

Biml (Business Intelligence Markup Language) is an XML-based language that allows you to describe your BI Solution in a declarative fashion.

De Biml Package Generator is a new feature of BIDShelper a free add-in for the Microsoft Business Intelligence Development Studio (BIDS). It allows you to create packages based on the Biml documents. Furthermore you can use BimlScript to automate the creation of these packages.

I will use the Northwind sample database as the source for a simple Kimball based data warehouse. (MyDwh) I will also use a staging database (MyDwh_st) and a meta database (MyDwh_meta) that will include a table with a source to target mapping that will drive the creation of SSIS packages.

The series will consists of the following posts:

  1. Overview (This page)
  2. Setting the stage: Primarily a description of the SQL server databases and SQL statements to create the environment.
  3. Creating a TablePackage: Creating a Biml document to create a package to import one table.
  4. Creating the TablePackages: Using Bimlscript to automate the creation of packages
  5. Creating the MasterPackage