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.

Creating database instances for JDBC URLs

Updated on April 5, 2022

Specify a JDBC URL to create a database data instance so that Pega Platform can access a supported external database.

Before you begin:

Pega Platform manages the database connections you create by specifying a JDBC URL. As best practice, when deploying on Pega Cloud Services environments, use JDBC URLs to define database instances. When deploying on-premises or using client-managed cloud systems, use JDBC connection pools. For more information, see Creating database instances for JDBC connection pools.

Pega Cloud only: External database instances require a VPN connection. Ensure that the CIDR range allowed on the VPN for your VPC includes the network for your database endpoints.
Note: By default, one base user per node creates a default connection pool of 20, and other users (admin and read-only) create 5. External databases do not release connections when they are not in use.
  1. If the database platform of the additional database differs from the database platform of Pega Platform, or does not use postgresSQL, configure Pega Platform to access 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 additional database.
    The database name is case-sensitive.
  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 JDBC URL listed below.
  7. In the JDBC URL field, enter the JDBC URL.
    The format of the JDBC URL depends on the database platform. Precise syntax requirements vary depending on the server platform, database version, and JDBC client. Additional parameters may also be required. Consult your database administrator for details. The following table shows some examples of JDBC URLs.
    DatabaseURL
    Oraclejdbc:oracle:thin:@serverName:​1521:​service-name-or-SID
    Microsoft SQL Serverjdbc:sqlserver://127.0.0.1:1433;​DatabaseName=database;​SelectMethod=cursor;​SendStringParametersAsUnicode=false
    IBM Db2jdbc:db2://serverName:port/dbName:​fullyMaterializeLobData=true;​fullyMaterializeInputStreams=true;​progressiveStreaming=2;​useJDBC4ColumnNameAndLabelSemantics=2;
    PostgreSQLjdbc:postgresql:​//serverName:5432/dbName
  8. In the Authentication section, add the required and any optional credentials for the external database connection.
    1. To add standard users, in the Username field, enter the name of a database user who has read and update permission, and in the Password field, enter the password for that user.
      Specify a user that is capable of accepting unqualified table names and converting them to fully qualified table names. If this database is to be accessed through Connect SQL rules, confirm that this database user has search, update, delete, and other permissions that support the SQL statements in those rules, and that this database is the default database of the user.
    2. Optional: To add users with Administrator permissions, in the Admin username field, enter the name of a database user who has permission to alter and create tables, and in the Admin password field, enter the password for that user.
      Specify a user is capable of to configuring tables that extend the data schema. The admin user is used for platform-generated schema changes, property optimization, and circumstance definitions.
    3. Optional: To add users with read-only permissions, in the Read-only username field, enter the name of a database user who has read-only permission, and in the Read-only password field, enter the password for that user.
      Specify a user is capable of querying tables to pull database information, but cannot update, delete, change schemas, or otherwise interact with a database.
  9. Click Save.
  10. Optional: Click the Advanced tab.
  11. Leave the Connection count limit field blank. It is reserved for future use.
  12. Leave the Failover options fields blank. They are reserved for future use.
  13. Optional: To specify a proxy class for determining access privileges to the Schema Tools, Query Inspector, and Query Runner landing pages, in the Proxyclass name field, enter the proxy class.
    The proxyclass is used with the read-only user that you define on the Database tab.
  14. Optional: If this database is used for tables that you have configured for use by Pega Platform and the BLOB user-defined function is installed on the database, select the Use UDF for property lookup check box for best performance of Pega:Lookup tag references.
  15. 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.
  16. Click Save.
  17. 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 Creating database instances for prconfig references
  • Next topic Creating database instances for JDBC connection pools

Related articles

Database data instancesCreating database data instancesIntegration systemsConfiguring dynamic system settings

Tags

Pega Platform 8.4 System Administration

Have a question? Get answers now.

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

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us