Dynamics 365 Business Central/NAV Server

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.

There are two ways to connect to Dynamics NAV:

OAuth

Authorization Code:

Enter Authentication Server, Service URL and choose to use a saved token file and token password to establish a connection. Alternatively, you can click Get New Token to go through the token generation process and save the token file locally.

Client Credentials

Enter Authentication Server, Service URL, Client App Id and Client Secret to establish a connection.

Certificate

Enter Service URL and choose to use a saved certificate file and certificate password to establish a connection. Alternatively, you can click "Generate New Certificate" to go through the certificate process, generate a keystore, save it locally, and use the set certificate password to connect.

Basic

Enter NAV Server, Service URL, User Name and Password to establish a connection.

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.

String sql = "SELECT * FROM contact";
try {
	ResultSet resultSet = statement.executeQuery(sql);
	LOGGER.info(resultSet.toString());
} catch (SQLException e) {
	LOGGER.error(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 contact (displayName) VALUES ('name')";
try {
	statement.executeUpdate(sql);
	LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
c9d8dd71-046b-ef11-a673-000d3af3d442,null,null,{"displayName":"name"}

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 addressLine1 = '1 Street' WHERE displayName = 'name'";
try {
	int result = statement.executeUpdate(sql);
	LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
65ccc3ce-825a-ef11-bfe2-002248ae64e6,null,null,{"addressLine1":"1 Street"}

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 displayName = 'name'";
try {
	int result = statement.executeUpdate(sql);
	LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
 ,null,null,{}

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call. If the specified alternate key isn't matched, a new object record will be created.

If the specified key is matched, the action taken will depend on if there were multiple matches or not.

• If the key is matched once, the existing object record is updated.
• If the key is matched multiple times, handling will depend on MatchHandling setting.

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.

Note: When performing upserts on Dynamics, the UPSERTFIELDS must correspond to fields defined as alternate keys in Dynamics. If they do not match the fields defined as alternate keys, Dynamics will report the following error: Ensure that the names and number of key properties match the declared or alternate key properties for the resource 'Microsoft.Dynamics.NAV....'

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 (displayName, city) VALUES "
		+ "('name1', 'oakville'), ('name2', 'oakville'), ('name3', 'oakville') "
		+ "ON DUPLICATE KEY UPDATE UPSERTFIELDS = (displayName)";
try {
	int result = statement.executeUpdate(sql);
	LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata,isNew
65ccc3ce-825a-ef11-bfe2-002248ae64e6,null,null,{"city":"oakville","displayName":"name1"},false
b1eaaae4-325e-ef11-bfe2-6045bd611d1d,null,null,{"city":"oakville","displayName":"name2"},true
0bf02dfb-845a-ef11-bfe2-002248ae64e6,null,null,{"city":"oakville","displayName":"name3"},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.

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 sqlIn = "SELECT * FROM contact WHERE displayName = ? ORDER BY id DESC, addressLine1 ASC";
try {
	DataSource navSource = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = navSource.getConnection();
	PreparedStatement ps = connection.prepareStatement(sqlIn);
	ps.setString(1, "jtest");
	boolean ret = ps.execute(sqlIn);
	if (ret) {
		ResultSet rs = ps.getResultSet();
		LOGGER.info(rs.toString());
	}
} catch (SQLException e) {
	LOGGER.error(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. 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 insertSql = "INSERT INTO contact (displayName, city) VALUES (?, ?)";
try {
	DataSource navSource = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = navSource.getConnection();
	PreparedStatement ps = connection.prepareStatement(insertSql);
	ps.setString(1, "jtest01");
	ps.setString(2, "oakville");
	ps.executeUpdate();
	LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
65ccc3ce-825a-ef11-bfe2-002248ae64e6,null,null,{"city":"oakville","displayName":"jtest01"}

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 addressLine1 = ? WHERE city = ? AND displayName = ?";
try {
	DataSource navSource = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = navSource.getConnection();
	PreparedStatement ps = connection.prepareStatement(sql);
	ps.setString(1, "address test 001");
	ps.setString(2, "oakville");
	ps.setString(3, "jtest01");
	ps.executeUpdate();
	LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
65ccc3ce-825a-ef11-bfe2-002248ae64e6,null,null,{"addressLine1":"address test 001"}

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 deleteSql = "DELETE FROM contact WHERE displayName = ? AND city = ?";
try {
	DataSource navSource = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = navSource.getConnection();
	PreparedStatement ps = connection.prepareStatement(deleteSql);
	ps.setString(1, "jtest01");
	ps.setString(2, "oakville");
	ps.executeUpdate();
	LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
	e.printStackTrace();
}

id,errorcode,errormessage,processdata
 ,null,null,{}

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call. If the specified alternate key isn't matched, a new object record will be created.

If the specified key is matched, the action taken will depend on if there were multiple matches or not.

• If the key is matched once, the existing object record is updated.
• If the key is matched multiple times, handling will depend on MatchHandling setting.

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.

Note: When performing upserts on Dynamics, the UPSERTFIELDS must correspond to fields defined as alternate keys in Dynamics. If they do not match the fields defined as alternate keys, Dynamics will report the following error: Ensure that the names and number of key properties match the declared or alternate key properties for the resource 'Microsoft.Dynamics.NAV....'

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 (displayName, city) VALUES (?, ?), (?, ?) ON DUPLICATE KEY UPDATE UPSERTFIELDS = (displayName)";
try {
	DataSource navSource = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = navSource.getConnection();
	PreparedStatement ps = connection.prepareStatement(sql);
	ps.setString(1, "jtest01");
	ps.setString(2, "oakville");
	ps.setString(3, "jtest02");
	ps.setString(4, "oakville");
	ps.executeUpdate();
	LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
	e.printStackTrace();
}

id,errorcode,errormessage,processdata,isNew
0bf02dfb-845a-ef11-bfe2-002248ae64e6,null,null,{"city":"oakville","displayName":"jtest01"},true
b1eaaae4-325e-ef11-bfe2-6045bd611d1d,null,null,{"city":"oakville","displayName":"jtest02"},false

Metadata Discovery

This section provides examples on how to retrieve table and column metadata using the getTables and getColumns 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 {
	DataSource navSource = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = navSource.getConnection();
	ResultSet rs = connection.getMetaData().getTables(null, null, null, null);
	LOGGER.info("\r\n" + rs.toString());
} catch (SQLException e) {
	LOGGER.error(e.getMessage());
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS
null,null,ADARequirementReport,Table,
null,null,Abbreviations,Table,
null,null,AbsenceCode,Table,
null,null,AbsenceCodeGroup,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.

try {
	DataSource navSource = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = navSource.getConnection();
	ResultSet rs = connection.getMetaData().getColumns(null, null, "SalesOrderHeaderV2", 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,SalesOrderHeaderV2,ArePricesIncludingSalesTax,12,java.lang.String,255,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,SalesOrderHeaderV2,BaseDocumentDate,93,java.sql.Timestamp,0,null,0,0,null,null,null,93,null,null,null,null,null,null,DT_DBTIMESTAMPOFFSET
null,null,SalesOrderHeaderV2,BaseDocumentLineNumber,4,java.lang.Integer,0,null,0,0,null,null,null,4,null,null,null,null,null,null,DT_I4
null,null,SalesOrderHeaderV2,ReportingCurrencyFixedExchangeRate,3,java.lang.Object,0,null,0,0,null,null,null,3,null,null,null,null,null,null,DT_DECIMAL
null,null,SalesOrderHeaderV2,RevRecLatestReverseJournal,4,java.lang.Integer,0,null,0,0,null,null,null,4,null,null,null,null,null,null,DT_I8

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.

try {
	DataSource navSource = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = navSource.getConnection();
	ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "SalesOrderHeaderV2");
	LOGGER.info("\r\n" + resultSet.toString());
	Assertions.assertNotNull(resultSet);
} catch (SQLException e) {
	LOGGER.error(e.getMessage());
}

TABLE_NAME,PRIMARY_COLUMN_NAME
SalesOrderHeaderV2,SalesOrderNumber
SalesOrderHeaderV2,dataAreaId

The getPrimaryKeys method returns the following columns:

Connection Settings