Integrating the CData JDBC Driver for Google Cloud Storage with Ignition SCADA

Somya Sharma
Somya Sharma
Technical Marketing Engineer
Connect Ignition SCADA to live Google Cloud Storage data using the CData JDBC Driver, with no ETL or replication required.

Ignition is an industrial supervisory control and data acquisition (SCADA) and industrial Internet of Things (IIoT) platform from Inductive Automation. Its central Gateway service manages device connections, tags, and database connections. Ignition doesn't ship with a connector for Google Cloud Storage, so reaching Google Cloud Storage data usually means custom middleware or manual exports.

The CData JDBC Driver for Google Cloud Storage bridges this gap by exposing Google Cloud Storage as a standard Java Database Connectivity (JDBC) data source. Ignition treats any JDBC driver as a standard database connection. Once the driver is registered in the Gateway, you can query live Google Cloud Storage data from the Script Console, SQL Bridge, tags, or a Perspective or Vision screen, without replication, custom connectors, or extract, transform, load (ETL) pipelines.

This guide outlines the steps to install and commission Ignition, register the CData JDBC Driver for Google Cloud Storage, create the connection, and verify it with a live query.

Prerequisites

  • Ignition for Windows (Windows 10/11 or Windows Server), with administrator rights to install a Windows service
  • CData JDBC Driver for Google Cloud Storage
  • A Google Cloud Storage account with valid credentials and application programming interface (API) access enabled
  • A supported desktop browser (Google Chrome, Mozilla Firefox, Microsoft Edge, or Safari) to open the Gateway web interface

Step 1: Install and set up Ignition

If Ignition is already installed and running, skip to Step 2.

Download Ignition

  1. Go to the Inductive Automation downloads page and download Ignition for Windows. Downloading Ignition
  2. This single download is the full Ignition Gateway installer. It includes both the Gateway service and the Designer Launcher, so you don't need a separate Designer download.

Install Ignition

  1. Run the installer, accept the license agreement, and choose an install location.
  2. Leave Install as a Windows Service checked so the Gateway starts with Windows.
  3. Finish the installer. The Gateway service starts, and a browser window opens to http://localhost:8088 and shows the Commissioning wizard. If the page shows a Browser Not Supported notice, open the same address in Chrome, Firefox, Edge, or Safari.

Commission the Gateway

  1. In the Commission Ignition Gateway wizard, set a Gateway Name and create an administrator username and password.
  2. Accept the End User License Agreement, then start a trial or activate a purchased Ignition license.
  3. When commissioning finishes, log in with the administrator account. You land on the Gateway Home page. Gateway Home page after login

Note: A trial shows a countdown timer on every Gateway page, and the timer resets when the Gateway service restarts. This is fine for testing, but production use requires a license.

Step 2: Register the CData JDBC Driver in Ignition

Ignition lets you upload any third-party JDBC driver through the Gateway web interface, without touching the file system directly.

  1. Log in to the Gateway as an administrator.
  2. Go to Connections > Databases > Settings, open the Drivers tab, and click Create JDBC Driver.
  3. In the dialog, enter the following:
    • Name: Google Cloud Storage
    • Classname: cdata.jdbc.googlecloudstorage.GoogleCloudStorageDriver
    • Driver Type: Generic
    • Default Validation Query: SELECT Name FROM Buckets LIMIT 1
    Creating the JDBC driver (Salesforce is shown)
  4. Click Create JDBC Driver. In current Ignition 8.3 releases, the create dialog doesn't include a Java archive (JAR) file upload field, so you add the JAR file in the next step.
  5. Open the menu at the right of the new driver row, choose Manage JAR files, upload cdata.jdbc.googlecloudstorage.jar from the lib folder of the driver installation, and save.
  6. Confirm the driver shows an INSTALLED status in the drivers list. Driver showing INSTALLED status (Salesforce is shown)

Step 3: Create the Google Cloud Storage connection

  1. Go to Connections > Databases > Connections and click Create Database Connection.
  2. On the Driver Selection step, select Google Cloud Storage and click Next. Selecting the driver (Salesforce is shown)
  3. On the Database Setup step, set the Name to Google Cloud Storage. Leave Username empty and select None for Password, because the credentials go in the connect URL.
  4. In Connect URL, enter the connection string:
    jdbc:googlecloudstorage:ProjectId='project1';InitiateOAuth=GETANDREFRESH;
    Entering the connection details (Salesforce is shown)
  5. Click Create Database Connection and confirm the connection shows a VALID status on the Database Connections page. Connection showing VALID status (Salesforce is shown)

Connection properties for Google Cloud Storage

Authenticate with a User Account

You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.

When you connect, the Google Cloud Storage OAuth endpoint opens in your default browser. Log in and grant permissions, then the OAuth process completes

Authenticate with a Service Account

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes.

You need to create an OAuth application in this flow. See the Help documentation for more information. After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthJWTCertType: Set this to "PFXFILE".
  • OAuthJWTCert: Set this to the path to the .p12 file you generated.
  • OAuthJWTCertPassword: Set this to the password of the .p12 file.
  • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
  • OAuthJWTIssuer: In the service accounts section, click Manage Service Accounts and set this field to the email address displayed in the service account Id field.
  • OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
  • ProjectId: Set this to the Id of the project you want to connect to.

The OAuth flow for a service account then completes.

Note: If a password or token contains a semicolon, the connect URL breaks, so reset it to a value without one.

Step 4: Query live Google Cloud Storage data from Ignition

With the connection valid, you can query live Google Cloud Storage data from the Designer.

  1. Open the Ignition Designer Launcher, select your Gateway (click Add Designer and enter http://localhost:8088 if it isn't listed), and click Open Designer. Log in with the Gateway administrator account. Logging in to the Designer from the Designer Launcher
  2. Open or create a project. The Designer opens with the Project Browser, Tag Browser, and Component Palette panels. Ignition Designer main window
  3. In the Designer, go to Tools > Script Console. In the Multiline Buffer, enter a test query and click Execute. Replace Buckets with any table available in your Google Cloud Storage connection:
    print system.db.runQuery(
        "SELECT Name, OwnerId FROM Buckets LIMIT 10",
        "Google Cloud Storage")
    Running the test query in the Script Console (Salesforce is shown)
  4. A successful query prints PyDataset rows:10 cols:2 in the Interactive Interpreter panel, which confirms Ignition retrieved live data from Google Cloud Storage through the CData JDBC Driver.

Note: The connection name in the script must match the name you gave the connection in Step 3.

Step 5: Verify the results

  1. Print the rows and compare the values with the same records in Google Cloud Storage:
    ds = system.db.runQuery("SELECT Name, OwnerId FROM Buckets LIMIT 10", "Google Cloud Storage")
    for row in ds:
        print row["Name"], row["OwnerId"]
  2. Optionally, run a second query against another table and a filtered query to confirm schema discovery and filtering.
  3. Optionally, restart the Gateway service and confirm the connection returns to VALID.

Troubleshooting

Symptom Likely cause and fix
Driver status shows ERRORThe classname is wrong, or the JAR file hasn't been uploaded through Manage JAR files.
Connection status shows FAULTEDThe credentials are wrong, outbound web traffic (HTTPS) is blocked, or the CData license isn't found. Click the status to read the error.
Error: Could not find a valid licenseThe Gateway runs as a Windows service and can't read a license stored in your user profile. In an administrator command prompt, run java -jar cdata.jdbc.googlecloudstorage.jar --license from the driver's lib folder, copy the generated .lic file to C:\Windows\system32\config\systemprofile\.CData\, and restart the Gateway service.
Database connection not foundThe connection name in the script doesn't match the Gateway connection name exactly.

Test the driver outside Ignition

To confirm the driver works independently of the Gateway, run this standalone Java example. The cdata.jdbc.googlecloudstorage.jar and cdata.jdbc.googlecloudstorage.lic files must be in the same directory and on the classpath.

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;

public class CDataExample {
    public static void main(String[] args) throws Exception {
        Class.forName("cdata.jdbc.googlecloudstorage.GoogleCloudStorageDriver");
        String connectionString = "jdbc:googlecloudstorage:ProjectId='project1';InitiateOAuth=GETANDREFRESH;";
        try (Connection conn = DriverManager.getConnection(connectionString)) {
            Statement stmt = conn.createStatement();
            ResultSet rs = stmt.executeQuery("SELECT Name, OwnerId FROM Buckets LIMIT 10");
            while (rs.next()) {
                System.out.println(rs.getString("Name") + ", " + rs.getString("OwnerId"));
            }
        }
    }
}

Build live, governed Google Cloud Storage connectivity in Ignition with CData

With the CData JDBC Driver for Google Cloud Storage registered, your team can query live Google Cloud Storage data from Ignition without ETL infrastructure, manual exports, or custom integration code, and reuse the same connection in tags, SQL Bridge, and Perspective or Vision screens.

Start your free trial today to see how you can give Ignition live, secure access to hundreds of external systems with CData.

Ready to get started?

Download a free trial of the Google Cloud Storage Driver to get started:

 Download Now

Learn more:

Google Cloud Storage Icon Google Cloud Storage JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Google Cloud Storage data including Buckets, Objects, and more!