Back Up ApprovalMax data to SQL Server through SSIS

This article illustrates using the ApprovalMax ADO.NET Data Provider within a SQL Server SSIS workflow for the direct transfer of ApprovalMax 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 ApprovalMax.

5. In the connection manager, enter the connection details for ApprovalMax data.

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

   ApprovalMax API Profile Settings

   To authenticate to ApprovalMax and connect to your own data or to allow other users to connect to their data, the ApprovalMax Public API requires the OAuth 2.0 authorization code flow.

   First, you will need to register an OAuth application with ApprovalMax. Sign in to the ApprovalMax Developer Portal (https://developer.approvalmax.com/applications) and create a new application. Your OAuth application will be assigned a Client ID and a Client Secret, and you must register at least one Redirect URI (Callback URL).

   A Premium ApprovalMax subscription (or active trial) is required to use the Public API.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to OAuth.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
   • OAuthClientId: Set this to the Client ID that is shown in your application settings on the ApprovalMax Developer Portal.
   • OAuthClientSecret: Set this to the Client Secret that is shown in your application settings on the ApprovalMax Developer Portal.
   • CallbackURL: Set this to the Redirect URI that is registered in your application settings.
   • Scope: (Optional) Override the default OAuth scopes. The default value openid offline_access https://www.approvalmax.com/scopes/public_api/read grants read-only access to all tables in this profile and enables refresh tokens. Use the principle of least privilege when narrowing this scope.

   The OAuth Authorization URL is https://identity.approvalmax.com/connect/authorize and the Token URL is https://identity.approvalmax.com/connect/token. Both authorization_code and refresh_token grant types are supported.

   

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 UserId, Email FROM UserProfiles WHERE CompanyId = '00000000-0000-0000-0000-000000000000'

   
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 ApprovalMax data.