Skip to main content

Creating Couchbase database instances

Suggest edit
Updated on August 25, 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. 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 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: 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.
  11. Click Save.
  12. 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.
Did you find this content helpful? YesNo

Have a question? Get answers now.

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

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