External data sources for data types

Source data can be used in the user interface as a field that provides options for the user. The input field can limit the set of permissible values defined by the source data. Limiting the input values to valid options reduces errors and promotes reuse and automation. For example, a drop-down list limits the valid values that users can select from a list of store branches that is retrieved from an external system.

Match the numbers in the following image to learn more about each data source:

1.Pega System of Record: A Pega system of record can locally source Data Types. For example, in a New Candidate application, HR selects a conference room in which to conduct the interview. The Pega system of record contains a list of conference rooms. The Pega system of record locally sources the Conference Room Data Type.

2. No System of Record: Data Types can obtain data that is entered or transformed during application processing and is not associated with a system of record. For example, in a New Candidate application, you capture candidate information about dietary restrictions to help HR provide an appropriate lunch for the candidate during the interview break. The Dietary Restrictions data type is used for Case processing but is not pushed to a system of record.

3. External System of Record: Connect to an external database to retrieve data. For example, you have a Candidate Data Type that populates candidate information from a drop-down list. An external system of record sources the Candidate Data Type. Only the user-selected candidate information is added to the Case Type.

Check your knowledge with the following interaction: 

Sourcing a Data Type with an external system of record requires a service. You can source a Data Type from an external system of record through a Representational State Transfer (REST) service by using GET or POST commands.

Adding an external data source to a Data Type extends that Data Type with a connector to access the service, while Data Transforms are automatically generated to map data between the Data Models for the Data Type and the host service. If the service requires a user name and a password for access, you can optionally configure an Authentication Profile and OAuth 2.0 provider for the Data Type. You can also manage Data Types and related data sources that are associated with other external systems of record such as SOAP, SAP, and AWS.

For example, an HR Specialist interviews a candidate. The Candidate application must access data that is hosted on an external vendor system, such as the candidate name, address, and email. Given the Candidate ID, the onboarding business process invokes the Candidate API REST Service. The Candidate API then returns a response containing the candidate name, address, and email.

Match the numbers in the image to learn more about configuring a Data Type with a REST API:

1. Service authentication: If the source system requires authentication, you can configure the basic, NTLM, or OAuth authentication method to send Data Records to and from your Pega Platform application. In this example, you configure your Pega application to use the basic authentication method to authenticate to the Candidate external system.

2. Application request: Your application passes the parameters in the service request to the external system of record. In this example, the Candidate ID parameter is passed in the service request to the Candidate_SOR REST Service. 

3. Connect a new Data Type to an external SOR: To connect a Data Type to an external system of record (REST API), you use the Data object wizard. The wizard guides you to name the external system and define the Endpoint URL (with parameters) to access the REST Service. In this example, your Pega Platform application connects to a new system of record called Candidate_SOR. 

4. Configure the Data Type for production: In the Data Object wizard, configure the environment settings (URLs) to deploy the data source (service) to different environments — production and lower environments (development and staging) as necessary. In this example, you configure the environment settings (Dev, Stage, and Prod URLs) to deploy the Candidate_SOR REST data source to the development, staging, and production environments.

5. Map the response: Pega Platform parses the REST response and maps the fields to the Data Type. In this example, the Candidate_SOR REST Service response fields are mapped to the Candidate Data Type. Note that some limitations apply when you map fields in the Data Mapping form. Fields must be mapped at the same level. For example, if a field is nested, you cannot map it to a top-level field.

6. Service response: Based on the parameter sent by your application, the system of record sends a response. Parameterization of the REST elements promotes reuse of the connection. In this example, the Candidate_SOR REST Service responds with the Candidate ID data: name, address, and email. 

Check your knowledge with the following interaction: