JDBC connectivity
Before you start
- You need your Interact Advanced Analytics configuration details, provided during technical onboarding for Advanced Analytics.
- You need permission to install drivers and edit configuration files on the machine.
Overview
This page covers the JDBC connectivity options for Interact Advanced Analytics, which uses AWS Data Lake technologies for data querying, analysis and retrieval. The tool-specific JDBC guides reference the connection steps here.
Step 1: Install the AWS Athena JDBC driver
Download the latest JDBC driver from the AWS Athena JDBC driver page.
If you need an older version, see the previous JDBC driver versions.
Once downloaded, place the drivers in the appropriate locations for your use case. For example, Tableau requires them here:
- macOS:
~/Library/Tableau/Drivers - Windows:
C:\Program Files\Tableau\Drivers
Other services may require a different setup. Each BI vendor documents its own JDBC setup instructions and binary locations.
Step 2: Set the Athena workgroup
Interact Advanced Analytics provides a separate Workgroup for each customer. You must specify the Workgroup when connecting to Interact Advanced Analytics.
Full documentation on the AWS Athena JDBC configuration is in the Simba Athena JDBC driver install and configuration guide. The workgroup setting is on page 104.
For example, AWS Athena JDBC with Tableau sets a key-value pair in the athena.properties file at ~/My Tableau Repository/Datasources. If the workgroup name provided to you was Inc_Ltd, the file contents should be:
workgroup=Inc_Ltd
Depending on the BI vendor, you specify this in a similar file, via UI Additional Settings inputs, or by other means.
Step 3: Gather your Advanced Analytics configuration
Your Interact Advanced Analytics configuration details are provided during technical onboarding and include:
- Server: for example, athena.eu-west-1.amazonaws.com (can be retrieved from the AWS Athena endpoints page, and can change over time)
- S3 Staging Directory: s3://{{my_bucket}}-results/ (where the query results are saved)
- Access Key ID: equivalent to the username
- Secret Access Key: equivalent to the password
- Workgroup: must be set for connectivity to work. Each vendor accepts and passes this setting to the JDBC driver slightly differently.
- Database: the Athena database where your analytics data is located
- Table Name: the Athena table where your analytics data is located
Advanced JDBC options
The JDBC connector is highly configurable. See the Athena JDBC v3 driver advanced connection parameters.
Ports
Port 443 is used to communicate with the Data Lake, and port 444 is used to stream query results back from the Data Lake to the BI tool. Both ports must be open. See the Athena JDBC driver documentation.