Installation

To install and run SSIS Integration Toolkit for Microsoft Dynamics 365, your system must have the following components installed.

  • A supported SSIS design-time or run-time, which can be one of the following:
    • Azure-SSIS Integration Runtime
    • SSIS 2019
    • SSIS 2017
    • SSIS 2016
    • SSIS 2014
    • SSIS 2012
    • SSIS 2008 R2
    • SSIS 2008
    • SSIS 2005 (No longer supported since v11.0)
    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).

    Target Server Design Time
    Azure-SSIS IR 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
      • 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
      • 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.
    SSIS 2008 R2 or earlier The Business Intelligence Development Studio that is shipped with the installation media of the corresponding SQL Server version.

  • Windows Operating System

    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 system (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 their support status with Microsoft.
    • For server system (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 version up to 2016.
      • Windows Server 2008 should work fine for SSIS version up to 2014, but we highly recommend upgrading to a more recent version due to its support status with Microsoft.
      • If working with SSIS 2008, it might be possible to work with Windows Server 2003 R2 (even Windows XP for development workstation), but it is definitely not recommended, neither do we officially support such installations. In such cases, Windows Installer 4.5 needs to be installed by downloading it from the Microsoft website.
  • .NET Framework
    • Our software requires the installation of .NET Framework 4.5.2 or above
      • For SSIS 2016 or above, .NET Framework 4.6 (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 from Microsoft website.
    • When working with SQL Server 2008 or 2008 R2, .NET Framework 3.5 is required, which is generally installed along with SQL Server installation.

When you have confirmed that your system satisfies the above prerequisites, you can navigate to the KingswaySoft website at https://www.kingswaysoft.com to download the installation package.

download options

After you have downloaded the package, you can install the software by following the installation wizard. 

Working with SSIS Toolbox

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

If you are working with SSIS 2012 or later, SSIS Toolbox should be automatically available during the design time once you have an SSIS package opened provided that you have our software installed properly. If you are not seeing the SSIS Toolbox, you would 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 SSIS Toolbox, you need to make sure that you are in the right view in order to see the right components. For instance, if you are looking for a data flow component, you need to make sure that you in the Data Flow view, not the Control Flow view. Visual Studio would show different components depending on the design view that you are currently working with.

When you working with SSIS 2008, you would have to add our data flow components to the SSIS Toolbox manually. To add the data flow components, create a new data flow task if you do not have one yet and switch to the SSIS data flow page. Right-click on the toolbox area to bring up the context menu, where you can select the "Choose Items..." option as shown below.

Choose items

You will be presented with a window called "Choose Toolbox Items". Switch to "SSIS Data Flow Items" tab, and select the components from the list.

Add SSIS data flow components

Once the 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 Integration Toolkit comes with a license manager program which helps you manage and activate the product license key to be used for the toolkit. The below information is useful for development workstations and Single Server license management. For Azure-SSIS IR deployments, license management and activation will be handled through the PowerShell script, see Running SSIS Integration Toolkit on the Cloud for further details.

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. 

Licensee field is where you will specify the company the software is licensed to, you can include you 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 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 license from us, once the software has been activated, your license manager will be shown as something like below.

KingswaySoft License Manager

Connection Tier will display the number of distinct connections your license supports per connection type within a 24 hour period at runtime. Multiple connections to the same instance are typically treated as 1 distinct connection (exceptions may apply depending on the nature of 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

You can see your 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 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 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 amount of days left on your subscription.

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