Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Gmail Reporting in OBIEE with the Gmail JDBC Driver
Deploy the Gmail JDBC driver on OBIEE to provide real-time reporting across the enterprise.
The CData JDBC Driver for Gmail is a standard database driver that can integrate real-time access to Gmail data into your Java-based reporting server. This article shows how to deploy the driver to Oracle Business Intelligence Enterprise Edition (OBIEE) and create reports on Gmail data that reflect any changes.
Deploy the JDBC Driver
Follow the steps below to add the JDBC driver to WebLogic's classpath.
For WebLogic 12.2.1, simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.
You can also manually add the driver to the classpath: This is required for earlier versions. Prepend the following to PRE_CLASSPATH in setDomainEnv.cmd (Windows) or setDomainEnv.sh (Unix). This script is located in the bin subfolder of the folder for that domain. For example: ORACLE_HOME\user_projects\domains\MY_DOMAIN\bin.
set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.gmail.jar;%PRE_CLASSPATH%
Restart all servers; for example, run the stop and start commands in DOMAIN_HOME\bitools\bin.
Create a JDBC Data Source for Gmail
After deploying the JDBC driver, you can create a JDBC data source from BI Publisher.
- Log into BI Publisher, at the URL http://localhost:9502/analytics, for example, and click Administration -> Manage BI Publisher.
- Click JDBC Connection -> Add Data Source.
- Enter the following information:
- Data Source Name: Enter the name that users will create connections to in their reports.
- Driver Type: Select Other.
- Database DriverClass: Enter the driver class, cdata.jdbc.gmail.GmailDriver.
- Connection String: Enter the JDBC URL.
There are two ways to authenticate to Gmail. Before selecting one, first ensure that you have enabled IMAP access in your Gmail account settings. See the "Connecting to Gmail" section under "Getting Started" in the installed documentation for a guide.
The User and Password properties, under the Authentication section, can be set to valid Gmail user credentials.
Alternatively, instead of providing the Password, you can use the OAuth authentication standard. To access Google APIs on behalf on individual users, you can use the embedded credentials or you can register your own OAuth app.
OAuth also enables you to use a service account to connect on behalf of users in a Google Apps domain. To authenticate with a service account, you will need to register an application to obtain the OAuth JWT values.
In addition to the OAuth values, you will need to provide the User. See the "Getting Started" chapter in the help documentation for a guide to using OAuth.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Gmail JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.gmail.jar
Fill in the connection properties and copy the connection string to the clipboard.
When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
A typical JDBC URL is below:
jdbc:gmail:User=username;Password=password;
- Username: Enter the username.
- Password: Enter the password.
- In the Security section, select the allowed user roles.
Create Real-Time Gmail Reports
You can now create reports and analyses based on real-time Gmail data. Follow the steps below to use the standard report wizard to create an interactive report that reflects any changes to Gmail data.
- On the global header, click New -> Data Model.
- On the Diagram tab, select SQL query in the menu.
- Enter a name for the query and in the Data Source menu select the Gmail JDBC data source you created.
- Select standard SQL and enter a query like the following:
SELECT Subject, Size FROM Inbox
- Click View Data to generate the sample data to be used as you build your report.
- Select the number of rows to include in the sample data, click View, and then click Save As Sample Data.
- Click Create Report -> Use Data Model.
- Select Guide Me and on the Select Layout page select the report objects you want to include. In this example we select Chart and Table.
- Drop a numeric column like Size onto the Drop Value Here box on the y-axis. Drop a dimension column like Subject onto the Drop Label Here box on the x-axis.
- Click Refresh to pick up any changes to the Gmail data.