Back Up Halo Service Desk data to SQL Server through SSIS

This article illustrates using the Halo Service Desk ADO.NET Data Provider within a SQL Server SSIS workflow for the direct transfer of Halo Service Desk data to a Microsoft SQL Server database. It's worth noting that the identical process detailed below is applicable to any CData ADO.NET Data Providers, enabling the direct connection of SQL Server with remote data through SSIS.

1. Open Visual Studio and create a new Integration Services project.
2. Add a new Data Flow task from the toolbox onto the Control Flow screen.

3. In the Data Flow screen, add an ADO.NET Source and an OLE DB Destination from the toolbox.

   
4. Add a new connection and select .NET Providers\CData ADO.NET Provider for Halo Service Desk.

5. In the connection manager, enter the connection details for Halo Service Desk data.

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

   HaloServiceDesk API Profile Settings

   HaloServiceDesk uses API key authentication. You can find or create API keys in HaloServiceDesk under Administration > Integrations > Halo API.

   Set the following connection properties to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to the API key from your HaloServiceDesk account.
   • Domain: Set this to the hostname of your HaloServiceDesk instance (e.g. yourcompany.haloservicedesk.com).
   

6. Open the DataReader editor and set the following information:

   • ADO.NET connection manager: In the Connection Managers menu, select the Data Connection you just created.
   • Data access mode: Select 'SQL command'.
   • SQL command text: In the DataReader Source editor, open the Component Properties tab and enter a SELECT command, such as the one below:

     SELECT Id, InventoryNumber FROM Assets WHERE ClientId = '1'

   
7. Close the DataReader editor and drag the arrow below the DataReader Source to connect it to the OLE DB Destination.

8. Open the OLE DB Destination and enter the following information in the Destination Component Editor.

   • Connection manager: Add a new connection. Enter your server and database information here. In this example, SQLExpress is running on a separate machine.
   • Data access mode: Set your data access mode to "table or view" and select the table or view to populate in your database.

9. Configure any properties you wish on the Mappings screen.

   
10. Close the OLE DB Destination Editor and run the project. After the SSIS task has finished executing, your database will be populated with data obtained from Halo Service Desk data.