Configuring ServiceNow SQL API - JDBC Driver on Client Machine

Configure the JDBC driver settings on your client machine to establish a connection to your ServiceNow instance and access data through the SQL API.

Before you begin

Before you begin, ensure the following prerequisites are met:

• The SQL API plugin is installed and configured on your ServiceNow instance.
• You have downloaded the ServiceNow SQL API JDBC driver to your client machine.
• Java Runtime Environment (JDK 17 or later) is installed on your client machine.
• You have a valid Service Account with the sn_jdbc_rest_access role assigned.
• Your client machine's IP address is included in the SQL API IP filter criteria.
• You have the necessary connection parameters including your ServiceNow instance URL, Service Account credentials, and target database name.

Role required: admin

About this task

The JDBC driver configuration enables your BI tools and analytics platforms to connect to ServiceNow using standard database connection protocols. After configuring the JDBC driver, your applications can execute SQL queries against authorized ServiceNow tables through the SQL API.

The ServiceNow SQL API supports JDBC version 1.0 or later and requires Java Development Kit (JDK) 17 as the minimum supported Java runtime version.

Procedure

1. Locate the downloaded ServiceNow JDBC driver file on your client machine.

   The driver file is typically named servicenow-jdbc-driver.jar or similar.

2. Add the JDBC driver to your application's classpath or configure it in your BI tool's driver management section.

   The method for adding the driver varies depending on your application. Consult your BI tool's documentation for specific instructions on adding custom JDBC drivers.

3. Configure the JDBC connection URL using the following format:

   jdbc:servicenow://<instance-name>.service-now.com:443/<database-name>

   Replace <instance-name> with your ServiceNow instance name and <database-name> with the target database identifier.

4. Enter the Service Account credentials:
   • Username: Enter the User ID of the Service Account with the sn_jdbc_rest_access role.
   • Password: Enter the password for the Service Account.
5. Configure additional connection parameters as needed:
   • SSL/TLS: Ensure SSL is enabled for secure connections (default port 443).
   • Timeout settings: Configure connection and query timeout values based on your network conditions.
   • Connection pooling: Enable connection pooling if supported by your application for improved performance.
6. Test the connection to verify that the JDBC driver can successfully connect to your ServiceNow instance.

   Most BI tools and database clients provide a "Test Connection" button. Use this feature to validate your configuration before proceeding.

7. If the connection test fails, verify the following:
   • The Service Account has the sn_jdbc_rest_access role assigned.
   • Your client machine's IP address is included in the SQL API IP filter criteria.
   • The connection URL, username, and password are correct.
   • Your ServiceNow instance is accessible from your client machine.
   • The SQL API plugin is active on your ServiceNow instance.

Result

After successfully configuring the JDBC driver, your BI tool or application can connect to ServiceNow and execute SQL queries against authorized tables. You can now query ServiceNow data directly without requiring data export or replication.

Remember that SQL API access is read-only and subject to your ServiceNow Access Control List (ACL) configuration. You can only query tables for which the Service Account has been granted egress_sql and read permissions.

The SQL API enforces a query rate limit of 500 queries per hour per Service Account.