Skip to main content

Entity data sources

All entities in the Common Data Model use internal or local storage by default. Sample data for the entities is stored in the database of your Pega application.

The Common Data Model can connect to external systems of record for entity data. You can integrate with a different storage option on an entity-by-entity basis.

Pega Platform™  includes three options to store entity data. You typically implement a combination of these approaches depending on the entity.

Note: In the Common Data Model, the core entities use local storage by default. This configuration includes the components that integrate the data with your application, including core entities and their associated Data Pages and Data Transforms. The components use design patterns and naming conventions of the Common Data Model. In many cases, you can use your own database, also known as external data storage. To integrate external storage for an entity, you modify the existing Data Pages and Data Transforms

Store data in Pega Platform (local storage)

Create and store the data in Pega Platform, as shown in the following figure. This method works without additional configuration.

local storage configuration

In the example, a Case in the application uses the Contact entity to store and retrieve contact data in the local data store, which is the system of record.

The logical Data Model shows that the entity is part of the Common-LDM-Entity Class and that the D_Contact Data Page connects to the local data store.. The system of record (SOR) is the database of the Pega application.

For the local storage option, review the following items before storing entity data:

  • The default deployment model for core CRM entities is to import data into the physical storage of Pega Platform through a set of high-quality APIs and integration gateways. To import data, you use the Pega Platform APIs or Pega Business Intelligence Exchange™ (BIX).
  • Pega Platform includes local physical storage for core CRM entities. The default integration connects to this physical store.
  • Pega Platform abstracts the source of data as with any software integration, but Pega Platform always targets a known quantity that has known scalability, performance, messages, and error handling.

Store a copy of data in Pega Platform (local copy)

You want to store data locally in Pega Platform and update other systems and databases with changes, as in the following figure:

local storage with copy

To set up this option, perform one of the following actions:

  • Create a copy of your existing SOR data. You can bulk upload a copy of SOR data build using scheduled updates to Pega Platform from your master data management solution.
  • To extract data to your master data management solution, use the Pega Platform APIs or BIX.

Client is the System of Record (SOR)

You can create a connection to an external SOR and integrate the data with your application through the Common Data Model, as in the following figure: 

external storage

In the example, a Case in the application uses the Contact entity to store and retrieve contact data in the external data store (the SOR).

The logical Data Model shows that the entity is part of the Common-LDM-Entity Class and that the D_Contact Data Page connects to the external data store by using a REST API. The SOR is the customer-maintained external database. The external database can be any Pega-supported databases.

With this storage method:

  • The system does not store data in Pega Platform tables.
  • You point Data Pages in Pega Platform to your APIs for all create, read, update, and delete (CRUD) actions. As a result, the system updates the data in your SOR. By using Data Pages and aggregate data sources, you can integrate your SOR and join with the data that is in Pega Platform.

This Topic is available in the following Module:

If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

Want to help us improve this content?

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

Pega Academy has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice