Build Data Flows from ShipEngine 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 ShipEngine inside of a SQL Server SSIS workflow to transfer ShipEngine data into a Microsoft SQL Server database.

Add the Components

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

Create a New Connection Manager

Follow the steps below to save ShipEngine 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 ShipEngine Connection Manager is displayed.
3. Configure connection properties.

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

   ShipEngine API Profile Settings

   Retrieve your ShipEngine API Key from the Dashboard at app.shipengine.com under API Management.

   👁 Configuring a connection (Salesforce is shown).
   

Configure the ShipEngine Source

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

1. Double-click the ShipEngine 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 BatchId, Error FROM BatchErrors WHERE BatchId = 'batch_123'
   

   👁 The SQL query to retrieve records. (Salesforce is shown.)
   
4. Close the ShipEngine 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 ShipEngine 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. 👁 The mappings from the SSIS source component to SQL Server. (Salesforce is shown.)
   

Run the Project

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