Skip to main content

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

Data management and integration

Updated on November 23, 2022

Pega Platform™ includes powerful and flexible facilities for defining data structures and managing data. You can define individual fields, arrays and repeating groups, multilevel structures, and a variety of other data structures. To support the exchange of data with other systems, your application can convert a Pega Platform data structure into a fixed record layout, a JSON document, a message, or a relational database row.

Modern enterprise applications and their data sources are rarely contained on the same system. Integration protocols and interoperability standards federate the data traditionally locked away in legacy systems of record, allowing you to design applications that link multiple physically distributed resources. Pega Platform provides a comprehensive range of data and integration capabilities that simplify connecting your application to these distributed resources to enable easy, flexible, and real-time access to the rich data that they store.

Integration is a broad subject that applies to many aspects of Pega Platform. Pega Platform natively supports a range of integration standards and communication protocols, allowing you to focus on the business requirements of your application rather than on connectivity issues. For more information, see the following articles. For integration on Pega Cloud, see Integrating Pega applications in Pega Cloud with external systems.

  • Data modeling

    Data modeling is the process of creating a logical representation of the data stored in your database. By modeling data, you bring information into your application in a format that makes sense for your business.

  • Adding a data object

    Data objects define the logical data layer and hold data for your application. A data object simplifies the organization of the properties, data pages, transforms, and other elements your application needs to get the right data at the right time. Data objects are called data types in Dev Studio.

  • Adding fields

    Use the following topics to define fields for your data object. For example, you can add choices to a picklist to control which options a user selects.

  • Adding relationships

    Use the following topics to understand how to add relationships in your application.

  • Updating your data model

    Maintain data integrity by updating your data model when changes occur.

  • Importing external data

    To add data from an external source to your application, import a .csv file. You can efficiently import data that is stored in your organization's spreadsheets by using the Data Import wizard.

  • Exporting data records

    To get application data into an editable CSV file, create an export file.

  • Data views

    Use data views to bridge the connection between your application and the integration and to give your application the data the way the application expects to receive it.

  • Data pages

    A data page defines the contents of a clipboard page and enables the system to access data from a range of sources on demand.

  • Data extraction

    Create a broad view of your business by integrating Pega Platform data with data from other systems of record using Business Intelligence Exchange (BIX). BIX extracts transactional data from the Pega database into formats suitable for exporting to a reporting data warehouse, operational data store (ODS), or other downstream process. The BIX extraction process extracts data into .xml, .csv, and database schema formats.

  • Pega APIs and services

    You can use the Pega APIs to power client and mobile apps by using built-in Pega REST/JSON services. Pega APIs provide an extensive set of APIs to manage and interact with all aspects of your application, such as cases, assignments, and so on. The APIs are secured by user credentials and TLS/SSL. You must switch from App Studio to Dev Studio to configure security for the Pega API, which is the api service package.

  • Integrating with file and content management systems

    File storage and knowledge management repositories store assets and provide versioning and metadata support. Pega Platform can communicate with common repository technologies and can also act as a binary repository.

  • Integrating with Pega APIs and services

    Learn how to generate accurate and complete OpenAPI Specification (OAS) documentation for your REST APIs, and learn where to view your REST APIs in your application.

  • Pega Open Robotics integration

    With Pega Open Robotics, you can integrate your existing robotic process automation implementation with your Pega Platform application. By reusing your existing robotic process automations, you save time, reduce implementation costs, and improve the overall user experience by providing end to end processes. Pega Open Robotics supports integration with UiPath and Blue Prism.

  • Integrating DocuSign with Pega Platform

    Use the DocuSign service to electronically sign documents for a variety of business transactions. You can integrate DocuSign with your Pega Platform™ application to collect digital signatures during case processing. You can sign, review, and exchange documents electronically, which eliminates having to manually print, sign, and scan documents back into your system. You can also make dynamic corrections and modifications to the documents before signing them.

  • Managing integrations

    Learn how to effectively manage your integrations in Pega Platform. For example, you can categorize your application settings to make them easier to search for and to better understand their purpose.

  • Integrating with an email provider

    Create an email integration to manage incoming and outgoing email directly in your Pega Platform application. An email integration consists of an email account, email listener, email service rule, and service activity.

  • Integration Resources category

    The nineteen data classes in the Integration-Resources category support services and connectors with data that may vary from system to system (and so is not saved in a rule).

  • Messaging service overview

    You can integrate a Java Messaging Service (JMS) with Pega Platform to communicate with other applications, or have other applications communicate with Pega Platform, without requiring a direct synchronous integration between systems.

  • About JMS Listener data instances

    JMS listeners provide the information needed to route Java Message Service (JMS) messages from a specific topic or queue to a JMS service rule. A JMS listener or JMS MDB listener data instance specifies which queue or topic contains the messages to be consumed and which JMS service rule(s) will process the messages.

  • About JMS MDB Listener data instances (Data-Admin-Connect-JMSMDBListener)

    JMS listeners provide Pega Platform with the information it needs to route Java Message Service (JMS) messages from a specific topic or queue to a Pega Platform JMS service ( Rule-Service-JMS rule type). A JMS listener or JMS MDB listener data instance specifies which queue or topic contains the messages to be consumed and which JMS service rule(s) will process the messages.

  • About JMS Producer Model data instances

    A JMS Producer Model data instance holds messaging settings for JMS connector rules. A single JMS producer model instance may be referenced by more than one JMS connector rule.

  • About JMS Transport data instances

    Create a JMS Transport data instance to record the information used to connect to an external SOAP service using the JMS binding.

  • About JNDI Server data instances

    Create a JNDI Server data instance to the record information used to log into a Java-EE-compliant application server to obtain Java Naming & Directory Interface® information.

  • About MQ Listener data instances

    MQ listeners provide the information needed to route WebSphere MQ messages from a specific queue to an MQ service rule. An MQ listener specifies which queue contains the messages to be consumed and which MQ service rule(s) are to process the messages.

  • About MQ Server data instances

    Use this form to configure an IBM MQ server to work with Pega Platform MQ connectors and services.

  • Service Request Processor data instances

    When an EJB, HTTP, Java, JMS, MQ, or SOAP service rule is configured to process service requests asynchronously, or is configured to requeue failed service requests for a later execution attempt, service request information is stored as a persistent object in a request queue in the PegaRULES database.

  • About Service Package data instances

    Use a Service Package data instance to define a package name, define access for listeners, and support deployment of services.

  • About Class Generator data instances

    The Data-Admin-ClassGenerator class is deprecated. See Using the Connector and Metadata wizard .

  • About Connect Generator data instances

    The Data-Admin-ConnectGenerator class is deprecated. See Using the Connector and Metadata wizard.

  • About Metadata Converter data instances

    The Data-Admin-MetadataConverter class supports system interface generator facilities. Instances link to Pega Platform Java classes that provide format conversions. For example, this facility can convert XML Document Type Definition documents to the newer XML Schema Definition format.

  • About Registry Java Property Transform data instances

    Instances of this data class support the Connector and Metadata wizard when this tool generates class rules and properties from a Java class.

  • Kafka data instances

    You can use this data instance to create a client connection between Pega Platform and an external Apache Kafka server or a cluster of servers.

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