Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Pega Collections integration architecture

Updated on March 28, 2022
Note: Starting in version 8.5, Pega Customer Decision Hub™ is Pega's main solution for one-to-one customer engagement, combining the features available in previous versions of Pega Marketing™ and Pega Customer Decision Hub with many new features. Pega Marketing is no longer available as a separate product.

Integration between Pega Collections Customer Decision Hub and Pega Collections Customer Service is achieved through the standard application programming interface (API) which is Simple Object Access Protocol (SOAP), as shown in the following figure:

Pega Collections architecture
Pega Collections architecture

The SOAP service package for NBAFSServices provides one or more service methods for an external application to use. Each method in the service package corresponds to a SOAP service rule that identifies an activity to run and maps the incoming and outgoing data. NBAFSServices defines the following SOAP service rules:

Authentication and Security

The Collections SOAP service uses the PegaCDHFS:CDHAdmins access group for security access. If you are referencing the Pega Customer Decision Hub for Financial Services sample application, then you will see the access group CRMFS:MarketAdmins instead. If you opt to use your own access groups for the security of this services, you will need to update the security access group on the NBAFSServices service package rule.

Define security for the SOAP service by using the following Authentication Profile rules: 

  • NBAFSAuthProfile rule in the Pega Collections application
  • CPMFSAuthProfile rule in the Pega Customer Decision Hub application

Both authentication profiles reference operators. Two operators must be present and have access groups that are pointed to your Pega Customer Decision Hub and Pega Collections implementation applications: one for Customer Service for Financial Services, one for Pega Customer Decision Hub for Financial Services.

To create the operators, Save as these two authentication profile rules into your implementation application.

To access the marketing services from a non-Pega external application, create an operator with the PegaCDHFS:ExternalServices access group and use that operator for authentication.

The CPMFSSysAdmin operator is provided in the Collections application but it is disabled. Enable this operator and update its associated access group to your implementation Pega Collections application.

  • Previous topic Integration to Pega Customer Decision Hub for Pega Collections
  • Next topic Configuring contexts in Pega Collections


Pega Collections 8.3 - 8.4 Pega Marketing for Financial Services 8.3 - 8.4 Pega Customer Service for Financial Services 8.3 - 8.6 Pega Customer Decision Hub for Financial Services 8.5 - 8.6

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