Ready to get started?

Download a free trial of the Adobe Analytics Driver to get started:

 Download Now

Learn more:

Adobe Analytics Icon Adobe Analytics JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Adobe Analytics data including Metrics, Users, Reports, Segments, and more!

Configure the CData JDBC Driver for Adobe Analytics in a Connection Pool in Tomcat



Connect to Adobe Analytics data from a connection pool in Tomcat.

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to Adobe Analytics data from a connection pool in Tomcat.

Connect to Adobe Analytics Data through a Connection Pool in Tomcat

  1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
  2. Add a definition of the resource to the context. Specify the JDBC URL here.

    Adobe Analytics uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the "Getting Started" section of the help documentation for a guide.

    Retrieving GlobalCompanyId

    GlobalCompanyId is a required connection property. If you do not know your Global Company ID, you can find it in the request URL for the users/me endpoint on the Swagger UI. After logging into the Swagger UI Url, expand the users endpoint and then click the GET users/me button. Click the Try it out and Execute buttons. Note your Global Company ID shown in the Request URL immediately preceding the users/me endpoint.

    Retrieving Report Suite Id

    Report Suite ID (RSID) is also a required connection property. In the Adobe Analytics UI, navigate to Admin -> Report Suites and you will get a list of your report suites along with their identifiers next to the name.

    After setting the GlobalCompanyId, RSID and OAuth connection properties, you are ready to connect to Adobe Analytics.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Adobe Analytics JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.adobeanalytics.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    You can see the JDBC URL specified in the resource definition below.

    <Resource name="jdbc/adobeanalytics" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.adobeanalytics.AdobeAnalyticsDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:adobeanalytics:GlobalCompanyId=myGlobalCompanyId; RSID=myRSID; OAuthClientId=myOauthClientId; OauthClientSecret=myOAuthClientSecret; CallbackURL=myCallbackURL;" maxActive="20" maxIdle="10" maxWait="-1" />

    To allow a single application to access Adobe Analytics data, add the code above to the context.xml in the application's META-INF directory.

    For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to Adobe Analytics for all applications.

  3. Add a reference to the resource to the web.xml for the application. Adobe Analytics data JSP jdbc/AdobeAnalytics javax.sql.DataSource Container
  4. Initialize connections from the connection pool: Context initContext = new InitialContext(); Context envContext = (Context)initContext.lookup("java:/comp/env"); DataSource ds = (DataSource)envContext.lookup("jdbc/AdobeAnalytics"); Connection conn = ds.getConnection();

More Tomcat Integration

The steps above show how to connect to Adobe Analytics data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.