DocuSign

Building the JDBC URL

After installing the license, open the connection management page by running java -jar kingswaysoft.jdbc.jar. Enter the required details to generate the JDBC connection URL. Click Test Connection to test the generated URL, or Copy to Clipboard to copy the connection string for use in your application.

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

General Page

The General page allows you to specify connection properties and login credentials for the DocuSign REST service.

connectionmanage

General Settings

Account: The Account option specifies the DocuSign account ID used for account-scoped endpoints. The driver uses this account value when building requests for endpoints such as accounts/groups and accounts/envelopes.
API Throttling Rate: The API Throttling Rate will limit the number of requests that can be sent per hour. Set this value to 0 to disable API throttling.

Authentication Methods for DocuSign

OAuth 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 specified token password to connect.

Instance Type

The Instance Type option allows you to choose the DocuSign environment to connect to. Choose Developer for the demo environment or Production for a production DocuSign account.

Generate Token File

This button completes the OAuth authentication process to generate a new token.

Integration Key: The Integration Key option allows you to specify the unique ID which identifies the DocuSign integration making the request.
Secret Key: The Secret Key option allows you to specify the secret key belonging to your DocuSign integration.
Redirect URL: The Redirect URL option allows you to specify the redirect URL used to complete the authentication process.
Scope: The Scope option allows you to specify the DocuSign OAuth scopes used during token generation. Common scopes include signature, extended, openid, and impersonation.
PKCE (Enhanced Security): The PKCE (Proof Key for Code Exchange) option can be enabled for a PKCE app type. It ensures that the client that initiates the OAuth flow is the same client that completes the flow.

Path To Token File

The path to the token file on the file system.

Token File Password

The password for the token file.

JWT

JWT authentication can be used when a DocuSign integration is configured to authenticate with an RSA private key and an impersonated user.

Instance Type: The Instance Type option allows you to choose the DocuSign environment to connect to. Choose Developer for the demo environment or Production for a production DocuSign account.
Integration Key: The Integration Key option allows you to specify the unique ID which identifies the DocuSign integration making the request.
Impersonated User ID: The Impersonated User ID option allows you to specify the DocuSign user ID to impersonate when requesting the JWT access token.
RSA Private Key: The RSA Private Key option allows you to provide the private key used to sign the JWT assertion.

Test Connection

After completing the configuration for all required connection and authentication settings in the JDBC Connection Manager, you can use the Test Connection button to validate your configuration. The driver authenticates with DocuSign and discovers the account-specific base URL through the DocuSign user information endpoint.

Advanced Settings Page

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

connectionmanage

Proxy Server Settings

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

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.

Concurrent Writing Threads

This option can be used to set the number of threads to be used during write operations. This can improve performance during large-volume write operations.

Using the JDBC Driver

This section provides examples that use JDBC classes such as Connection, Statement, and ResultSet to manage interactions with DocuSign data. It covers regular statements and prepared statements for complex or frequently executed queries.

DocuSign account-scoped endpoints use the configured AccountId. During connection validation, the driver discovers the account-specific base URL from DocuSign and uses that URL for subsequent API calls.

Executing Statements

After you have connected from your code, you can execute SQL statements using the Statement class. For connection details, see Connecting with DriverManager or Connecting with DataSource. For parameterized statements, see Executing Prepared Statements.

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, call the getResultSet method of the Statement.

String sql = "SELECT * FROM accounts/groups";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

String sql = "SELECT * FROM accounts/envelopes WHERE envelopeId = 'c39d29a6-9185-819d-81a2-dd19e36e179e'";
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 accounts/workspaces (workspaceName) VALUES ('test3')";
try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
465abf65-36ad-45d8-ae97-846e95e06526,null,null,{"workspaceName":"test3"},false

String sql = "INSERT INTO accounts/envelopes (emailSubject, status) VALUES ('DraftEnvelope1', 'created')";
try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
8f9920c2-e75d-8972-8032-12489c771066,null,null,{"emailSubject":"DraftEnvelope1","status":"created"},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 accounts/workspaces SET workspaceName = 'updatedWorkspaceName' WHERE workspaceId = '465abf65-36ad-45d8-ae97-846e95e06526'";
try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
465abf65-36ad-45d8-ae97-846e95e06526,null,null,{"workspaceName":"updatedWorkspaceName"},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 accounts/workspaces WHERE workspaceId = '465abf65-36ad-45d8-ae97-846e95e06526'";
try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1918e893-9a2f-4861-a004-e5e68aff3261,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 Statement class.

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

Creating and Executing a Prepared Statement

Create a PreparedStatement

Use the prepareStatement method of the Connection class to instantiate a PreparedStatement.

For connection details, see Connecting with DriverManager or Connecting with DataSource.

Set Parameters

Declare parameters by calling the corresponding setter method of the PreparedStatement.
NOTE: The parameter indices start at 1.

Execute the PreparedStatement

Use the generic execute or executeUpdate method of the PreparedStatement.

Retrieve Results

Call the getResultSet method of the PreparedStatement to obtain the query results, which are returned as a ResultSet.

Iterate Over the Result Set

Use the next method of the ResultSet to iterate through the results. To obtain column information, use the ResultSetMetaData class. Instantiate a ResultSetMetaData object by calling the getMetaData method of the ResultSet.

SELECT

Use the PreparedStatement 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 envelopeId, status, emailSubject FROM [accounts/envelopes] WHERE from_date = ?";
try {
    PreparedStatement preparedStatement = connection.prepareStatement(sql);
    preparedStatement.setString(1, "2024-01-01");
    ResultSet resultSet = preparedStatement.executeQuery();
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INSERT

Use either the generic execute method or the executeUpdate method of the PreparedStatement 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 ID of inserted data, exceptions raised during execution, and the data affected by the insertion.

String insertSql = "INSERT INTO accounts/workspaces (workspaceName) VALUES (?)";
try {
    PreparedStatement preparedStatement = connection.prepareStatement(insertSql);
    preparedStatement.setString(1, "test3");
    int result = preparedStatement.executeUpdate();
    LOGGER.info(preparedStatement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
465abf65-36ad-45d8-ae97-846e95e06526,null,null,{"workspaceName":"test3"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the PreparedStatement 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 ID of updated data, exceptions raised during execution, and the data affected by the update.

String sql = "UPDATE accounts/workspaces SET workspaceName = ? WHERE workspaceId = ?";
try {
    PreparedStatement preparedStatement = connection.prepareStatement(sql);
    preparedStatement.setString(1, "updatedWorkspaceName");
    preparedStatement.setString(2, "465abf65-36ad-45d8-ae97-846e95e06526");
    int result = preparedStatement.executeUpdate();
    LOGGER.info(preparedStatement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
465abf65-36ad-45d8-ae97-846e95e06526,null,null,{"workspaceName":"updatedWorkspaceName"},false

DELETE

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

String deleteSql = "DELETE FROM accounts/workspaces WHERE workspaceId = ?";
try {
    PreparedStatement preparedStatement = connection.prepareStatement(deleteSql);
    preparedStatement.setString(1, "465abf65-36ad-45d8-ae97-846e95e06526");
    int result = preparedStatement.executeUpdate();
    LOGGER.info(preparedStatement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1918e893-9a2f-4861-a004-e5e68aff3261,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.

This method only retrieves tables that are not write-only.

To get a list of tables that includes write-only tables, query the table system.tables.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getTables(null, null, null, null);
    LOGGER.info(rs.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS,TYPE_CAT,TYPE_SCHEM,TYPE_NAME,SELF_REFERENCING_COL_NAME,REF_GENERATION
null,null,accounts,TABLE,null,null,null,null,null,null
null,null,accounts/billing_charges,TABLE,null,null,null,null,null,null
null,null,accounts/billing_invoices,TABLE,null,null,null,null,null,null
null,null,accounts/billing_payments,TABLE,null,null,null,null,null,null
null,null,accounts/billing_plan,TABLE,null,null,null,null,null,null
null,null,accounts/brands,TABLE,null,null,null,null,null,null
null,null,accounts/contacts,TABLE,null,null,null,null,null,null
null,null,accounts/envelopes,TABLE,null,null,null,null,null,null
null,null,accounts/envelopes/attachments,TABLE,null,null,null,null,null,null
null,null,accounts/envelopes/comments/transcript,TABLE,null,null,null,null,null,null
.....

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.
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 database columns.

This method returns columns only for tables that are not write-only.

To get columns for write-only tables, query the table system.columns.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getColumns(null, null, "accounts/envelopes", null);
    LOGGER.info(rs.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

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,SCOPE_CATALOG,SCOPE_SCHEMA,SCOPE_TABLE,SOURCE_DATA_TYPE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,DTS_TYPE
null,null,accounts/envelopes,accessControlListBase64,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,allowComments,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,allowMarkup,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,brandId,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,completedDateTime,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,copyRecipientData,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,createdDateTime,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,declinedDateTime,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,deliveredDateTime,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,emailSubject,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,envelopeDocuments,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,envelopeId,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,accounts/envelopes,envelopeLocation,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,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.
SCOPE_CATALOG	String	The catalog of the table referenced by a reference attribute (null if `DATA_TYPE` is not `REF`).
SCOPE_SCHEMA	String	The schema of the table referenced by a reference attribute (null if `DATA_TYPE` is not `REF`).
SCOPE_TABLE	String	The name of the table referenced by a reference attribute (null if `DATA_TYPE` is not `REF`).
SOURCE_DATA_TYPE	Short	The source type of a distinct type or user-defined `REF` type (null if `DATA_TYPE` is neither `DISTINCT` nor a user-defined `REF`).
IS_AUTOINCREMENT	String	Whether the column value is assigned by DocuSign 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 DocuSign.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "accounts/envelopes");
    LOGGER.info("\r\n" + resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,KEY_SEQ,PK_NAME
null,null,accounts/envelopes,envelopeId,1,null

The getPrimaryKeys method returns the following columns:

Column Name	Data Type	Description
TABLE_CAT	String	The catalog name, which is always null.
TABLE_SCHEM	String	The schema name, which is always null.
TABLE_NAME	String	The table name.
COLUMN_NAME	String	The primary key column name.
KEY_SEQ	Short	The sequence number within the primary key.
PK_NAME	String	The primary key name.

Connection Settings

The following table lists the connection properties supported by the DocuSign JDBC Driver.

Connection Setting	Type	Default Value	Description
AccountId	String	""	The DocuSign account ID used for account-scoped endpoints.
ApiThrottleRate	Integer	0	The maximum number of API requests a client can make to the server within a specific time period, defined in requests per hour.
AuthenticationMode	String	AuthorizationCode	The authentication method used to connect to DocuSign. Supported values include AuthorizationCode and JWT.
BatchSizeForReading	Integer	100	BatchSizeForReading is used to set how many records can be read from DocuSign in a single call. DocuSign has a maximum BatchSizeForReading of 100.
BatchSizeForWriting	Integer	1	BatchSizeForWriting is used to set how many records can be written to DocuSign in a single call.
CacheExpirationTime	Integer	30	Defines the expiration time for cache. A value of 0 disables caching.
ClientId	String	""	The DocuSign Integration Key used by OAuth Authorization Code authentication.
ConcurrentWritingThreads	Integer	1	The number of threads for executing operations in parallel. A value of 0 will disable multi threading.
ConnectionTimeout	Integer	30	The maximum amount of time, in seconds, that the driver will wait to establish a connection to the DocuSign API.
ContinueOnErrors	Boolean	false	Determines if the driver continues executing SQL statements after encountering an error.
IgnoreCertificateErrors	Boolean	false	Specifies whether to verify the certificate when connecting to DocuSign. If no certificate verification is required, you can set this value to 'true'.
InstanceType	String	"Production"	The DocuSign environment to connect to. Supported values include Developer and Production.
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.
PathToPrivateKey	String	""	The path to the RSA private key file used by JWT authentication.
PathToTokenFile	String	""	The file path where the OAuth token file 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.
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 DocuSign API.
SubjectKey	String	""	The impersonated DocuSign user ID used by JWT authentication.
Suppress404NotFoundError	Boolean	true	When set to true, if a query results in an HTTP 404 error, a result set will still be created. When set to false, an error is logged instead and no result set is created.
TokenPassword	String	""	The password used to read the token file.