Installation

To install and run SSIS Integration Toolkit for Microsoft Dynamics SL, 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 2017
    • SSIS 2016
    • SSIS 2014
    • SSIS 2012
    • SSIS 2008 R2
    • SSIS 2008
    • SSIS 2005

    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
    SSIS 2017 Any one of the following:
    SSIS 2016 Any one of the following:
    SSIS 2014 Any one of the following:
    SSIS 2012 Any one of the following:
    SSIS 2008 R2 or earlier The Business Intelligence Development Studio that is shipped with the installation media of the corresponding SQL Server version.
  • .NET Framework 3.5
    • For any version before v1.4, .NET Framework 3.5 is required. For v1.4 or later, .NET Framework 3.5 is only required when you use SSIS 2005.
      • If you are using Windows Server 2003, Windows Server 2008, Windows Vista, Windows XP operating systems, you would install .NET framework by downloading it from Microsoft website.
      • If you are using Windows Server 2008 R2 or 2012 family of operating systems, .NET framework 3.5 should be installed using Server Manager program by adding .NET Framework 3.5.1 features.
      • If you are using Windows 8, go to Control Panel -> Programs and Features -> Turn Windows features on or off, then select .NET Framework (includes .NET 2.0 and 3.0).
  • 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 the KingswaySoft website at http://www.kingswaysoft.com to download the installation package. In the download page, you will find two download links. One for x86 systems and one for x64 systems. Make sure to choose and download the right bit for your system.

download options

After you have downloaded the package, you can install the software by following the instructions on your screen.

Setting up a Dynamics SL Connection using the Dynamics SL Connection Manager

SSIS Integration Toolkit for Dynamics SL includes a SSIS Connection Manager component to help you establish connections to Microsoft Dynamics SL web services.

To add a new Dynamics SL connection to your SSIS package, right-click the Connection Manager area, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window, where you can select "DynamicsSL" and click "Add..." to create the connection.

new connection

Add SL Connection

Configuration

The Dynamics SL Connection Manager contains the following tabs

  • General
  • Advanced Settings
  • More Info

General

The Connection tab of the Dynamics SL Connection Manager allows you to specify connection string settings.

SL Connection Manager

Service URL

The Service URL field allows you to specify the address of where your Dynamics SL web services is located.

Company

The Company field allows you to specify the company to connect to.

Authentication

The authentication section allows you to specify your log in credentials to the web server, whether by using a windows account via Integrated Authentication or by specifying a User Name, Password, and Domain.

Timeout

Specify the number of seconds before a web service call will Timeout.

Test Connection

After all the connection information has been provided, you may click "Test Connection" to test if the user can successfully authenticate with the server.

Advanced Settings

The Advanced Settings tab of Dynamics SL Connection Manager allows you to specify some advanced and optional settings for the connection.

SL Connection Manager

Retry on Intermittent Errors

This is an option designed to help recover from possible intermittent outages or disruption of service. It prevents the integration process from stopping due to 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 such that the retry should only occur when it is deemed safe to do so; however, in some occasions such retry service calls could result in the creation of duplicate data.

Ignore Certificate Errors

This option can be used to ignore those SSL certificate errors when connecting to Dynamics SL Server, in case your SL server is using a temporary SSL certificate.

Warning: Enabling "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instance. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.

Note: When this option is enabled, it applies to all HTTP-based SSL connections in the same job process, it is not just limited to SL connections.

Culture

The Culture setting is used as a parameter by Dynamics SL's login webservice. The value defaults to 'en-us'. You may need to change this value if your Dynamics SL is configured with a different Culture setting.

Login Service EndPoint

This setting points to the web service endpoint responsible for logging into Dynamics SL's web services and retrieving a valid session. You may specify the full URL, or just the service endpoint name. Currently, only the LoginWindows endpoint is supported. The default value is 'Microsoft.Dynamics.SL.WebServices.Session.LoginWindows.svc'.

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 the Proxy Server option, you can provide a proxy server to connect to the SL server.

Port

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

Username (Proxy Server Authentication)

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

Password (Proxy Server Authentication)

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

Note: The Proxy Password is not included in the SL connection manager's ConnectionString property by default. This is done 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

The More Info tabs shows some basic information about where to find support and additional information about the toolkit. In this page, you can find the version information of the toolkit.

SL Connection Manager

Adding SSIS Toolkit Components to the SSIS Toolbox

Before you can use the toolkit's data flow components, they must be added to your SSIS development environment's toolbox.

  • If you are using SQL Server 2008 R2 or earlier, you must add them to SSIS toolbox by following the instructions below.
  • If you are using SQL Server 2012 or later, you should not need to do so, as SQL Server 2012 (or a later version) automatically lists all available pipeline components by scanning the system. Under certain circumstances, your SSIS toolbox might appear empty, in which case, you should click the SSIS Toolbox button (shown below) on the top-right corner of your Control Flow or Data Flow view.

    SSIS Toolbox

Adding Data Flow Components to the SSIS Toolbox (SQL Server 2008 R2 or earlier)

In BIDS 2008 or 2005 (depending on which SQL Server version you are using), create a new data flow if you do not have one yet, and switch to the data flow page. Then right-click on the toolbox area to bring up the context menu and select "Choose Items..." option as shown below.

choose items

You are now presented with a window called "Choose Toolbox Items". Switch to the "SSIS Data Flow Items" tab, and check the Dynamics SL components from the list.

Add SL SSIS Components

You should now be able to use the component by dragging and dropping a component to the design surface of your SSIS data flow task.

Using the Dynamics SL Source Component

The Dynamics SL Source Component allows you to read data from your SL system. The component allows you to specify a source object to read from, and filter for desired records.

General page

The General page is where you will configure most of the setup details.

SL Source Editor

Connection Manager

The Dynamics SL source component requires an active connection to your Dynamics SL web services. You can specify a Connection Manager here to facility that connectivity.

Service Endpoint

Listed here are the default service endpoints provided by Dynamics SL's web services. If you have created your own web service, you must manually enter the name of your service endpoint here.

Batch Size

You can configure how many records each web service call will retrieve at a time with the Batch Size setting.

Source Object

If a valid Service Endpoint is specified, this dropdown will list all available objects that you can read data from.

Child Object

Source Objects may contain links to Child Objects. E.g. Customers (source) contain a list of Contacts (child). If you want to read data from a Child Object, choose an item from this dropdown.

Note: This is an optional setting.

Source Object Filter

If you wish to filter for specify Source Object records, you can specify your filter criteria here.

The filtering syntax follow a SQL-like pattern, with fields and values encapsulated in double quotes. See below for examples:

  • General syntax: "MyField" = "MyValue"
  • LIKE keyword: "ProjectID" LIKE "CO123%"
  • AND keyword: "ProjectID" = "CO123456" AND "FiscalYear" = "2010"
Child Object Filter

If you wish to filter for specify Child Object records, you can specify your filter criteria here.

Refresh Component Button

Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each field to its most recent metadata.

Expression fx Icon

Click the blue fx icon to launch SSIS Expression Editor to enable dynamic update of the property at run time.

Generate Documentation Icon

Click the Generate Documentation icon to generate a Word document which describes the component's metadata including relevant mapping, and so on.

Columns

The Columns page lists all the available metadata fields for the object that you wish to read from.

SL Source Editor

Using the Dynamics SL Destination Component

The Dynamics SL Destination Component is an SSIS data flow pipeline component that can be used to write data to Microsoft Dynamics SL. You may Create, Update, and Delete records with this component.

General page

The General page of the Dynamics SL Destination Component allows you to specify the general settings of the component.

SL Destination Editor

Connection Manager

The Dynamics SL destination component requires an active connection to your Dynamics SL web services. You can specify a Connection Manager here to facility that connectivity.

Service Endpoint

Listed here are the default service endpoints provided by Dynamics SL's web services. If you have created your own web service, you must manually enter the name of your service endpoint here.

Action

The Action option allows you to specify how the data should be written into Microsoft Dynamics SL. There are three (3) action types available.

  • Create: Create new record(s) in SL
  • Update: Update existing record(s) in SL
  • Delete: Delete record(s) from SL
Destination Object

The Destination Object option allows you to specify which SL object to write data to. A drop down with available objects are listed here.

Primary Key Field

This dropdown lets you select which field corresponds to the Primary Key for the Destination Object. Currently, composite primary keys are not supported.

Note: The Primary Key field is the Destination Object's field that uniquely identify records. Since Dynamics SL's web services does not automatically generate a unique ID for new objects, you will need to specify a source field from your upstream component that will be used to populate the primary key value in your destination.

The Primary Key field is also needed to identify which record to update or delete if those Actions are chosen.

For example, the Customer object's primary key field is the CustomerId field.

Child Object

Objects may contain links to Child Objects. E.g. Customers (source) contain a list of Contacts (child). If you want to create, update, or delete data from a Child Object, choose an item from this dropdown.

Note: This is only required when you need to work with a child object. In the case that you just need to work with the parent object, you can leave this option empty.

Child Object Primary Key

This dropdown lets you select which field corresponds to the Primary Key for the Child Object. Currently, composite primary keys are not supported.

Note: See above note from Primary Key Field regarding the use of primary keys

Refresh Component button

By clicking this button, the component will retrieve the latest metadata from Dynamics SL's web services. After clicking this button, you will receive a status message indicating how many fields have been updated, added, or deleted.

Map Unmapped Fields button

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

Clear All Mappings button

By clicking this button, the component will remove all field mappings. You can use this button to reset your mappings.

Expression fx Icon

Click the blue fx icon to launch SSIS Expression Editor to enable dynamic update of the property at run time.

Generate Documentation Icon

Click the Generate Documentation icon to generate a Word document which describes the component's metadata including relevant mapping, and so on.

Columns page

The Columns page of Dynamics SL Destination Component allows you to map the columns from upstream components to SL fields for the destination object.

SL Destination Editor

In the Columns page, you will see a grid with five columns as seen above.

  • Input Column: You can select a column from your upstream component to be used as the input of the corresponding field.
  • Destination Dynamics SL Field: The field that you are writing data.
  • Data Type: This column indicates the type of value for the current field in Dynamics SL. Typically you would need to pass in the value using the format indicated in Data Type column.
  • 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.

Error Handling page

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

SL Destination Editor

There are three options available.

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

When the Redirect rows to error output option is selected, rows that failed to write to Dynamics SL will be redirected to the 'Dynamics SL Destination Error Output' output of the Destination Component. As indicated in the screenshot below, the green output connection represent rows that were successfully written, and the red 'Dynamics SL Destination Error Output' connection represents rows that were erroneous. The 'ErrorMessage' output column found in the 'Dynamics SL Destination Error Output' may contain the error message that was reported by Dynamics SL or the component itself.

Error Output

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

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.

Contact Us

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