Installation

To install and run SSIS Integration Toolkit for Team Foundation Server, your system must have the following components installed. 

  • A supported SSIS design-time or run-time, which can be one of the following:
    • SSIS 2017
    • SSIS 2016
    • SSIS 2014
    • SSIS 2012

    For SSIS runtime, the installation should be done by using the corresponding SQL Server installation media (most likely in CD/DVD format), and you must select the "Integration Services" component during the installation (as shown below).

    Integration Services Runtime Selection

    Note that when using SQL Server 2014, a cumulative update is required (a recent service pack, such as one of the following, is more preferred) in order to run our software during runtime.

    For SSIS design-time, you should be installing the version of SSDT (SQL Server Data Tools) or BIDS (Business Intelligence Development Studio) that aligns with the SQL Server version that you plan to use for your final deployment (the runtime).

  • .NET Framework
  • Windows Installer 4.5
    • If you are using Windows Server 2008, Windows Server 2012 family of operating systems or later (including Windows Vista, Windows 7, Windows 8, Windows Server 2012 R2, Windows Server 2016), you do not need to do anything since the latest Windows Installer has been installed by the operating system.
    • If you are using Windows Server 2003 family of operating systems (including Windows XP), you should install Windows Installer 4.5 by downloading it from Microsoft website.

When you have confirmed that your system satisfies the above prerequisites, you can navigate to KingswaySoft website at http://www.kingswaysoft.com to download the installation package. In the download page, you will find two download links. One is for x86 and one is for x64 system. Make sure to choose and download the right bit for your system. 

Download Options

Once you click the download link, save the zip file which contains the .msi file. Double click the .msi file to start the setup. A security warning may appear. You can safely accept the warning and continue the setup

The SSIS Integration Toolkit for Team Foundation Server Setup Wizard will appear. Click ‘Next’ to continue. 

Setup Wizard

Select the checkbox to agree to the terms of the End-User License Agreement. Click 'Next' to continue.

License Agreement

Next, choose one of the three setup types that best suits your needs.

Choose Installation Type

Click ‘Install’ to being the installation.

Install

To complete the installation, select 'Finish'.

Setup Complete

Setup a TFS Connection using Team Foundation Connection Manager

SSIS Integration Toolkit Team Foundation Connection Manager is an SSIS connection manager that can be used to establish connections with Team Foundation Server. 

Team Foundation Server connection manager allows you to specify how you want to connect to your Team Foundation Server. 

To add a Team Foundation Server connection to your SSIS package, right-click in Connection Managers area, and choose "New Connection..." from the context menu. You will be prompted the following window, where you can choose "TeamFoundation (KingswaySoft)" to add the connection.

New Connection

Add TFS Connection Manager

Team Foundation Server Connection Manager contains the following three pages which configure how to connect to your Team Foundation Server.

  • General
  • Advanced Settings
  • More Info

General page

The Connection page of Team Foundation Connection Manager allows you to specify the general settings of the connection.

TFS Connection Manager

Authentication Type

Authentication Type option allows to specify the deployment type of your Team Foundation Server and what authentication is used. There are two options available:

  • Active Directory (On-Premise)
  • Visual Studio Team Services by Alternate Credentials
Service URL

Service URL option allows you to specify the Service URL which you can use to connect to your Team Foundation Server.

User Name

User Name option allows you to specify the user account used to connect to Team Foundation Server for your integration purpose.

Password

Password option allows you to specify the personal access token for the above user in order to be able to connect to Team Foundation Server.

NOTE:  The Password is not included in the connection manager's ConnectionString property by default. This is by design for security reason. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be Password=myPassword;  (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Domain

Domain option is used to specify the active directory domain of the Team Foundation Server user account. This option is only available if you have chosen Active Directory (On-Premise) as the Authentication Type.

Use Integrated Authentication

The Use Integrated Authentication option specifies whether you want to use Integration Authentication or provide separate login credentials. Note this option is only available if you have chosen Active Directory (On-Premise) as the Authentication Type.

Timeout (secs)

Timeout (secs) option allows you to specify the maximum number of seconds that Team Foundation Server connection manager will wait while trying to establish a connection with TFS. 

Test Connection

After you have provided all connection information, you may click "Test Connection" button to test if you can successfully login to TFS. 

Advanced Settings page

The Advanced Settings page of Team Foundation Connection Manager allows you to specify some advanced options when connecting to TFS.

TFS Connection Manager - Advanced Settings

Retry on Intermittent Errors

This is an option designed to help recover from possible intermittent outages or disruption of service so the integration does not have to be stopped because of such temporary issues. Enabling this option will allow service calls to be retried upon certain types of failure. A service call may be retried up to 3 times before an exception is fired. Retries occur after 0 seconds, 15 seconds, and 60 seconds.

Warning: We have designed our retry feature carefully so that the retry should only happen when it is deemed to be safe to do so. However, in some occasions, such retry service calls could result in the creation of duplicate data.

Proxy Mode

Proxy Mode option allows to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Using system configured proxy)
  • Manual
Proxy Server

Using Proxy Server option, you can provide a proxy server to connect to Team Foundation Server.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

NOTE:  The Proxy Password is not included in the connection manager's ConnectionString property by default. This is by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword;  (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

More Info page

More Info page shows some basic information about the toolkit. In this page, you can find the version information of the toolkit.

TFS Connection Manager - More Info

Use of Team Foundation Source Component

Team Foundation Source Component is an SSIS data flow pipeline component that can be used to read / retrieve data from your Team Foundation Server.

Team Foundation Source Component includes the following two pages to configure how you want to read data from TFS.

  • General
  • Columns

General page

The General page of Team Foundation Source Component allows you to specify the general settings of the component. 

TFS Source Component

Connection Manager

Team Foundation Source Component requires a TFS connection in order to connect to your Team Foundation Server. The Connection Manager option will show all Team Foundation Server connection managers that have been created in the current SSIS package.

Source Type

Source Type option allows you to specify which type of TFS query you want to use. There are two available options:

  • Predefined Query
  • Custom Query

When Custom Query is used, you have the flexibility to specify which columns you want to retrieve from Team Foundation Server, for more information on how to build your TFS queries, visit TFS Documentation.

Project

Project option allows you to specify which TFS project is used.

Output Timezone

Output Timezone option specifies how datetime values are retrieved. There are 2 options available:

  • UTC
  • Adjust to Local System Timezone
Query

Query option is only available when Source Type option has been chosen as Predefined Query. When you click the drop down button of this option, the toolkit will automatically retrieve the list of all available TFS queries, so that you can pick one. 

Workitem Detail Types

Workitem Detail Types option allows you to specify whether to retrieve Attachments and/or Comments. Once this function is enabled, additional outputs will become available to use for the downstream components.

Refresh Component Button

By clicking this button, the component will retrieve the latest metadata from Team Foundation Server and update each field. After clicking this button, you will receive the following screen once the refresh is done.

TFS Source Component - Refresh

Columns page

The Columns page of Team Foundation Source Component shows you all available columns from the query that you have defined in General page. 

TFS Source Component - Columns

On the top left of the grid, you can see a checkbox, which can be used to toggle the selection of all available fields. This is a productive way to check or uncheck all available fields.

The Columns Page grid consists of:

  • Field Name – Columns that will be retrieved from Team Foundation Server.
  • Data Type – The data type of this field.

NOTE:  As a general best practice, only select the TFS fields that are needed for the downstream pipeline components. This would not only speed up TFS queries, but also save resources for SSIS engine. 

Use of Team Foundation Destination Component

Team Foundation Destination Component is an SSIS data flow pipeline component that can be used to write data to your TFS instance. You may Create, Update, Delete, or Upsert TFS records using the Team Foundation Destination Component. 

Team Foundation Destination Component includes the following three pages to configure how SSIS writes data to TFS.

  • General
  • Columns
  • Error Handling

General page

General page allows you to specify the general settings of the destination component. 

TFS Destination Component

Connection Manager

Team Foundation Destination Component requires a TFS connection in order to connect to your Team Foundation Server. The Connection Manager option will show all Team Foundation Server connection managers that are available in the current SSIS package.

Action

Action option specifies how the data should be written to Team Foundation Server. There are 4 action types available. 

  • Create - Create new record(s) in Team Foundation Server
  • Update - Update existing record(s) in Team Foundation Server
  • Delete - Delete record(s) from Team Foundation Server
  • Upsert - Update an existing record in Team Foundation Server if matching record can be found. Otherwise, create a new record using the information from upstream pipeline components. 
Target Project

Target Project option specifies which target project to write the data. When the option is clicked, SSIS Integration Toolkit will retrieve a list of all available TFS project for the selected Team Foundation Server connection.

Destination Entity

Destination Entity option lists all available work item types for the target project you've specified in the Target Project option.

Refresh Component Button

By clicking this button, the component will retrieve the latest metadata from Team Foundation Server and update each field. After clicking this button, you will receive the following screen once the refresh is done.

TFS Desintation Component - Refresh Component

Map Unmapped Fields Button

By clicking this button, the component will map any unmapped TFS fields by matching their names with the input columns from upstream components. This is useful when your source component has recently added more columns, in which case you can use this button to automatically establish the association between input columns and unmapped TFS fields.

After clicking this button, you will receive the following message.

Map Unmapped Fields

Clear All Mappings Button

By clicking this button, the component will reset all your mappings in the destination component.

Columns page

The Columns page of Team Foundation Destination Component allows you to map input columns to TFS fields. 

In Columns page, you will see a grid that contains four columns as below.

  • Input Column - You can select an input column from upstream component for the corresponding TFS field.
  • Destination Field - The TFS field that you are writing data. 
  • Data Type - The target tfsfield's data type.
  • Unmap - This column can be used to unmap the field from the upstream input column, or otherwise it can be used to map the field to an upstream input column by matching its name if the field is not currently mapped.

TFS Destination Component - Columns

Error Handling page

The Error Handling page allows you to specify how errors should be handled when they happen. 

TFS Destination Component - Error Handling

There are three options available. 

  1. Fail on error
  2. Redirect rows to error output
  3. Ignore error

When Redirect rows to error output option is selected, you can see the following columns in the Error Output:

  • ErrorCode - Contains the error code that is reported by Team Foundation Server or the component itself.
  • ErrorColumn - Contains the name of the column that is causing the error. Note that this column is not always populated.
  • ErrorMessage - Contains the error message that is reported by Team Foundation Server or the component itself.

NOTE:  Use extra caution when selecting the Ignore error option, since the component will remain silent for any errors that have occurred. 

In the Error Handling page, there is also an option that can be used to enable or disable the following output fields for the destination component.

  • TeamFoundationServer_ID - Contains the newly created TFS record's ID, which you can use to write to log or further process using additional data flow components.

NOTE: If you don't plan to use any of those fields for any further processing, it is generally recommended to turn them off, so you don't get any warning from SSIS by complaining that those fields are never used, and it should also provide a slightly better performance by doing so.

License Manager

SSIS Integration Toolkit comes with a license manager program which helps you manage and activate the product license key to be used for the toolkit.

Without a commercial license, SSIS Integration Toolkit will operate under the Developer License which is free to use for development or evaluation purpose. Under the developer license, you can use the software within the development tool (SSDT-BI, BIDS, or Visual Studio). 

KingswaySoft License Manager

The only limitation with the free developer license is the inability to run the software outside of the development tool (SSDT-BI, BIDS, or Visual Studio). If you would like to run the software outside the development tool, such as running SSIS packages on a scheduled basis or from a command line, you will need to acquire a license from us.

If you want to test out the functionality by scheduling your SSIS packages, a trial license can be requested. To do so, you can launch License Manager program, then click "Change License Key" button, where you can request a free trial license after filling out the necessary Licensee Information.

KingswaySoft License Manager

If you have received a product license key from us after placing an order through our online shopping cart system, you can also click "Change License Key" button and enter the product license key in order to activate the software to use the fully-featured commercial license. 

To request a free trial license or activate a product license key that you have received, you can use Web Service option to complete the process by sending the request to our license server directly. An Internet connection is required when Web Service option is used. This is the option that we recommend.

Alternatively, you can choose the Email option so that the license manager will generate an email for you which you can send to us. The Email option should only be used if your system has no Internet access. It requires manual processing so please expect to wait for 24 to 48 hours before receiving a license file from us. Once you have received the license file from us from through email, you can save it to a local file, which you can then install by clicking "Install License File..." button in License Manager.

If you have acquired a perpetual license from us, once the software has been activated, your license manager will be shown as something like below.

KingswaySoft License Manager

You can see your Support Expiry Date or Maintenance Expiry Date in the License Manager program if you are using a perpetual license. By default, your perpetual license comes with a one-year maintenance and upgrade, which entitles you to use any version of the software released before your Support Expiry Date or Maintenance Expiry Date. You can extend it by entering a new maintenance license key that you have acquired from us.

KingswaySoft License Manager

If your commercial license is a subscription license, you will not see the Support Expiry Date or Maintenance Expiry Date option in the License Manager program, since your subscription license comes with maintenance and upgrade for the entire subscription period.

NOTE: You must run License Manager program under a local administrative account due to the privileges required to write license file to the system.

Contact Us

If you need any further assistance with the toolkit, please don't hesitate to contact us