Documentation Home

MS SQL Server


Download and install SQL Server (

Setup a Database

Create a new database and a user capable of accessing this database with privileges for creating tables included (see SQL Server documentation if you have questions about how to administrate databases and users).

Update the poms to use MS SQL instead of HSQL

In your project's core pom.xml, find the following in the <dependencies> section:


and replace it with


Finally add the MS SQL JDBC connector dependency to the <dependencies> section:


Update the Hibernate Dialect

Update the runtime properties to use the correct MS SQL dialect. In core/src/main/resources/runtime-properties/, you will want to update the three persistence unit dialects to say:


Enterprise and Multi-Tenant

You will need to update a 4th location as well:


Update the SQL Command Extractor

If you wish to utilize the heat clinic demo import scripts, edit core/src/main/resources/runtime-properties/ Update the following properties to cause the system to modify the import scripts at runtime for SQL Server compatibility:


Enterprise and Multi-Tenant

You will need to update a 4th location as well:


Add the database connection properties

In core/src/main/resources/runtime-properties/, add your database connection properties like so:

# your local database username, just a user that has readwrite permissions
# local database password
# this connection URL assumes that it is connecting to a schema called broadleaf

Note: I named my database broadleaf, make sure you use your database name in the url.

Update runtime properties to create the initial schema

It is likely that you will still need to initialize and seed the new MS SQL schema. Ensure that these properties are set in admin/src/main/resources/runtime-properties/

After starting up the admin once, you can change all of these back to update so that any data changes stay intact. Also, add the same properties set to update to site/src/main/resources/runtime-properties/ so that starting up site doesn't wipe your changes.

And that's it! You should now be up and running with MS SQL.