JDBC type data source

  • Release version: Australia
  • Updated March 12, 2026
  • 7 minutes to read

    • A JDBC data source retrieves its data via a JDBC driver, usually type 4 network.

    The JDBC connection is available either directly from the ServiceNow instance (a VPN setup required), or via a dedicated MID Server installed inside your firewall that can access the database port.

    Note:
    JDBC calls from the MID Server are never encrypted. Limit the rights available to the MID Server user whenever making JDBC calls from a MID server.

    JDBC data source supported database formats

    JDBC data sources support several database formats and ports.

    Table 1. Supported database formats
    SQL Server Type Port
    MySQL 3306
    Microsoft SQL Server 1433
    Oracle 1521
    Note:
    Oracle DATE fields are loaded as ServiceNow Date/Time fields.

    JDBC data source SQL statement requirements

    JDBC queries that run SQL statements must specify a column name.

    For example, this query specifies the column name ServerID.
    SELECT DISTINCT 'server_name:' + CONVERT ( VARCHAR , lg .ResourceID ) AS 'ServerID' 
,LastHWScan
,Account0
,Category0
Fromv_GS_WORKSTATION_STATUSsInner  JOIN
v_GS_LocalGroupMembers0lg
ON s .ResourceID  = lg .ResourceID
WhereType0  = 'Local' AND Category0  = 'SystemAccount'

    SQL server integrated authentication for Windows

    A JDBC data source can use the ID of for the Windows MID Server service user to authenticate with SQL Server.

    The Use integrated authentication check box on the Data Source form determines if the JDBC data source uses the MID Server service user credentials. For this field to appear on the Data Source form, the integration must meet these criteria:

    • The MID Server must be running on a Windows computer with SQL Server.
    • The MID Server service must use the same credentials that SQL Server requires.
    • The data source Type is JDBC.
    • The data source Use MID Server check box is selected.
    • The data source Format is SQLServer.
    Important:
    If integrated authentication is chosen, and you are integrating with Microsoft System Center Configuration Manager, the account running the MID Server service must have read rights on the SCCM database.
    Figure 1. Data Source form
    Data Source form
    Note:
    The Last run database field on the JDBC data source is case-sensitive for the SQL server.

    Adding JDBC drivers for unsupported database formats

    Use the following procedure to extend the data source to use a driver for a database that is not provided in the base system. JDBC connections are supported for the following default databases:

    Add a new JDBC format choice

    Extend the available JDBC driver options by creating a new choice list entry to specify the JDBC driver Java package name.

    Before you begin

    Role required: import_admin

    About this task

    Add a new choice list entry for the new database to the Format field in the sys_data_source table.

    Procedure

    1. Navigate to System Import Sets > Administration > Data Sources.
    2. Click New.
    3. In the Data Sources form, right-click the Format field label, and select Show Choice List from the pop-up menu.
      JDBC source list
    4. Click New in the list of choices.
    5. Provide the following values to create the new database choice.
      Look at the existing drivers for examples.
      • Table: sys_data_source
      • Label: Database name that appears as an option in the Format choice list, for example: Teradata.
      • Value: Package name and class of the driver. For example, the value for TeraData is com.ncr.teradata.TeraDriver.
        Note:
        The driver package and class must be provided by the driver vendor. This information is often available in the vendor's documentation, such as for MariaDB or Teradata.
      • Dependent value: JDBC
      JDBC choice list.
    6. Click Submit.

      The new data source now appears in the list of available JDBC formats.

    Add Sybase or DB2 JDBC format choices

    Extend the available JDBC driver options by activating the Sybase or DB2 choices.

    Before you begin

    Roles required: admin

    Important:
    To use Sybase or DB2 JDBC drivers, you must manually install the driver JAR file on a MID server. Refer to KB0551236 for more information.

    About this task

    Activate the Sybase or DB2 JDBC drivers to connect with those database formats through a MID server. This procedure assumes you are using the following Sybase or DB2 drivers:
    Table 2. Drivers
    Format Driver Driver class
    Sybase jconnect-jdbc com.sybase.jdbc3.jdbc.SybDriver
    DB2 db2jcc com.ibm.db2.jcc.DB2Driver

    If you are using a different implementation of the Sybase or DB2 driver, you must modify the choice Value to use the driver class from your driver implementation.

    Procedure

    1. Navigate to System Import Sets > Administration > Data Sources.
    2. Click New.
    3. In the Type field, select JDBC.
    4. Right-click the Format field label, and select Configure Choices from the pop-up menu.
    5. Move the Sybase or DB2 Universal choices from the Available column to the Selected column.
    6. Click Save.

      The new data source now appears in the list of available JDBC formats.

    Install a driver on a MID Server

    You can install a new JDBC driver JAR file to a MID server to access database formats that are not supported by default.

    Before you begin

    Role required: agent_admin

    Procedure

    1. Navigate to MID Server > JAR Files.
    2. Click New.
    3. Complete the following fields:
      • Name: A unique and descriptive name for identifying the file in the instance.
      • Version: A version number for the file, if one is available.
      • Source: Location of the JAR file for reference purposes. Source information is not used by the system.
      • Description: Short description of the JAR file and its purpose in the instance.
    4. Click the paper clip icon in the banner and attach the JAR file to the record.
      Attach a file
    5. Click Submit.
    6. Restart the MID Server service.

      The platform makes the JAR file available to any MID Server configured to communicate with the instance.

    Create a JDBC data source for an unsupported database format

    Add a JDBC data source by defining a data source record.

    Before you begin

    • Role required: import_admin
    • This procedure covers how to create a JDBC data source for an unsupported database format. For general information on creating a JDBC data source, including a detailed description of form fields, see Create a JDBC type data source.

    Procedure

    1. Navigate to All > System Import Sets > Administration > Data Sources and click New.
    2. In the Data Source form, select JDBC from the list in the Type field.
    3. Select the new data source from the choice list in the Format field.
      JDBC Data Source
    4. Configuring the form layout and add the Connection URL field.
    5. Provide the connection URL to the JDBC data source, and then click Submit.

      No other connection information is required.

      JDBC Data Source

    Create an import connection alias

    Create an import connection alias for the JDBC type data source records.

    Before you begin

    Role required: import_admin

    Procedure

    1. Navigate to All > System Import Sets > Administration > Import Connection Alias..
    2. Select New.
    3. Provide a name for the alias.
    4. Select the name of the alias to open the JDBC connections page.
    5. On the JDBC connections page, select New
    6. Fill the form.
      Field Description
      Name A unique name for this JDBC connection.
      Use MID Server MID Server to use to connect to this data source.
      Format Select one of the following formats: MySQL, Oracle, or SQL Server.
      Instance name Used to support dynamic port connectivity with SQL Server. To ensure connectivity, provide the instance name for a SQL Server that receives a new port number dynamically after each reboot. This field only appears when SQLServer is selected as a data source format.
      Server Name of the server from which the tables will be imported.
      Database name Name of the database instance.
      Database port Port number for the database. Leave this field empty when using dynamic port connectivity with SQL Server.
      Use integrated authentication Selected to enable the JDBC connection to use the ID of the user configured for the Windows MID Server service for SQL Server authentication. For additional details, see JDBC type data source.
      Connection URL parameters Optional parameters to add to the end of the URL generated for this data source. Semicolon-separated list of parameters.
      Connection URL parameters Optional parameters to add to the end of the URL generated for this data source. Semicolon-separated list of parameters.
      Connection URL Read-only field auto-generated by the system. To set connection URL manually, select the Manually set connection URL option.
      Manually set connection URL Option to manually set the connection URL.
      Import connection alias The import connection alias associated with the JDBC connection.
      Use username password to authenticate Option to provide the username and password for authentication.

      When this option is switched off, the connection properties are used for authentication.
      Username User name for authentication on the JDBC server.
      Password Password for authentication on the JDBC server.
      Connection timeout Number of seconds before MID Server connection cache pool closes and removes it from the pool. Zero (0) means no timeout.
      Query timeout Number of seconds the JDBC driver waits for a query (SELECT) to complete. Zero (0) means no timeout. If timeout is exceeded, the integration considers the JDBC result inaccessible and places it in an error state
    7. Select Submit.