VOOZH about

URL: https://www.cdata.com/kb/tech/eloquareporting-jdbc-jaydebeapi.rst

⇱ Use JayDeBeApi to access Oracle Eloqua Reporting Data in Python


Use JayDeBeApi to access Oracle Eloqua Reporting Data in Python

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use standard Python scripting and the development environment of your choice to access live Oracle Eloqua Reporting data.

Access Oracle Eloqua Reporting data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Oracle Eloqua Reporting and the JayDeBeApi module to work with remote Oracle Eloqua Reporting data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Oracle Eloqua Reporting and visualize Oracle Eloqua Reporting data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Oracle Eloqua Reporting data in Python using SQL.

Oracle Eloqua Reporting supports the following authentication methods:

  • Basic authentication (User and Password)
  • OAuth 2.0 code grant flow
  • OAuth 2.0 password grant flow

Basic Authentication (User and Password)

To perform authentication with a user and password, specify these properties:

  • AuthScheme: Basic.
  • Company: The company name associated with your Oracle Eloqua Reporting account.
  • User: Your login account name.
  • Password: Your login password.

OAuth Authentication (Code Grant Flow)

To authenticate with the OAuth code grant flow, you must set AuthScheme to OAuth and create a custom OAuth application. For information about how to create a custom OAuth application, see the Help documentation.

Then set the following properties:

  • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
  • OAuthClientId: The client Id assigned when you registered your application.
  • OAuthClientSecret: The client secret that was assigned when you registered your application.
  • CallbackURL: The redirect URI that was defined when you registered your application.

When you connect, the driver opens Oracle Eloqua Reporting's OAuth endpoint in your default browser. Log in and grant permissions to the application. When the access token expires, the driver refreshes it automatically.

OAuth Authentication (Password Grant Flow)

With the OAuth password grant flow, you can use your OAuth application's credentials alongside your user credentials to authenticate without the need to grant permission manually via a browser prompt. You must create an OAuth app (see the Help documentation) to use this authentication method.

Set the following properties:

  • AuthScheme: OAuthPassword
  • Company: The company's unique identifier.
  • User: Your login account name.
  • Password: Your login password.
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Built-in Connection String Designer

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

java -jar cdata.jdbc.oracleeloquareporting.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:oracleeloquareporting:AuthScheme=Basic;User=user;Password=password;Company=MyCompany;"

Access Oracle Eloqua Reporting data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.oracleeloquareporting.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Oracle Eloqua Reporting:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:oracleeloquareporting:AuthScheme=Basic;User=user;Password=password;Company=MyCompany;"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.oracleeloquareporting.jar"

conn = jaydebeapi.connect(
 "cdata.jdbc.oracleeloquareporting.OracleEloquaReportingDriver",
 jdbc_url,
 [username, password],
 jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM ;")


results = cursor.fetchall()
for row in results:
 print(row)

cursor.close()
conn.close()

Free trial & more information

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

Ready to get started?

Download a free trial of the Oracle Eloqua Reporting Driver to get started:

 Download Now

Learn more:

👁 Oracle Eloqua Reporting Icon
Oracle Eloqua Reporting JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Oracle Eloqua Reporting.