Adding a new 3rd party data source (component) for entity enrichment in Pega Foundation for Financial Services

From PegaWiki
Adding a new enrichment provider that is not yet available in Pega Marketplace / This is the approved revision of this page, as well as being the most recent.
Jump to navigation Jump to search

Adding a new 3rd party data source (component) for entity enrichment in Pega Foundation for Financial Services

Description Add a new enrichment data provider for PFFS
Version as of 8.5
Application Pega Foundation for Financial Services
Capability/Industry Area Financial Services



Adding a new 3rd party data source for entity enrichment[edit]

Enriching the customer and company data from financial information providers provides many benefits to financial services organizations, including operational efficiencies, more efficient management of credit decisions, verification of identity, increased fraud awareness, provision of more targeted and personalized cross-selling and upselling strategies, and optimization of collection treatments.

Pega Foundation for Financial Services (PFFS) provides a single, unified approach to creating and extending integrations to a list of financial information providers that all Financial Services (FS) applications can access.

There are two parts to enabling a new enrichment data provider in Pega Foundation for Financial Services:

  • Adding a new component containing the integration with the data provider (Creating a new component is not covered in this article).
  • Implementation in the foundation (application) layer of, for example, construction of input calls to the provider, error handling, and mapping of results.

Adding a new component to Pega Foundation for Financial Services application[edit]

Component can be downloaded from Pega Marketplace or enabled in the application rule if already bundled with Pega Foundation for Financial Services. A list of components for every version is available in the Optional Components section of the install guide, available on Pega Foundation for Financial Services community site. Select your platform version from the Pega Foundation for Financial Services community site.

Before you begin[edit]

In the Enabled components section of the application rule, click Manage components.

Manage components.png

Note: If the desired component is already present in your system, select the Enabled check box. Otherwise, check if your component is available and enable or download from Pega MarketPlace by clicking on BROWSE APPS & COMPONENTS.

Download a component from Pega Marketplace (formerly known as Pega Exchange).

Component screen.png

Search for the component that you want to use.

Marketplace.png

Implementing the component in Pega Foundation for Financial Services[edit]

Verify if PFFS supports your downloaded/enabled component by launching Get eEnrichment Reports case in PFFS. If your component (provider) is listed then 3rd party data provider has been enabled in PFFS and no other setup work needs to be done.

Verify component.png

Otherwise, proceed with extending (using save as) rules to add component to entity enrichment processing in PFFS. When adding a new (component) data provider, note the following about Entity Enrichment logic:

  • Every component will have 2 functions enabled Search and Details
  • All components (data providers) return the same set of data

PFFS class structure of for external data providers has been designed to call each data provider and retrieve results in the unified way. This logic is described below.

There are two data pages in PFFS responsible for searching entities and retrieving entity details. They are described below. In order to add your new data provider, you need to modify data transforms invoked by search entity and entity details data pages.

PegaFS-Data-ExtProvider- is a centralized class for making component calls and mapping returned data back into the Financial Services data structure. There are also specialized child classes that are dedicated to handling enrichment and output mapping.

Class: PegaFS-Data-Ext Provider-BusService-eEnrichment

Description:  Class for retrieving search results and entity details for party enrichment.

Data Pages: Unified data pages for searching and for entity details; selects an applicable provider based on input, executes specialized data pages for the provider to perform service calls, and handles output, including errors.

  • D_Trigger_SearchEntity is a unified data page for searching data providers.
  • ClientList page is where results are mapped (see illustration below). This is done in exactly the same for all data providers.

Trigger Search Entity.png

D_Trigger_SearchEntity calls Trigger_SearchEntity data transform where condition to invoke provider specific data page needs to be added.

Note: In the example below, step 1 represents conditions for invoking data page for Avox (D_TriggerAvox_SearchEntity).

D_TriggerAvox_SearchEntity data page calls rules from the component responsible for search.

SearchEntity1.png

  • D_Trigger_EntityDetails data page for entity details.
  • ClientData page is where results are mapped (see illustration below). This is done in exactly the same for all data providers.

Entity Details.png

D_Trigger_EntityDetails calls Trigger_EntityDetails data transform where condition to invoke provider specific data page needs to be added.

Note: In the example below, step 2 represents conditions for invoking data page for Avox (D_TriggerAvox_EntityDetails).

D_TriggerAvox_EntityDetails data page calls rules from the component responsible for retrieving entity details.

DetailEntity1.png

Selection of rule for specific data provider is based on Provider parameter as illustrated above, The end result is invocation of a specific data page > data transform for the provider. Those data page->data transform rules as illustrated with TriggerAvox_EntityDetails example below, handles invocation of data pages from the component and connection errors.

Component Specific DT.png

End results and use case examples[edit]

Get eEnrichment Reports case in PFFS searches for entities and retrieves entity details based on selected data provider (component). If component has been added/enabled correctly, then it drop menu selection as illustrated below.

EEnrichment Search.png

Party details[edit]

Entity .png

References[edit]

Pega Marketplace

Component submittal form

Pega Foundation for Financial Services community site