Build Data Flows from Carbone to SQL Server using SSIS

Using SQL Server as a backup for critical business data provides an essential safety net against loss. Backing up data to SQL Server enables business users to more easily connect that data with features like reporting, analytics, and more.

This example demonstrates how to use the CData SSIS Tasks for Carbone inside of a SQL Server SSIS workflow to transfer Carbone data into a Microsoft SQL Server database.

Add the Components

To get started, add a new Carbone source and SQL Server ADO.NET destination to a new data flow task.

Create a New Connection Manager

Follow the steps below to save Carbone connection properties in a connection manager.

1. In the Connection Manager window, right-click and then click New Connection. The Add SSIS Connection Manager dialog is displayed.
2. In the Connection Manager type menu, select API. The CData Carbone Connection Manager is displayed.
3. Configure connection properties.

   Start by setting the Profile connection property to the location of the Carbone Profile on disk (e.g. C:\profiles\Carbone.apip). Next, set the ProfileSettings connection property to the connection string for Carbone (see below).

   Carbone API Profile Settings

   Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

   1. Log in to your Carbone account at https://account.carbone.io
   2. Copy the API key shown on the account home page

   After obtaining your API key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Carbone API key (Bearer token).
   • CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.
   

Configure the Carbone Source

Follow the steps below to specify the query to be used to extract Carbone data.

1. Double-click the Carbone source to open the source component editor.
2. In the Connection Manager menu, select the connection manager previously created.
3. Specify the query to use for the data extraction. For example:

   
   SELECT Id, Name FROM Templates WHERE Category = 'Invoices'
   

   
4. Close the Carbone Source control and connect it to the ADO.NET Destination.

Configure the SQL Server Destination

Follow the steps below to specify the SQL server table to load the Carbone data into.

1. Open the ADO.NET Destination and add a New Connection. Enter your server and database information here.
2. In the Data access mode menu, select "table or view".
3. In the Table Or View menu, select the table or view to populate.
4. Configure any properties you wish to on the Mappings screen.

Run the Project

You can now run the project. After the SSIS Task has finished executing, your database will be populated with Carbone data.