Skip to main content

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

Creating database instances for prconfig references

Updated on August 25, 2021

Create a database data instance so that Pega Platform can access a database whose connectivity is defined in the prconfig.xml file.

Before you begin: To use a configured reference, you must have identified the database and its connectivity parameters in the prconfig.xml file under database/databases and restarted the server. For more information, see Changing node settings by modifying the prconfig.xml file.
Not supported in Pega Cloud services environments.
  1. If the database platform of the additional database differs from the database platform of Pega Platform, or does not use postgresSQL, define Pega Platform the database driver. For more information, see Defining the database driver.
  2. In the header of Dev Studio, click CreateSysAdminDatabase.
  3. Enter a short description, and in the Database field, enter a name for the external database.
    The database name that you enter must be specified in the prconfig.xml file under database/databases. For example, for an entry that is named database/databases/AcmeDB, enter AcmeDB.
  4. Click Create and open. The Edit <YourNewDatabaseName> Database page appears.
  5. Optional: To indicate the system of record, in the Integration system field, press the Down arrow key and select the name of the integration system to associate with this database.
    The value that you select is for informational purposes only, and does not affect the behavior of the database instance. You can use this value to organize rules for integration connectors, data types, and sources for data pages.
  6. In the How to connect list, click Use configuration in preferences.
  7. Optional: On the Advanced tab, specify the names of other database instances that should be reachable by views in this database.
    1. Under the Database Name list, click the Add item icon.
    2. In the Database Name field, press the Down arrow key, and select the name of a database instance that views in the external database need to access.
    For example: This database instance describes the EXTERNAL1 database. Your Pega application needs to access a view in EXTERNAL1 that joins data from the DATA1 and DATA2 databases. Do the following steps:
    • Define database instances for DATA1 and DATA2.
    • On the database instance for EXTERNAL1, list DATA1 and DATA2 as other databases.
  8. Click Save.
  9. To test the database connection, on the Database tab, click Test connection.
    • If the test fails, diagnostic information appears in a new window. Modify the database instance until the test succeeds.
    • This test does not test the administrative user, if any, that you might have specified.
  • Previous topic Defining the database driver
  • Next topic Creating and updating external database instances with JDBC URLs

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