Dynamics 365 Finance & Operations

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 three ways to connect to Dynamics AX:

Password

Enter Service URL, User Name, Password, Active Directory Tenant, Client App Id, Client Secret to establish a connection.

Certificate

Users can choose to use a saved certificate file and certificate password to establish a connection. If you wish to generate a new certificate, click Generate New Certificate to go through the certificate process, generate a keystore, save it locally, and use the set certificate password to connect.

NOTE: The certificate file only supports the PFX format. For newly generated certificates, a PEM file is also generated. This PEM file needs to be configured in the portal.

Client Credentials

Enter Authentication Server, Service URL, Service Resource, and the Client ID, Client Secret, and Tenant configured in the portal 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 FleetCustomer WHERE Country = 'US' ORDER BY DriverLicense DESC, AddressLine1 ASC";
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 Abbreviations (AddrTypeCode, AddrTypeFullName, AddrTypeLevel, AddrTypeName) VALUES ('ABCDE', 'testAddrFN', 1, 'testAddrTN')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
AddrTypeCode='ABCDE',null,null,{"@odata.type":"Microsoft.Dynamics.DataEntities.Abbreviations","AddrTypeLevel":1,"AddrTypeName":"testAddrTN","AddrTypeCode":"ABCDE","AddrTypeFullName":"testAddrFN"}

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 Accountant SET AccountantName = 'TestAccountName', CPF = '230298098-03' WHERE CRC = '1234567654'";
try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
CRC='1234567654';CPF='230298098-03',null,null,{"@odata.type":"Microsoft.Dynamics.DataEntities.Accountant","AccountantName":"TestAccountName"}

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 FleetCustomer WHERE DriverLicense = '000001'"
	+ " AND FirstName='first' AND LastName='last'";
try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
{DriverLicense='000001';FirstName='first';LastName='last'},null,null,
	{"@odata.type":"Microsoft.Dynamics.DataEntities.FleetCustomer"}

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

Note: When performing upserts on Dynamics, 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.AX....'

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 FleetCustomer (FirstName, LastName, DriverLicense, AddressLine1) VALUES "
	+ "('first', 'last', '000001', '1 Street'),"
	+ "('first2', 'last2', '000002', '2 Street') "
	+ "ON DUPLICATE KEY UPDATE UPSERTFIELDS = (FirstName, LastName, DriverLicense)";
try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata,isNew
{DriverLicense='000001';FirstName='first';LastName='last'},null,null,
	{"@odata.type":"Microsoft.Dynamics.DataEntities.FleetCustomer","AddressLine1":"1 Street",
	"DriverLicense":"000001","FirstName":"jtest","LastName":"jtest"},true
{FirstName='first';DriverLicense='000002';LastName='last'},null,null,
	{"@odata.type":"Microsoft.Dynamics.DataEntities.FleetCustomer","AddressLine1":"2 Street"},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.

String sql = "SELECT * FROM FleetCustomer WHERE Country = ? ORDER BY DriverLicense DESC,"
	+ "AddressLine1 ASC";	
try {
	JdbcDriverPackDataSource ax = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = ax.getConnection();
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "US");
    boolean ret = ps.execute(sql);
    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 sql = "INSERT INTO FleetCustomer (FirstName, LastName, DriverLicense) VALUES (?, ?, ?)";
try {
    JdbcDriverPackDataSource ax = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = ax.getConnection();
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "first");
    ps.setString(2, "last");
    ps.setString(3, "001");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
{DriverLicense='001';FirstName='first';LastName='last'},null,null,
	{"@odata.type":"Microsoft.Dynamics.DataEntities.FleetCustomer","DriverLicense":"001",
	"FirstName":"first","LastName":"last"}

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 FleetCustomer SET AddressLine1 = ? WHERE DriverLicense = ? AND FirstName = ? AND LastName = ?";
try {
    JdbcDriverPackDataSource ax = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = ax.getConnection();
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "address 1");
    ps.setString(2, "001");
    ps.setString(3, "first");
    ps.setString(4, "last");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e.toString());
}

id,errorcode,errormessage,processdata
{DriverLicense='001';FirstName='first';LastName='last'},null,null,
	{"@odata.type":"Microsoft.Dynamics.DataEntities.FleetCustomer","AddressLine1":"address 1"}

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 FleetCustomer WHERE FirstName = ? AND LastName = ? AND DriverLicense = ?";
try {
    JdbcDriverPackDataSource ax = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = ax.getConnection();
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "first");
    ps.setString(2, "last");
    ps.setString(3, "001");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    e.printStackTrace();
}

id,errorcode,errormessage,processdata
{DriverLicense='001';FirstName='first';LastName='last'},null,null,
	{"@odata.type":"Microsoft.Dynamics.DataEntities.FleetCustomer"}

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

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.AX....'

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 FleetCustomer (FirstName, LastName, DriverLicense, AddressLine1) "
	+ "VALUES (?, ?, ?, ?), (?, ?, ?, ?)"
	+ "ON DUPLICATE KEY UPDATE UPSERTFIELDS = (FirstName, LastName, DriverLicense)";
try {
    JdbcDriverPackDataSource ax = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = ax.getConnection();
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "first");
    ps.setString(2, "last");
    ps.setString(3, "000001");
    ps.setString(4, "1 Street");
    ps.setString(5, "first2");
    ps.setString(6, "last2");
    ps.setString(7, "000002");
    ps.setString(8, "2 Street");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    e.printStackTrace();
}

id,errorcode,errormessage,processdata,isNew
{DriverLicense='000001';FirstName='first';LastName='last'},null,null,
	{"@odata.type":"Microsoft.Dynamics.DataEntities.FleetCustomer","AddressLine1":"1 Street",
	"DriverLicense":"000001","FirstName":"first","LastName":"last"},true
{FirstName='first2';DriverLicense='000002';LastName='last2'},null,null,
	{"@odata.type":"Microsoft.Dynamics.DataEntities.FleetCustomer","AddressLine1":"2 Street"},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 {
    DataSource ax = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = ax.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 ax = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = ax.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,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 ax = new JdbcDriverPackDataSource("connectionString", connectionProps);
	Connection connection = ax.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