Integrating the CData JDBC Driver for SQL Analysis Services with Ignition SCADA
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 SQL Analysis Services, so reaching SQL Analysis Services data usually means custom middleware or manual exports.
The CData JDBC Driver for SQL Analysis Services bridges this gap by exposing SQL Analysis Services 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 SQL Analysis Services 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 SQL Analysis Services, 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 SQL Analysis Services
- A SQL Analysis Services 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
-
Go to the Inductive Automation downloads page and download Ignition for Windows.
- 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
- Run the installer, accept the license agreement, and choose an install location.
- Leave Install as a Windows Service checked so the Gateway starts with Windows.
- 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
- In the Commission Ignition Gateway wizard, set a Gateway Name and create an administrator username and password.
- Accept the End User License Agreement, then start a trial or activate a purchased Ignition license.
-
When commissioning finishes, log in with the administrator account. You land on the Gateway Home page.
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.
- Log in to the Gateway as an administrator.
- Go to Connections > Databases > Settings, open the Drivers tab, and click Create JDBC Driver.
-
In the dialog, enter the following:
- Name: SQL Analysis Services
- Classname: cdata.jdbc.ssas.SSASDriver
- Driver Type: Generic
- Default Validation Query: SELECT Fiscal_Year FROM Adventure_Works LIMIT 1
- 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.
- Open the menu at the right of the new driver row, choose Manage JAR files, upload cdata.jdbc.ssas.jar from the lib folder of the driver installation, and save.
-
Confirm the driver shows an INSTALLED status in the drivers list.
Step 3: Create the SQL Analysis Services connection
- Go to Connections > Databases > Connections and click Create Database Connection.
-
On the Driver Selection step, select SQL Analysis Services and click Next.
- On the Database Setup step, set the Name to SQL Analysis Services. Leave Username empty and select None for Password, because the credentials go in the connect URL.
-
In Connect URL, enter the connection string:
jdbc:ssas:User=myuseraccount;Password=mypassword;URL=http://localhost/OLAP/msmdpump.dll;
-
Click Create Database Connection and confirm the connection shows a VALID status on the Database Connections page.
Connection properties for SQL Analysis Services
To connect, provide authentication and set the Url property to a valid SQL Server Analysis Services endpoint. You can connect to SQL Server Analysis Services instances hosted over HTTP with XMLA access. See the Microsoft documentation to configure HTTP access to SQL Server Analysis Services.
To secure connections and authenticate, set the corresponding connection properties, below. The data provider supports the major authentication schemes, including HTTP and Windows, as well as SSL/TLS.
-
HTTP Authentication
Set AuthScheme to "Basic" or "Digest" and set User and Password. Specify other authentication values in CustomHeaders.
-
Windows (NTLM)
Set the Windows User and Password and set AuthScheme to "NTLM".
-
Kerberos and Kerberos Delegation
To authenticate with Kerberos, set AuthScheme to NEGOTIATE. To use Kerberos delegation, set AuthScheme to KERBEROSDELEGATION. If needed, provide the User, Password, and KerberosSPN. By default, the data provider attempts to communicate with the SPN at the specified Url.
-
SSL/TLS:
By default, the data provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats.
You can then access any cube as a relational table: When you connect the data provider retrieves SSAS metadata and dynamically updates the table schemas. Instead of retrieving metadata every connection, you can set the CacheLocation property to automatically cache to a simple file-based store.
See the Getting Started section of the CData documentation, under Retrieving Analysis Services Data, to execute SQL-92 queries to the cubes.
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 SQL Analysis Services data from Ignition
With the connection valid, you can query live SQL Analysis Services data from the Designer.
-
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.
-
Open or create a project. The Designer opens with the Project Browser, Tag Browser, and Component Palette panels.
-
In the Designer, go to Tools > Script Console. In the Multiline Buffer, enter a test query and click Execute. Replace Adventure_Works with any table available in your SQL Analysis Services connection:
print system.db.runQuery( "SELECT Fiscal_Year, Sales_Amount FROM Adventure_Works LIMIT 10", "SQL Analysis Services")
- A successful query prints PyDataset rows:10 cols:2 in the Interactive Interpreter panel, which confirms Ignition retrieved live data from SQL Analysis Services 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
-
Print the rows and compare the values with the same records in SQL Analysis Services:
ds = system.db.runQuery("SELECT Fiscal_Year, Sales_Amount FROM Adventure_Works LIMIT 10", "SQL Analysis Services") for row in ds: print row["Fiscal_Year"], row["Sales_Amount"] - Optionally, run a second query against another table and a filtered query to confirm schema discovery and filtering.
- Optionally, restart the Gateway service and confirm the connection returns to VALID.
Troubleshooting
| Symptom | Likely cause and fix |
|---|---|
| Driver status shows ERROR | The classname is wrong, or the JAR file hasn't been uploaded through Manage JAR files. |
| Connection status shows FAULTED | The 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 license | The 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.ssas.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 found | The 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.ssas.jar and cdata.jdbc.ssas.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.ssas.SSASDriver");
String connectionString = "jdbc:ssas:User=myuseraccount;Password=mypassword;URL=http://localhost/OLAP/msmdpump.dll;";
try (Connection conn = DriverManager.getConnection(connectionString)) {
Statement stmt = conn.createStatement();
ResultSet rs = stmt.executeQuery("SELECT Fiscal_Year, Sales_Amount FROM Adventure_Works LIMIT 10");
while (rs.next()) {
System.out.println(rs.getString("Fiscal_Year") + ", " + rs.getString("Sales_Amount"));
}
}
}
}
Build live, governed SQL Analysis Services connectivity in Ignition with CData
With the CData JDBC Driver for SQL Analysis Services registered, your team can query live SQL Analysis Services 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.