Configure ServiceNow SQL API ODBC driver on client machine

Configure connection settings for the installed ODBC driver including server URL and authentication credentials to enable data access from BI tools to your ServiceNow instance.

Before you begin

• You have a valid ServiceNow credentials for a Service Account with the required roles assigned. See Create a Service Account and assign Roles for more information.
• Your client machine's IP address is included in the SQL API IP filter criteria. See Create IP filter criteria for more information.
• You have the necessary connection parameters including your ServiceNow instance URL and Service Account credentials.

Role required: local administrator on client machine for installation

About this task

After installing the ServiceNow SQL API ODBC driver on your client machine, you must configure the connection settings to establish a secure connection to your ServiceNow instance. After configuration, you can test the connection to verify that your client machine can successfully communicate with the ServiceNow SQL API.

Procedure

1. Open the Start Menu.
2. Select and hold (or right-click) on the Management Console.
3. Select Run as Administrator.
4. Navigate to ServiceNow SQL API - ODBC Manager > Manager (local configuration) > <drive>:\Program Files\ServiceNow\ODBC\cfg\oadm.in > Services > >ServiceNow_ODBC > Service Settings > IP Parameters.Navigate to ServiceNow SQL API - ODBC Manager > Manager (local configuration) > <drive>:\Program Files\ServiceNow\ODBC\cfg\oadm.in > Services > >ServiceNow_ODBC > Service Settings > IP Parameters.
5. Open the ServiceJVMClassPath parameter.
   
6. Append the value, separated by semicolons, with the location where the bc-fips-2.0.0.jar, bcutil-fips-2.0.3.jar, and bcpkix-fips-2.0.7.jar files are extracted.

   See Download the SQL API drivers on client machine to locate the JAR files.

   For example, the JAR file location follows this pattern:

   <Windows-machine-local-path>\<folder-name>\bc-fips-2.0.0.jar;<Windows-machine-local-path>\<folder-name>\bcpkix-fips-2.0.7.jar;<Windows-machine-local-path>\<folder-name>\bcutil-fips-2.0.3.jar.

   If you change the location of the JAR files, you must update the path in the ServiceJVMClassPath parameter.

7. Open the Start Menu.
8. Select and hold (or right-click) on ODBC Data Source Administrator (32-bit or 64-bit) based on the ODBC driver you installed.
9. Select Run as Administrator.
10. Select the System DSN tab.
11. Create a DSN or configure an existing DSN (32-bit or 64-bit) based on the ODBC driver you installed.
12. In the SN ServiceNow Local ODBC Driver Setup dialog, configure the following connection settings:

    Field	Value
    Data Source Name	Any descriptive name such as Instance1 Use one name per connected instance.
    Description	This is optional.
    Service Name	ServiceNow_ODBC This field must match exactly as set in ODBC Data Source details.
    Service Data Source	ServiceNow This field must match exactly as set in ODBC Data Source details.
    Custom Properties	url=https://<instance>.service-now.com Enter your ServiceNow instance URL.

    
13. Select Apply.
14. Verify the connection by selecting Test Connection and entering the Service Account username and password.

    If the test is successful, you will see a confirmation message indicating that the connection was established.

15. Save the data source configuration by selecting OK.
16. Close the ODBC Data Source Administrator by selecting OK.

Result

The ServiceNow SQL API ODBC driver is configured on your client machine. You can connect your ODBC-compatible applications, such as Power BI, or Excel, to this data source to access your ServiceNow data.

What to do next

You can use Interactive SQL application to verify the connection and test SQL queries. See Test SQL API ODBC driver connection using Interactive SQL.