Skip to main content


Creating Couchbase database instances

Suggest edit Updated on August 18, 2021

Create a database data instance for a NoSQL Couchbase database so that Pega Platform can access that database.

  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. In the Create database tab, enter a short description, and in the Database field, enter a name for the external database.
    The database name is case-sensitive.
  4. Click Create and open.
  5. Optional: To indicate the system of record, in the Integration system field, press the Down arrow key, and then select the name of the integration system that you want 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 Couchbase configuration listed below.
  7. In the Couchbase Hostnames section, click Add Host, and then enter a host name or IP address for a node in the Couchbase cluster.
    You can specify multiple hosts.
  8. In the Couchbase Cluster section, enter the Bucket Name and Bucket Password of the bucket that the Couchbase Server uses to save your data.
  9. In the Couchbase timeout (global) field, enter the connection timeout, in milliseconds.
  10. Optional: To specify the names of other database instances that views in this database can reach, on the Advanced tab, define the database parameters:
    1. In the Database Name list, click the Add item icon.
    2. In the Database Name field, press the Down arrow key, and then 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. To configure your application to access a view in EXTERNAL1 that joins data from the DATA1 and DATA2 databases, define database instances for DATA1 and DATA2, and then list DATA1 and DATA2 as other databases on the database instance for EXTERNAL1,
  11. Click Save.
  12. Optional: To test the database connection, on the Database tab, click Test connection.
    This test does not test the administrative user that you specify.
    1. Diagnostic information appears in a new window if the test fails.
    2. Modify the database instance until the test succeeds.
Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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