Access Live ApprovalMax Data in Coginiti Pro

Coginiti Pro is a single tool for all your SQL data and analytics needs, designed specifically for data engineers, analysts, and data scientists. When paired with the CData API Driver for JDBC, Coginiti Pro can access and query live ApprovalMax data. This article describes how to connect to and query ApprovalMax data from Coginiti Pro.

With built-in optimized data processing, the CData API Driver for JDBC offers unmatched performance for interacting with live ApprovalMax data. When you issue complex SQL queries to ApprovalMax, the driver pushes supported SQL operations, like filters and aggregations, directly to ApprovalMax and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). In addition, its built-in dynamic metadata querying allows you to work with and analyze ApprovalMax data using native data types.

Gather Connection Properties and Build a Connection String

Download the CData API Driver for JDBC installer, unzip the package, and run the JAR file to install the driver. Then gather the required 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.

NOTE: To use the JDBC driver in Coginiti Pro, you may need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Built-in Connection String Designer

For assistance constructing the JDBC URL, use the connection string designer built into the ApprovalMax JDBC Driver. Double-click the JAR file or execute the jar file from the command line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties (including the RTK) and copy the connection string to the clipboard.

Create a JDBC Data Source for ApprovalMax Data

1. Open Coginiti Pro and in the File menu, select "Edit Drivers."
2. In the newly opened wizard, click "Add" and select "Generic."

3. In the "JDBC Drivers" wizard, set the driver properties (below) and click "Create Driver."

   • Set JDBC Driver Name to a useful name, like CData JDBC Driver for ApprovalMax.
   • Click "Add Files" to add the JAR file from the "lib" folder in the installation directory (e.g. cdata.jdbc.api.jar)
   • Select the Class Name: cdata.jdbc.api.APIDriver.
   

Create a Connection using the CData API Driver for JDBC

1. In the File menu, click "Edit Connections."
2. In the newly opened wizard, click "Add" and select "Generic."
3. In the "Connections" wizard, set the connection properties.
   • Set Connection name to an identifying name.
   • Set Database JDBC driver to the Driver you configured earlier.
   • Set JDBC URL to the JDBC URL configured using the built-in connection string designer (e.g. jdbc:api:Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;
   
4. Click "Test" to ensure the connection is configured properly. Click "Save."

Query ApprovalMax Using SQL

1. Open the Connections tab by clicking on database icon: .
2. Click the plus sign () to add a new query tab.

3. Once the query console is open, write the SQL script you wish to execute and click "Run at Cursor".

   NOTE: You can use the explorer on the left to determine table/view names and column names.

   Using the explorer

   1. In the "Select connection" field, select the connection you wish to query.
   2. Expand your newly created connection, expand the "CData" catalog, and expand the ApprovalMax catalog.
   3. Expand "Tables" or "Views" to find the entity you wish to query.
   4. Expand your selected entity to explore the fields (columns).
   

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live ApprovalMax data in Coginiti Pro. Reach out to our Support Team if you have any questions.