Dynamics 365 CE/CRM/Dataverse

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 Generic Service Configuration page of the CRM/CDS Connection Manager allows you to specify general settings for the connection.

General Settings

Service Endpoint

The Service Endpoint option allows you to specify the service endpoint that you want to use in order to connect to the Microsoft Dynamics 365CE/CRM server.
Currently, the only available option is WebAPI.

CDS/CRM Server URL

The CDS/CRM Server URL is the actual URL that is utilized by the connection manager to make service calls to Microsoft Dynamics 365 CRM, CDS, or Dataverse. This field should be prepopulated for you after using the Select Organization feature. This URL is generally your CRM, CDS tenant URL. For Dynamics CRM 4.0, this should be the URL with your organization name.

Authentication

Authentication Type

The Authentication Type option allows you to specify the deployment type of your CRM server and what authentication will be used. There are two options available:

• Active Directory (On-Premises)
• OAuth (Dynamics 365 Online or On-Premises)

OAuth Type

The OAuth Type option allows you to specify the OAuth type when you use OAuth (Dynamics 365 Online or On-Premises) authentication. There are four options available:

• Authorization Code
• Client Credentials (Server to Server authentication)
• Certificate
• Password (Not recommended for security reasons)

Authorization Server (URL)

This option only available when OAuth is used. When connecting to Dynamics 365 CE/CRM online, we use https://login.microsoftonline.com/ as the default authorization server, which you don't generally need to make a change to unless there is a specific reason in the case that your CDS/CRM online instance is using some special authentication flow. This is more often used for Dynamics 365 on-premises installation with a particular authorization server. To enable the option for editing, you must first click on the "Use a Custom URL" checkbox next to the option.

The custom Authorization Server URL can be provided in the following format.

• https://servername - when the value is provided this way, our software will automatically append common/oauth2/token after the server URL.
• https://servername/<TenantId>/oauth2/token - when the value is provided this way with /oauth2/token at the end, our software will authenticate against the URL as it is. This is useful for the case when working with GCC or GCC high environment, your authorization URL is likely to be https://login.microsoftonline.us/<TenantId>/oauth2/token. You can find out your tenant Id by logging into your Azure Portal.

Authentication Methods for Dynamics CRM

Advanced Settings Page

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 Dynamics 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.

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.

Statement statement = connection.createStatement();	
String sql = "SELECT contactid, firstname, lastname FROM contact WHERE lastname = 'test'";
ResultSet resultSet = statement.executeQuery(sql);
while (resultSet.next()) {
    for (int i = 1; i <= resultSet.getMetaData().getColumnCount(); i++) {
      LOGGER.info(resultSet.getMetaData().getColumnLabel(i) + "=" + resultSet.getString(i));
    }
}

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 contact (firstname, lastname) VALUES ('test first', 'test last')";
try {
    Statement statement = connection.createStatement();				
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,relatederrorcode,relatederrormessage
ba9374d2-9508-ef11-9f89-000d3af33381,null,null,{"firstname":"test first","lastname":"test last"},false,null,null

UPDATE

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

The MatchHandling property will effect how UPDATE operations perform when multiple records are found that match the search criteria.

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 contact SET firstname = 'test first1' WHERE lastname = 'test last'"try {	
    Statement statement = connection.createStatement();			
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,relatederrorcode,relatederrormessage
50d691b8-bf08-ef11-9f89-000d3af33381,null,null,{"firstname":"test first1"},false,null,null

DELETE

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

The MatchHandling property will effect how DELETE operations perform when multiple records are found that match the search criteria.

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 Contact WHERE lastname = 'test last'";
try {	
    Statement statement = connection.createStatement();			
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,relatederrorcode,relatederrormessage
50d691b8-bf08-ef11-9f89-000d3af33381,null,null,null,false,null,null

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call. The following matching methods are supported to perform the lookup of the target system in order to determine whether it is a new record to be created or an existing record to be updated.

Alternate Key Method

The Alternate Key method uses a system-defined alternate key as the matching criterion to locate or identify records in the target system for writing purposes. If the specified alternate key does not match any existing records, a new object record will be created. If a match is found, the outcome depends on the number of matches:

• If the key is matched once, the existing object record is updated.
• If the key is matched multiple times, an error is generated and the object record is not inserted or updated.

The Upsert SQL statement must end with 'ON DUPLICATE KEY UPDATE UPSERTFIELDS = key', where 'key' refers to the field specified by the user as the upsert key.

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

String sql = "UPSERT INTO contact (firstname, lastname, emailaddress1, creditlimit) VALUES 
    ('testFirst1', 'testLast1', '[email protected]', 100), 
    ('testFirst2', 'testLast2', '[email protected]', 200) 
    ON DUPLICATE KEY UPDATE UPSERTFIELDS = (firstname, lastname, emailaddress1)";

try {
    Statement statement = connection.createStatement();				
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,isnew,relatederrorcode,relatederrormessage
155abd78-ed1e-f011-998a-7ced8d058096,null,null,{"creditlimit":100.00},true,true,null,null
185abd78-ed1e-f011-998a-7ced8d058096,null,null,{"creditlimit":200.00},false,true,null,null

Manually Specified Key Method

The Manually Specify method allows you to define one or more CDS/CRM fields to be used as the matching key(s) to locate or identify target records in the CDS/CRM system.

• If the specified combination of fields matches exactly one record, that record is updated.
• If no match is found, a new record is inserted.
• If the key is matched multiple times, an error is generated and the object record is not inserted or updated.

To use this method, append the following to your SQL query: 'USING OPTIONS ('ManualMatchingUpsert')'

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

String sql = "UPSERT INTO contact (firstname, lastname, emailaddress1, creditlimit) VALUES 
    ('JtestFirst3', 'JtestLast3', '[email protected]', 100), 
    ('JtestFirst2', 'JtestLast2', '[email protected]', 200) 
    ON DUPLICATE KEY UPDATE UPSERTFIELDS = (firstname, lastname) USING OPTIONS ('ManualMatchingUpsert')";

try {
    Statement statement = connection.createStatement();				
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,isnew,relatederrorcode,relatederrormessage
320ac724-c41b-f011-998a-7ced8d058096,null,null,{"creditlimit":100.00,"emailaddress1":"[email protected]"},false,false,null,null
baf43a1c-e61e-f011-998a-7ced8d058096,null,null,{"firstname":"JtestFirst2","creditlimit":200.00,"lastname":"JtestLast2","emailaddress1":"[email protected]"},false,true,null,null

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.

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 contact WHERE firstname = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "test first");
    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 contact (firstname, lastname) VALUES (?, ?)";
try {	
    PreparedStatement ps = connection.prepareStatement(sql);		
    ps.setString(1, "first");
    ps.setString(2, "last");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,relatederrorcode,relatederrormessage
89f1fde0-c008-ef11-9f89-000d3af33381,null,null,{"firstname":"first","lastname":"last"},false,null,null

UPDATE

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

The MatchHandling property will effect how UPDATE operations perform when multiple records are found that match the search criteria.

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 contact SET Firstname = ? WHERE lastname = ?";
try {	
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "first1");
    ps.setString(2, "last");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,relatederrorcode,relatederrormessage
89f1fde0-c008-ef11-9f89-000d3af33381,null,null,{"firstname":"first1"},false,null,null

DELETE

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

The MatchHandling property will effect how DELETE operations perform when multiple records are found that match the search criteria.

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 contact WHERE lastname = ?";
try {	
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "last");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,relatederrorcode,relatederrormessage
89f1fde0-c008-ef11-9f89-000d3af33381,null,null,null,null,false,null,null

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call. The following matching methods are supported to perform the lookup of the target system in order to determine whether it is a new record to be created or an existing record to be updated.

Alternate Key Method

The Alternate Key method uses a system-defined alternate key as the matching criterion to locate or identify records in the target system for writing purposes. If the specified alternate key does not match any existing records, a new object record will be created. If a match is found, the outcome depends on the number of matches:

• If the key is matched once, the existing object record is updated.
• If the key is matched multiple times, an error is generated and the object record is not inserted or updated.

The Upsert SQL statement must end with 'ON DUPLICATE KEY UPDATE UPSERTFIELDS = key', where 'key' refers to the field specified by the user as the upsert key.

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

String sql = "UPSERT INTO contact (firstname, lastname, emailaddress1, creditlimit) VALUES (?, ? '[email protected]', 100) ON DUPLICATE KEY UPDATE UPSERTFIELDS = (firstname, lastname, emailaddress1)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);    
    ps.setString(1, "testFirst1");
    ps.setString(2, "testLast1");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,isnew,relatederrorcode,relatederrormessage
155abd78-ed1e-f011-998a-7ced8d058096,null,null,{"creditlimit":100.00},false,false,null,null

Manually Specified Key Method

The Manually Specify method allows you to define one or more CDS/CRM fields to be used as the matching key(s) to locate or identify target records in the CDS/CRM system.

• If the specified combination of fields matches exactly one record, that record is updated.
• If no match is found, a new record is inserted.
• If the key is matched multiple times, an error is generated and the object record is not inserted or updated.

To use this method, append the following to your SQL query: 'USING OPTIONS ('ManualMatchingUpsert')'

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

String sql = "UPSERT INTO contact (firstname, lastname, emailaddress1, creditlimit) VALUES 
    (?, ?, '[email protected]', 100)
    ON DUPLICATE KEY UPDATE UPSERTFIELDS = (firstname, lastname) USING OPTIONS ('ManualMatchingUpsert')";
try {
    PreparedStatement ps = connection.prepareStatement(sql);    
    ps.setString(1, "testFirst1");
    ps.setString(2, "testLast1");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,haserrors,isnew,relatederrorcode,relatederrormessage
155abd78-ed1e-f011-998a-7ced8d058096,null,null,{"creditlimit":100.00},false,false,null,null

Query Options

The driver provides several query‑level options that let you fine‑tune execution for better performance and accuracy.

Append USING OPTIONS (...) to your SQL statement to enable one or more optimizations. Separate multiple options with commas.

The following options are available for use:

String sql = "UPSERT INTO contact (firstname, lastname, emailaddress1, creditlimit) VALUES "
		+ "('testFirst', 'testLast', '[email protected]', 100)"
		+ "ON DUPLICATE KEY UPDATE UPSERTFIELDS = (firstname, lastname) USING OPTIONS ('ManualMatchingUpsert','IgnoreUnchangedFields')";
try {	
    Statement statement = connection.createStatement();			
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

String sql = "UPDATE contact SET emailaddress1 = '[email protected]' WHERE lastname = 'testLast' "
		+ "USING OPTIONS ('IgnoreUnchangedFields')";
try {	
    Statement statement = connection.createStatement();			
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

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.

Class.forName("com.kingswaysoft.jdbc.Drivers");

Properties connectionProps = new Properties();
connectionProps.put("user", "username");
connectionProps.put("password", "password");

Connection connection = DriverManager.getConnection("jdbc:ServiceName=DynamicsCrm;kingswaysoft:url=https://test.crm3.dynamics.com;", connectionProps);

ResultSet resultSet = connection.getMetaData().getTables(null, null, null, null);
LOGGER.info(resultSet.toString());

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS
null,null,aaduser,Table,
null,null,account,Table,
null,null,accountleads,Table,
null,null,aciviewmapper,Table,
......

The getTables method returns the following metadata columns:

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.

Class.forName("com.kingswaysoft.jdbc.Drivers");

Properties connectionProps = new Properties();
connectionProps.put("user", "username");
connectionProps.put("password", "password");

Connection connection = DriverManager.getConnection("jdbc:kingswaysoft:url=https://test.crm3.dynamics.com;", connectionProps);

ResultSet resultSet = connection.getMetaData().getColumns(null, null, "Contact", null);
LOGGER.info(resultSet.toString());

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,DATA_TYPE,TYPE_NAME,COLUMN_SIZE,BUFFER_LENGTH,DECIMAL_DIGITS,NUM_PREC_RADIX,NULLABLE,COLUMN_DEF,SQL_DATA_TYPE,SQL_DATETIME_SUB,CHAR_OCTET_LENGTH,ORDINAL_POSITION,IS_NULLABLE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,CRM_TYPE
null,null,account,accountcategorycode,4,java.lang.Integer,null,null,null,null,null,null,null,4,null,null,2,null,null,null,PicklistType
null,null,account,accountcategorycodename,12,java.lang.String,null,null,null,null,null,null,null,12,null,null,147,null,null,null,VirtualType
null,null,account,accountclassificationcode,4,java.lang.Integer,null,null,null,null,null,null,null,4,null,null,11,null,null,null,PicklistType
null,null,account,accountclassificationcodename,12,java.lang.String,null,null,null,null,null,null,null,12,null,null,140,null,null,null,VirtualType
null,null,account,accountid,12,java.lang.String,null,null,null,null,null,null,null,12,null,null,1,null,null,null,UniqueidentifierType
null,null,account,accountnumber,12,java.lang.String,20,null,null,null,null,null,null,12,null,null,23,null,null,null,StringType

The getColumns method returns the following columns:

Primary Keys

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

Class.forName("com.kingswaysoft.jdbc.Drivers");

Properties connectionProps = new Properties();
connectionProps.put("user", "username");
connectionProps.put("password", "password");

Connection connection = DriverManager.getConnection("jdbc:kingswaysoft:ServiceName=DynamicsCrm;url=https://test.crm3.dynamics.com;", connectionProps);

ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "email");
LOGGER.info(resultSet.toString());

TABLE_NAME,PRIMARY_COLUMN_NAME
email,activityid

The getPrimaryKeys method returns the following columns:

Connection Settings