Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Defining the database driver

Updated on April 5, 2022

Define a JDBC driver in your on-premises Pega Platform by using the Import Wizard and creating or updating a dynamic system setting.

Note: By default, the PostgreSQL driver is included in Pega Platform for Pega Cloud Services environments. Do not upload an additional PostgreSQL driver to a Pega Cloud environment as it will cause conflicts with the driver already on the system.
Before you begin: Download the appropriate driver from your database vendor. The Java version of the driver must be compatible with the Java version of your application server.
  1. In the header of Dev Studio, click ConfigureApplicationDistributionImport.
  2. Select the database driver file that you obtained from your database vendor and then follow the steps in the Import Wizard to complete the import.
  3. Expand the SysAdmin category, and then click Dynamic System Settings.
  4. Search for the dynamic system setting instance whose Setting Purpose equals prconfig/database/drivers/default.
    • If the instance does not exist, click Create, enter the following values, and then click Create and open.
      • Short descriptionprconfig/database/drivers/default
      • Owning RulesetPega-Engine
      • Setting Purposeprconfig/database/drivers/default
    • If the instance already exists, click the row to open the instance.
  5. In the Value field, enter the fully-qualified class name for the JDBC driver that you import. If the Value field is already populated, separate the individual driver class names with a semicolon (;). See your database vendor documentation for the class names.
  6. Click Save.
  7. Restart the nodes in the cluster so that all tiers in the system recognize your new database driver, using the method appropriate for your deployment
    • For Pega Cloud Services environments, create a new support ticket to restart the environment.
    • For on-premises systems, manually restart each node.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us