To install and run SSIS Integration Toolkit for Xero, your system must have the following components installed.
- A supported SSIS design-time or run-time, which can be one of the following:
- 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).
Note that for SSIS runtime, SQL Server Standard Edition or above is required to run our software. SQL Server Express or Web editions are not supported due to their own limitations.
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.
- SQL Server 2014 Service Pack 2: https://www.microsoft.com/download/details.aspx?id=53168
- SQL Server 2014 Service Pack 1: https://www.microsoft.com/download/details.aspx?id=46694
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).
- When targeting SSIS 2016, you would use SSDT for Visual Studio 2015 available for download at
- Note that this SSDT installation can be used to target SSIS 2014 or 2012 as well.
- When targeting SSIS 2014, you can use either one of the following:
- SSDT for Visual Studio 2015: https://msdn.microsoft.com/mt186501.aspx (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: https://www.microsoft.com/download/details.aspx?id=42313
- When targeting SSIS 2012, you can use any one of the following:
- SSDT for Visual Studio 2015: https://msdn.microsoft.com/mt186501.aspx (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)
- SSDT-BI for Visual Studio 2012: https://www.microsoft.com/download/details.aspx?id=36843
- You can install the "SQL Server Data Tools" component that is shipped with the SQL Server 2012 installation media (which is based on a Visual Studio 2010 shell)
- When targeting SSIS 2008 R2 or earlier, you would have to install the Business Intelligence Development Studio that is shipped with the installation media of the corresponding SQL Server version.
.NET Framework 3.5
.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).
- .NET Framework 3.5 is only required when you use SSIS 2005.
- 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 sytems and one for x64 systems. Make sure to choose and download the correct package for your system.
After you have downloaded the package, you can install the software by following the installation wizard.
Using the Xero Connection Manager
The Xero Connection Manager is an SSIS connection manager component that can be used to establish connections with Xero.
To add a Xero connection to your SSIS package, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "Xero" item to add the new Xero connection manager.
The Xero Connection Manager contains the following three pages which configures how you want to connect to Xero.
- Advanced Settings
- More Info
The General page on the Xero Connection Manager allows you to specify general settings for the connection. Before you can connect to Xero, you must first create a Public/Private Key Pair and a Private Application.
Creating a Public/Private Key Pair:
- Download OpenSSL for Windows
- After installation you may need to restart your machine.
- Open a Windows Command Prompt as Administrator (Go to Start -> type cmd -> right click on 'cmd.exe' -> select 'Run as administrator').
- Navigate to the 'bin' folder of the installation location of OpenSSL using the 'cd' command (ex: 'cd C:\OpenSSL-Win32\bin').
- Execute the following commands. The third command will prompt you to enter a password. Remember this password to connect to Xero later.
openssl genrsa -out privatekey.pem 1024 openssl req -new -x509 -key privatekey.pem -out publickey.cer -days 1825 openssl pkcs12 -export -out public_privatekey.pfx -inkey privatekey.pem -in publickey.cer
Creating a Private Application:
- Go to My Applications (you will need to login to Xero).
- Click the 'Add Application' button.
- Select the 'Private' application radio button.
- Give the application a name.
- Select the Organisation you wish to integrate with.
- Select the 'Upload X509 certificate file (.cer)' radio button and click 'Choose File'.
- Upload the 'publickey.cer' file we created earlier using OpenSSL.
- Check the Terms & Conditions checkbox.
- Click 'Save'
- Notice the 'Valid To' field. After this date the certificate you uploaded would have expired and you will need to generate a new one. The newly generated certificate (.cer) and public/private key (.pfx) files will need to be reflected in both the Xero Application you just created and the Xero Connection Manager.
- Consumer Key
Your Xero Consumer Key can be found in the Xero Developer Console underneath My Applications.
- Path to PFX File:
The Path to PFX File points to the path of the public/private key file (.pfx) we made earlier using OpenSSL.
- Password for PFX File
The Password for PFX File is whatever password you used when generated the public/private key file using OpenSSL. Leave blank if no password was used.
- Timeout (secs)
The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds.
- API Throttling Rate (requests/minute)
The API Throttling Rate is based on the Throttle Limits in Xero. This rate is set to 60 requests per minute limit, by default, to respect the Xero API Throttle limit. If the API Throttling Rate exceeds 60 requests per minute, the Xero server may stop your request for a short period of time. Xero has a Default Daily API Quota of 1000 API calls.
- Test Connection
After all the connection information has been provided, you may click the Test Connection button to test if the connection settings entered are valid.
The Advanced Settings page on the Xero Connection Manager allows you to specify some advanced and optional settings for the connection.
- Port (Proxy Server Information)
The Port option allows you to specify port number of the proxy server for the connection.
- Username (Proxy Server Authentication)
The Username option allows you to specify the proxy user account.
Using Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.
NOTE: The Proxy Password is not included in the Xero 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.
- 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: Although we have carefully designed this feature so that such retries should only happen when it is deemed to be safe to do so. However, in some extreme occasions, such retried service calls could result in the creation of duplicate data.
More Info page
The More Info page shows some basic information about the toolkit. In this page, you can find the version information of the toolkit.
Adding SSIS Components to Business Intelligence Development Studio's Toolbox
SSIS Integration Toolkit for Xero includes two data flow components for use with Xero. They need to be added to the SSIS toolbox before you can use them in a SSIS data flow task.
NOTE: If you are using SQL Server 2012 or later development environment, you should not need to do this, as SQL Server 2012 or later automatically lists all available pipeline components by scanning the system.
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.
You will be presented with a window called "Choose Toolbox Items". Switch to "SSIS Data Flow Items" tab, and select Xero Destination and Xero Source components from the list.
Both data flow components should now appear in your SSIS Toolbox, where you can drag and drop any of them to the design surface of your SSIS data flow task.
Using the Xero Source Component
The Xero Source Component is an SSIS data flow pipeline component that can be used to read / retrieve data from Xero.
The component includes the following two pages to configure how you want to read data from Xero.
The General page of the Xero Source Component allows you to specify the general settings of the component.
- Connection Manager
The Xero Source Component requires a Xero connection in order to connect with Xero. The Connection Manager drop-down will show a list of all Xero connection managers that are available to your current SSIS package.
- Source Object
The Source Object drop-down lists all of the currently supported objects which you can read from.
- Child Objects
The Child Objects drop-down is enabled when the Source Object specified contains 1 or more readable child objects.
NOTE: For each child object selected a secondary output will be created. You will be able to manage the fields for the primary object along with all child objects on the Columns Page.
- Where Statement
The Where Statement textbox is a conditional statement used to filter data. For more information on how to format a Xero request Where Statement, check out the 'Retrieving a filtered set of resources' section on Xero's Documentation.
- 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.
The Columns page of the Xero Source Component shows you all available attributes from the object that you specified on the General page. If you selected any child objects you will see a drop-down list at the top of the page where you can select the output columns to view.
Every child object will have a special field that represents the id of its parent. The field name will consist of the name of the Source Object and the name of the Source Object's ID field separated by a period. (ex. Contact.ID). This field is crucial for managing child objects both when reading and writing.
If you selected child objects on the General Page you will notice a dropdown list at the top of the Columns Page. This will update the grid below to show the fields for the selected object.
On the top left of the grid, you can see a checkbox, which can be used to toggle the selection of all available Xero fields. This is a productive way to check or uncheck all available fields.
NOTE: As a general best practice, you should only select the Xero fields that are needed for the downstream pipeline components.
Using the Xero Destination Component
The Xero Destination Component is an SSIS data flow pipeline component that can be used to write data to Xero. You can create, update, or delete objects that allow a particular action with this component. There are three pages of configuration:
- Error Handling
The General page is used to specify general settings for the Xero Destination Component. The Columns page allows you to map the columns from upstream components to Xero fields in the destination object. The Error Handling page allows you to specify how errors should be handled when they occur.
NOTE: If you supply multiple inputs (child objects) you will need to sort all of the inputs using the SSIS Sort Component. For the primary input sort by the ID field and for secondary inputs sort by the Parent ID field.
The General page allows you to specify general settings for the component.
- Xero Connection Manager
The Xero Destination Component requires a Xero connection. The Xero Connection Manager option will show all Xero connection managers that have been created in the current SSIS package or project.
- Destination Object
The Destination Object drop-down lists all of the currently supported objects which you can write to.
The Action option allows you to specify how data should be written to Xero. There are currently three (3) supported:
- Batch Size
The Batch Size lets you specify how many records to send per service call to Xero. This is only available for some objects, the option will be disabled when it is not.
- Child Object Settings
In order to gain access to child object input data, you must map secondary inputs to destination child objects using the Child Object Settings. The table is only visible when the Destination Object contains Child Objects that you can write to. The 'Secondary Input' column will show all of the attached Secondary Inputs. The 'Child Object' column will show drop-down lists of destination child objects. Select the child object that the secondary input represents and you will then be able to go to the Columns Page and edit the column mappings for that Secondary Input.
- Refresh Component Button
Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each attribute to its most recent metadata.
- Map Unmapped Fields Button
By clicking this button, the component will try to map any unmapped Xero attributes 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 destination attributes.
- Clear All Mappings Button
By clicking this button, the component will reset all your mappings in the destination component.
The Columns page of the Xero Destination Component allows you to map the columns from upstream components to the Xero destination fields.
In the Columns page, you would see a grid that contains four columns as shown below.
- Input Column - You can select an input column from an upstream component for the corresponding Xero field.
- Xero Field - The Xero field that you are writing data.
- Data Type - This column indicates the type of value for the current field.
- 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.
NOTE: Depending on the action and whether or not you supply child objects determines what fields must be mapped. Here are some guidelines:
- If no child objects are supplied then you must map the ID field while Updating and Deleting but not for Creating.
- If child objects are supplied then you will need to supply the ID field for the destination object and Parent ID fields for all of the child objects while Creating or Updating (Deleting is not effected by the addition of child objects).
- While Creating, the ID and Parent ID fields don't actually get written to Xero, they are for associating child objects with parent objects during execution.
Error Handling page
The Error Handling page allows you to specify how errors should be handled when they happen.
There are three options available.
- Fail on error
- Redirect rows to error output
- Ignore error
When the Redirect rows to error output option is selected, rows that failed to write to Xero will be redirected to the '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 'Error Output' connection represents rows that were erroneous. The 'ErrorMessage' output column found in the 'Error Output' may contain the error message that was reported by Xero or the component itself.
NOTE: Use extra caution when selecting Ignore error option, since the component will remain silent for any errors that have occurred.
Enable Columns for Default Output.
- XeroRecordId - Contains the id of the Xero item
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).
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.
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.
Since v2.0, 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.
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.
If you need any further assistance with the toolkit, please don't hesitate to contact us.