Defining the database driver

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

Before you begin: 

By default, the PostgreSQL driver is included in Pega Platform for Pega Cloud Services environments. This task is not required for making external PostgreSQL connections in a Pega Cloud environment.

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.
Define a driver so that Pega Platform can connect to database platforms that are different from the Pega Platform database.
  1. In the header of Dev Studio, click Configure > Application > Distribution > Import.
  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.