Build Data Flows from ApprovalMax 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 ApprovalMax inside of a SQL Server SSIS workflow to transfer ApprovalMax data into a Microsoft SQL Server database.
Add the Components
To get started, add a new ApprovalMax source and SQL Server ADO.NET destination to a new data flow task.
Create a New Connection Manager
Follow the steps below to save ApprovalMax connection properties in a connection manager.
- In the Connection Manager window, right-click and then click New Connection. The Add SSIS Connection Manager dialog is displayed.
- In the Connection Manager type menu, select API. The CData ApprovalMax Connection Manager is displayed.
- Configure connection properties.
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.
Configure the ApprovalMax Source
Follow the steps below to specify the query to be used to extract ApprovalMax data.
- Double-click the ApprovalMax source to open the source component editor.
- In the Connection Manager menu, select the connection manager previously created.
- Specify the query to use for the data extraction. For example:
SELECT UserId, Email FROM UserProfiles WHERE CompanyId = '00000000-0000-0000-0000-000000000000'
- Close the ApprovalMax 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 ApprovalMax data into.
- Open the ADO.NET Destination and add a New Connection. Enter your server and database information here.
- In the Data access mode menu, select "table or view".
- In the Table Or View menu, select the table or view to populate.
- 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 ApprovalMax data.