ODBC Driver for Adobe Analytics

Build 24.0.9060

macOS DSN Configuration

This section shows how to set up ODBC connectivity and configure DSNs on macOS.

Minimum macOS Version

The CData ODBC Driver for Adobe Analytics driver requires macOS Sierra (10.12) or above.

Licensing the Driver

In a terminal, run the following commands to license the driver. To activate a trial, omit the <key> input. 

cd "/Applications/CData ODBC Driver for Adobe Analytics/bin"
sudo ./install-license.sh <key>

You'll be prompted for a name and password. These refer to your name and your machine's password.

Connecting to Adobe Analytics

To connect to Adobe Analytics, both the GlobalCompanyId and RSID must be identified. By default, the driver attempts to identify your company and report suite automatically. However, you can also specify these values explicitly:

Global Company Id

The GlobalCompanyId is an optional connection property. If left empty, the driver attempts to automatically detect the Global Company ID. To find the Global Company ID:

  1. Locate it in the request URL for the users/me endpoint on the Swagger UI.
  2. Expand the users endpoint, then click GET users/me.
  3. Click Try it out > Execute.
  4. Set the GlobalCompanyId connection property to the Global Company ID shown in the request URL immediately preceding the users/me endpoint.

Report Suite Id

RSID is also an optional connection property. If not set, the driver tries to detect it automatically. To view all of your report suites and their identifiers, go to Admin > Report Suites.

Authenticating to Adobe Analytics

Adobe Analytics uses the OAuth authentication standard. You can authenticate with OAuth integration or Service Account integration.

User Accounts (OAuth)

You must set AuthScheme to OAuth for all user account flows.

NOTE: Adobe authentication via OAuth requires updating your refresh token every two weeks. As an alternative, you can use the OAuthJWT method, but be aware that this method will be deprecated by January 2025. Adobe recommends migrating to the Server-to-Server OAuth method for continued access.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop authentication. Alternatively, you can create a custom OAuth application. Review Creating a Custom OAuth App for more information.

Get and Refresh the OAuth Access Token

Set the following properties to connect:

  • OAuthClientId (custom applications only): Set to the client Id assigned when you registered your app.
  • OAuthClientSecret (custom applications only): Set to the client secret assigned when you registered your app.
  • CallbackURL (custom application only): Set to the redirect URI defined when you registered your app. For example: https://localhost:3333
When you connect, the driver opens Adobe Analytics's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver refreshes the access token automatically when it expires.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

  1. Choose one of two options:
    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the driver on a machine with an Internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
  2. Then configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.

  1. Choose one of these options:
    • If you are using the Embedded OAuth Application, call the GetOAuthAuthorizationURL stored procedure. Open the URL returned by the stored procedure in a browser.
    • If you are using a custom OAuth application, set the following properties:
      • InitiateOAuth: Set to OFF.
      • OAuthClientId: Set to the client Id assigned when you registered your application.
      • OAuthClientSecret: Set to the client secret assigned when you registered your application.
      Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
  2. Log in and grant permissions to the driver. You are then redirected to the redirect URI. There will be a parameter called code appended to the redirect URI. Note the value of this parameter. Later you will set this in the OAuthVerifier connection property.
Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthVerifier: Set this to the noted verifier code (the value of the code parameter in the redirect URI).
  • OAuthClientId (custom applications only): Set this to the client Id in your custom OAuth application settings.
  • OAuthClientSecret (custom applications only): Set this to the client secret in the custom OAuth application settings.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

Test the connection to generate the OAuth settings file, then re-set the following properties to connect:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the driver to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to install and create a connection with the driver on a device that supports an Internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the driver to enable the automatic refreshing of the access token.

Service Account

Service accounts have silent authentication, which does not require user authentication in the browser.
You need to create an application for this flow. Review Creating a Custom OAuth App to create and authorize an application. You can then connect to Adobe Analytics data that the service account has permission to access.

Server-to-Server OAuth

Set the AuthScheme to OAuthClient to authenticate with this method.

Set the following properties to connect:

  • OAuthClientId: Set to the client Id in your app settings.
  • OAuthClientSecret: Set to the client secret in your app settings.

When you connect, the driver completes the OAuth flow for a service account.

JWT OAuth

Set the AuthScheme to OAuthJWT to authenticate with this method.

Note: OAutJWT is currently supported as an AuthScheme, but support ends in January 2025. Adobe recommends migrating to the Server-to-Server OAuth method for continued access.

Set the following properties to connect:

  • OAuthClientId: Set to the client Id in your app settings.
  • OAuthClientSecret: Set to the client secret in your app settings.
  • OAuthJWTCertType: Set to "PUBLIC_KEY_FILE".
  • OAuthJWTCert: Set to the path to the .key file you generated.
  • OAuthJWTCertPassword: Set to the password of the .key file.
  • OAuthJWTIssuer: Set to your Organization ID from the Adobe I/O Console integration in the format org_ident@AdobeOrg. This identifies the organization that was configured for access to the Adobe I/O API.

When you connect, the driver completes the OAuth flow for a service account.

Uninstalling the Driver

The easiest way to uninstall the driver is to open a terminal and run the included uninstall.sh script, located in the installation directory. For example: 

cd "/Applications/CData ODBC Driver for Adobe Analytics"
sudo ./uninstall.sh

Note: The script needs to be run from the installation directory.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060