Installation and Setup

SSIS Productivity Pack

Help Manual for Installation and Set Up of the SSIS Productivity Pack

Installation

To install and run the SSIS Productivity Pack, your system must have the following components:

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

    For SSIS run-time, the installation should be done by using the corresponding SQL Server installation media, and you must select the "Integration Services" component during the installation, as shown below:

    Integration Services Runtime Selection

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

    For SSIS design-time, you should install 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).

  • Target Server Design Time
    Azure-SSIS IR Any one of the following:
    SSIS 2022 Any one of the following:
    SSIS 2019 Any one of the following:
    SSIS 2017 Any one of the following:
    SSIS 2016 Any one of the following:
    SSIS 2014 Any one of the following:
    • SSDT for Visual Studio 2019
      • Packages created using SSDT 2019 need to have their project's TargetServerVersion setting set to "SQL Server 2014" in order to work with SSIS 2014.
    • SSDT for Visual Studio 2017
      • Packages created using SSDT 2017 need to have their project's TargetServerVersion setting set to "SQL Server 2014" in order to work with SSIS 2014.
    • SSDT for Visual Studio 2015
      • Packages created using SSDT 2015 need to have their project's TargetServerVersion setting set to "SQL Server 2014" in order to work with SSIS 2014.
    • SSDT-BI for Visual Studio 2013
    SSIS 2012 Any one of the following:
    • SSDT-BI for Visual Studio 2012 (recommended; most reliable)
    • SSDT for Visual Studio 2019 (not recommended due to potential compatibility issues with ISV solutions)
      • Packages created using SSDT 2019 need to have their project's TargetServerVersion setting set to "SQL Server 2012" in order to work with SSIS 2012.
    • SSDT for Visual Studio 2017 (not recommended due to potential compatibility issues with ISV solutions)
      • Packages created using SSDT 2017 need to have their project's TargetServerVersion setting set to "SQL Server 2012" in order to work with SSIS 2012.
    • SSDT for Visual Studio 2015
      • Packages created using SSDT 2015 need to have their project's TargetServerVersion setting set to "SQL Server 2012" in order to work with SSIS 2012.

  • A Windows Operating System

    The Windows operating system requirement largely depends on the version of SSIS runtime or design-time selected. We don't have any additional requirements in terms of the Windows operating system as long as it satisfies the minimum requirements of SSIS runtime or design-time. The general guideline is the newer the operating system is, the better. In summary, our software should work for the following Windows operating systems.

    • For desktop systems (mostly for development workstations)
      • We generally recommend Windows 10, version 1507 or greater.
      • Windows 8.1, 8 or 7 should work fine with our software installation which supports most SSDT versions and SQL Server 2016 or below, but we highly recommend you upgrade to Windows 10 because of their support status with Microsoft.
    • For server systems (mostly for runtime deployments)
      • We generally recommend Windows Server 2016 or greater (Including Windows Server 2019 and potentially future Windows Server versions).
      • Windows Server 2012 or Windows Server 2012 R2 should work fine for SSIS versions up to 2016.

  • A .NET Framework

    • Our software requires the installation of .NET Framework 4.7.2 or above
      • For SSIS 2016 or above, .NET Framework 4.7.2 (or above) is generally a prerequisite, no additional installation is required.
      • For SSIS 2014 or lower, you may turn on the .NET Framework feature or install it by downloading it from Microsoft website.

Once confirmed that your system satisfies the above prerequisites, you can navigate to KingswaySoft's website at www.kingswaysoft.com to download the installation package.

download options

After downloading the package, install the software by following the installation wizard. 

Working with SSIS Toolbox

SSIS Toolbox is the first place that you will be looking for to see our components added to your ETL process during the design time.

If you are working with SSIS 2012 or later, SSIS Toolbox should automatically be available during the design time once you have an SSIS package opened, provided that you have our software installed correctly. If you do not see the SSIS Toolbox, either click the SSIS Toolbox menu option under the SSIS menu or click the SSIS Toolbox icon in the design window's upper right corner, as shown below.

SSIS Toolbox Buttons

Note: When working with the SSIS Toolbox, make sure you are in the right view to see the right components. For instance, if you are looking for a data flow component, you need to make sure that you are in the Data Flow view, not the Control Flow view. Visual Studio shows different components depending on the design view that you are currently working on.

Once the control flow or data flow components are available in the SSIS Toolbox, you can start your ETL development by dragging them from the toolbox to the Visual Studio design surface. 

License Manager

SSIS Productivity Pack comes with a license manager program that helps manage and activate the product license key to be used with the toolkit. The below information is useful for development workstations and Single Server license management. For Azure-SSIS IR deployments, license management and activation are handled through the PowerShell script. See Running SSIS Integration Toolkit on the Cloud for further details.

Without a commercial license, the SSIS Productivity Pack will operate under the Developer License, free to use for development or evaluation purposes. 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 of 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, launch the License Manager program, then click the "Change/Update 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 after placing an order through our online shopping cart system, click the "Change/Update License Key..." button and enter the product license key to activate the software and use the fully-featured commercial license. 

The Licensee field is where you will specify the company the software is licensed to. You can include your system's machine name for future reference. For example, the Licensee can be "ABC Inc." or "XYZ Corp (SQLSVR-001)." The Contact Email would be the person we reach out to for any license-related notices such as renewal reminders.

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

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 24 to 48 hours before receiving a license file from us. Once you have received the license file from us via email, save it as a local file, and back in the License Manager, install the saved license file by clicking on the "Install License File..." button.

If you have acquired a license from us and the software has been activated, your license manager will appear as follows:

KingswaySoft License Manager

The Connection Tier will display the number of distinct connections your license supports per connection type within 24 hours at runtime. Multiple connections to the same instance are typically treated as one distinct connection (exceptions may apply depending on the service). Selecting the magnify icon will launch the Runtime Connection Usage Summary window, which will display counts on the number of connections made per connection type and when the 24-hour period will reset.

License Manager Runtime Connection Usage Summary

If you own a perpetual license from us, you should be able to see your Maintenance Expiry Date in the License Manager program. By default, your perpetual license should be instated with a one-year maintenance and upgrade included, which entitles you to use any version of the software released before your Maintenance Expiry Date. To extend your software license maintenance, log in to our portal and navigate to the license key using the License Keys menu. From there, you can renew the license or otherwise reach out to our Client Services team to request their assistance in renewing your license terms.

Note: Perpetual license is only applicable to clients who have previously acquired such a license before the deprecation of the license type. It is no longer offered for any new purchases.

KingswaySoft License Manager

Suppose your commercial license is a subscription license. In that case, you will not see the Maintenance Expiry Date option in the License Manager program since your subscription license comes with maintenance and upgrade for the entire subscription period. Instead, you will see your license expiry date and a progress bar with the number of days left on your subscription.

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