ServiceNow

Building the JDBC URL

After installing the license, access the connection management page by executing the command "java -jar kingswaysoft.jdbc.jar". Enter the necessary details, and the program will automatically generate the JDBC connection URL. Users can click Test Connection to test the generated URL and Copy to Clipboard to copy the connection string for use within the application where the JDBC driver is being used.

Note: If a license is not installed, you can still use the connection manager to generate a JDBC URL, but the 'Test Connection' feature will be disabled.

General Page

The General page allows you to specify connection properties and login credentials for ServiceNow REST service:

connectionmanage

General Settings
Base URL

The Base URL field allows the user to enter the URL to their instance of the ServiceNow API.

API Throttling Rate

The API Throttling Rate will limit the number of requests that can be sent per second. Set this value to 0 to disable API Throttling.

Authentication
Authentication Mode

The Authentication Mode option allows you to specify how to authenticate with the ServiceNow server. Available options are:

  • Basic
  • OAuth

Authentication Methods for ServiceNow

Basic

Users can choose to use their instance url along with their username and password to establish a connection.

Authentication
Username

The Username of the account you wish to use to connect to your ServiceNow instance. This field is only available when the Authentication Mode is set to Basic.

Password

The Password of the account you wish to use to connect to your ServiceNow instance. This field is only available when the Authentication Mode is set to Basic.

OAuth

OAuth supports multiple OAuth modes. Select the mode that is appropriate for your environment.

Authorization Code

A saved token file and token password can be used to establish a connection. If you wish to generate a new token file, click **Generate Token File** to go through the token generation process, save the token file locally, and use the set token password to connect.

Authentication
Generate Token File

The Generate Token File button completes the OAuth authentication. After you click this button simply follow the steps in the dialog to generate your token.

Path To Token File

The path to the token file on the file system.

Token File Password

The password to the token file.

JWT

JWT can be used to authenticate and connect to ServiceNow. Provide the Client ID, Client Secret, User Email, the Certificate Path and the Certificate Password.

Authentication
Client Id

The Client Id option allows you to specify the Client ID used to authenticate with the API.

Client Secret

The Client Secret option allows you to specify the Client Secret used to authenticate with the API.

User Field Value

The User Field Value option allows you to specify the User Field used to authenticate with the API.

Certificate Path

The path to an existing certificate file.

Certificate Password

The password for the specified certificate file.

Client Credentials

Client Credentials can be used to authenticate and connect to ServiceNow. Provide the Client ID and Client Secret.

Authentication
Client Id

The Client Id option allows you to specify the Client Secret used to authenticate with the API.

Client Secret

The Client Secret option allows you to specify the Client Secret used to authenticate with the API.

Test Connection

After all the connection information has been provided, click the "Test Connection" button to test if the user credentials entered can successfully connect to the selected service.

Advanced Settings Page

The Advanced Settings page allows you to specify advanced settings for the connection.

connectionmanage

Proxy Server Settings
Proxy Mode

The Proxy Mode option allows you to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Use system configured proxy)
  • Manual
Proxy Server

Using the Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

The Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

The Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Miscellaneous Settings
Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds. Specify 0 for infinite timeout.

Retry on Intermittent Errors

The retry on intermittent errors determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.

Ignore Certificate Errors

This option can be used to ignore those SSL certificate errors when connecting to the target server.

Warning: Enabling the "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instances. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.

Note: When this option is enabled, it applies to all HTTP-based SSL connections in the same job process.

Using the JDBC Driver

Explore detailed examples in this section that demonstrate the application of JDBC classes such as Connection, Statement, and ResultSet to effectively manage interactions with ServiceNow data. This section covers the use of regular statements and prepared statements for executing complex or frequently executed queries.

Executing Statements

Once you've connected from your code (see Connecting with DriverManager and Connecting with DataSource), you can execute SQL statements using the Statement class. Refer to the Executing Prepared Statements section for information on how to execute parameterized statements.

When executing queries, you can control the format of the returned data by using the ReadWriteMode property with the following supported options:

  • 0 – All: Returns both actual and display values. Column names are suffixed with .value for actual values and .display_value for display values.
  • 1 – ActualValues: Returns only actual values. Column names are returned without suffixes.
  • 2 – DisplayValues: Returns only display values. Column names are returned without suffixes.
#### SELECT Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data. To retrieve the results of a query, you would then call the getResultSet method of the Statement.
String sql = "SELECT * FROM agent_file";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the inserted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "INSERT INTO agent_file (name) VALUES ('name')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}
id,errorcode,errormessage,processdata,haserrors
88124e04c3061a100c3ddf3d050131e1,null,null,{"name":"name"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the updated data's ID, exceptions raised during execution, and details of the affected data.

String sql = "UPDATE agent_file SET name = 'nameUpdate' WHERE sys_id = '99914667c3a512100c3ddf3d050131f8'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}
id,errorcode,errormessage,processdata,haserrors
99914667c3a512100c3ddf3d050131f8,null,null,{"name":"nameUpdate"},false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "DELETE FROM agent_file WHERE sys_id = '99914667c3a512100c3ddf3d050131f8'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}
id,errorcode,errormessage,processdata,haserrors
99914667c3a512100c3ddf3d050131f8,null,null,null,false

Executing Prepared Statements

Using a PreparedStatement can improve performance when you need to execute a SQL statement multiple times with different parameters. Unlike a Statement object, a PreparedStatement object is provided with a SQL statement when it is created, which can then be executed with different values each time. This special type of statement is derived from the more general class, Statement.

Below are the steps outlining how to execute a prepared statement:

  1. Create a PreparedStatement: Use the prepareStatement method of the Connection class to instantiate a PreparedStatement. Refer to Connecting with DriverManager or Connecting with DataSource for information related to establishing connections.
  2. Set Parameters: Declare parameters by calling the corresponding setter method of the PreparedStatement. Note: The parameter indices start at 1.
  3. Execute the Statement: Use the generic execute or executeUpdate method of the PreparedStatement.
  4. Retrieve Results: Call the getResultSet method of the Prepared Statement to obtain the query results, which will be returned as a ResultSet.
  5. Iterate Over the Result Set: Use the next method of the ResultSet to iterate through the results. To obtain column information, utilize the ResultSetMetaData class. Instantiate a ResultSetMetaData object by calling the getMetaData method of the ResultSet.

When executing queries, you can control the format of the returned data by using the ReadWriteMode property with the following supported options:

  • 0 – All: Returns both actual and display values. Column names are suffixed with .value for actual values and .display_value for display values.
  • 1 – ActualValues: Returns only actual values. Column names are returned without suffixes.
  • 2 – DisplayValues: Returns only display values. Column names are returned without suffixes.
#### SELECT Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the retrieved data.

String sql = "SELECT * FROM agent_file WHERE sys_id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "99914667c3a512100c3ddf3d050131f8");
    ps.execute(sql);
    while (ps.getResultSet().next()) {
        for (int i = 1; i <= ps.getResultSet().getMetaData().getColumnCount(); i++) {
            LOGGER.info(ps.getResultSet().getMetaData().getColumnLabel(i) + "=" 
            + ps.getResultSet().getString(i));
        }
    }
} catch (SQLException e) {
    LOGGER.error(e);
}

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of inserted data, exceptions raised during execution, and the data affected by the insertion.

String sql = "INSERT INTO zing_to_ais_configuration (active,name) VALUES (?, ?)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setBoolean(1, true);
    ps.setString(2, "InsertName");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}
id,errorcode,errormessage,processdata,haserrors
f8d5ba8ec36312100c3ddf3d050131aa,null,null,{"active":true,"name":"InsertName"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of updated data, exceptions raised during execution, and the data affected by the update.

String sql = "UPDATE agent_file SET name = ? WHERE sys_id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "nameUpdate");
    ps.setString(2, "99914667c3a512100c3ddf3d050131f8");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}
id,errorcode,errormessage,processdata,haserrors
99914667c3a512100c3ddf3d050131f8,null,null,{"name":"nameUpdate"},false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "DELETE FROM agent_file WHERE sys_id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "99914667c3a512100c3ddf3d050131f8");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}
id,errorcode,errormessage,processdata,haserrors
99914667c3a512100c3ddf3d050131f8,null,null,null,false

Metadata Discovery

This section provides examples on how to retrieve table and column metadata using the getTables, getColumns, and getPrimaryKeys methods from the DatabaseMetaData interface. These are essential for discovering database structures.

Tables

The getTables method from the DatabaseMetaData interface can be used to retrieve a list of tables.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getTables(null, null, null, null);
    LOGGER.info("\r\n" + rs.toString());
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}
TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS
null,null,adaptive_auth_event,Table,
null,null,agent_assist_recommendation,Table,
null,null,agent_file,Table,
......

The getTables method returns the following metadata columns:

Column Name Data Type Description
TABLE_CAT String The catalog that contains the table.
TABLE_SCHEM String The schema of the table.
TABLE_NAME String The name of the table name.
TABLE_TYPE String The type of the table (e.g., TABLE or VIEW).
REMARKS String An optional description of the table.

Columns

Use the getColumns method of the DatabaseMetaData interface to retrieve detailed information about the columns in the database. To narrow your search to a specific table, specify the table name as a parameter.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getColumns(null, null, "agent_file", null);
    LOGGER.info(rs.toString());
} catch (SQLException e) {
    e.printStackTrace();
}
TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,DATA_TYPE,TYPE_NAME,COLUMN_SIZE,BUFFER_LENGTH,DECIMAL_DIGITS,NUM_PREC_RADIX,NULLABLE,REMARKS,COLUMN_DEF,SQL_DATA_TYPE,SQL_DATETIME_SUB,CHAR_OCTET_LENGTH,ORDINAL_POSITION,IS_NULLABLE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,DTS_TYPE
null,null,agent_file,content,12,java.lang.String,20000,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,agent_file,end_date,91,java.util.Date,40,null,0,0,null,null,null,91,null,null,null,null,null,null,DT_DBDATE
null,null,agent_file,mid_server,12,java.lang.String,32,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR

The getColumns method returns the following columns:

Column Name Data Type Description
TABLE_CAT String The database name.
TABLE_SCHEM String The table schema.
TABLE_NAME String The table name.
COLUMN_NAME String The column name.
DATA_TYPE Integer The data type represented by a constant value from java.sql.Types.
TYPE_NAME String The data type name used by the driver.
COLUMN_SIZE Integer The length in characters of the column or the numeric precision.
BUFFER_LENGTH Integer The buffer length.
DECIMAL_DIGITS Integer The column scale or number of digits to the right of the decimal point.
NUM_PREC_RADIX Integer The radix, or base.
NULLABLE Integer Whether the column can contain null as defined by the following JDBC DatabaseMetaData constants: columnNoNulls (0) or columnNullable (1).
REMARKS String The comment or note associated with the object.
COLUMN_DEF String The default value for the column.
SQL_DATA_TYPE Integer Reserved by the specification.
SQL_DATETIME_SUB Integer Reserved by the specification.
CHAR_OCTET_LENGTH Integer The maximum length of binary and character-based columns.
ORDINAL_POSITION Integer The position of the column in the table, starting at 1.
IS_NULLABLE String Whether a null value is allowed: YES or NO.
IS_AUTOINCREMENT String Whether the column value is assigned by ServiceNow in fixed increments.
IS_GENERATEDCOLUMN String Whether the column is generated: YES or NO.
DTS_TYPE String Object DTS attribute type.

Primary Keys

The getPrimaryKeys method in the DatabaseMetaData interface is used to retrieve metadata about primary keys for a given table in ServiceNow.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "question");
    LOGGER.info("\r\n" + resultSet.toString());
    Assertions.assertNotNull(resultSet);
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}
TABLE_NAME,PRIMARY_COLUMN_NAME
question,sys_id

The getPrimaryKeys method returns the following columns:

Column Name Data Type Description
TABLE_NAME String The name of the table that contains the primary key.
PRIMARY_COLUMN_NAME String The name of the column that serves as the primary key for the table.

Connection Settings

Connection Setting Type Default Value Description
AuthenticationMode String "AuthorizationCode" AuthenticationMode specifies the method used to authenticate when connecting to ServiceNow RESTful API.
ApiThrottleRate Integer 10 The maximum number of API requests a client can make to the server within a specific time period, defined in requests per second.
BaseUrl String "" The BaseUrl is the instance URL used for connecting to ServiceNow.
BulkPollingInterval Integer 5 How often the component checks the job status until the job status is COMPLETE.
CacheExpirationTime Integer 30 Defines the expiration time for cache. A value of 0 disables caching.
CertificatePassword String "" The password used to access the keystore file.
ClientId String "" The ClientId used to access Service Now.
ClientSecret String "" The ClientSecret used to access Service Now.
ConnectionTimeout Integer 30 ConnectionTimeout is the maximum amount of time the program will wait to set up a connection to the ServiceNow API.
UserEmail String "" The email specifies the user account used for OAuth JWT connection to ServiceNow.
IgnoreCertificateErrors Boolean false Specifies whether to verify the certificate when connecting to ServiceNow. If certificate verification is not required, you can set this value to 'true'.
IgnoreError Boolean false Determines if the program continues executing SQL statements after encountering an error.
LogFileSize String "10485760" A string specifying the maximum size in bytes for a log file.
LogLevel String "INFO" The logging level for the JDBC driver.
LogPath String "./jdbcLogs" The directory where log files are stored.
OemKey String "" The OEM License key.
Password String "" The password used to authenticate the user.
PathToCertificate String "" CertificatePath specifies the file path where the keystore file for connecting to Service Now is located.
ProxyMode String NoProxy This setting configures the proxy. Allowed values are "NoProxy", "AutoDetect" and "Manual".
ProxyPassword String "" The password to be used to authenticate to the proxy.
ProxyServer String "" The host of the proxy server.
ProxyServerPort Integer 0 The port of the proxy server.
ProxyUsername String "" The username to be used to authenticate to the proxy.
ReadBatchSize Integer 1000 ReadBatchSize is used to set how many records can be read from ServiceNow in a single call.
ReadWriteMode Integer 1 ReadWriteMode is used to determine how field values are displayed and interacted with in different contexts. Options include 0-All, 1-ActualValues, and 2-DisplayValues. All is read-only and refers to both ActualValues and DisplayValues. ActualValues refers to the internal, raw data that ServiceNow uses behind the scenes (often the actual database value). DisplayValues refers to the user-friendly or human-readable values.
ResultPath String "" The path where the execution result files are saved.
RetryOnIntermittentErrors Boolean true The RetryOnIntermittentErrors parameter indicates whether to retry the connection when it might occasionally fail due to temporary issues.
SaveResult Boolean false The SaveResult parameter indicates whether to save the execution results to a file.
ServiceName String "" The ServiceName refers to the name of the service API selected by the user.
ServiceTimeout Integer 120 The ServiceTimeout is the timeout to receive the full response from ServiceNow API.
TokenPassword String "" The password used to read the token file.
TotalThreads Integer 0 The number of threads for executing operations in parallel. A value of 0 will disable multi threading.
UserName String "" The user account used to connect to the server.
WriteBatchSize Integer 200 WriteBatchSize is used to set how many records can be written to ServiceNow in a single call.