Skip to main content


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

Configuring a producer system for remote case types

Updated on March 31, 2021

To pass remote case types to another application, configure the system that stores your case types as a producer system. As a result, you provide a framework for case workers to process work from multiple applications without changing context, which promotes efficiency and saves time in your organization.

For example, your system might host Loan requests and Credit card operations applications. You want to publish case types from these applications to a VIP customers operations application so that users can perform work by logging in to this application only. You configure the system with the Loan requests and Credit card operations applications as the producer system first.
Before you begin: Ensure that your applications in the producer system use Cosmos React. For more information, see Cosmos React.
Accessing remote case assets that are available in the producer system requires performing security configurations. Pega Platform provides the OAuth 2.0 client registration, identity mapping, and token profile that you copy into your ruleset and edit to meet your business needs. The security configuration also requires your own truststore.

Preparing OAuth 2.0 client registration for remote case types

To ensure that remote application from a consumer system can properly communicate with your producer system, prepare the OAuth 2.0 client registration in your producer system. As a result, you create a secure and reliable connection between your producer and consumer systems.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Security category, and then click OAuth 2.0 Client Registration.
  3. In the list of instances, open the Remotecasetype_Producer OAuth 2.0 client registration.
  4. In the form header, click SaveSave as.
  5. On the Save OAuth 2.0 Client Registration As form, in the Client Name field, enter a unique label, and then click Create and open.
  6. In the form header, in the RS section, click Edit, and then, in the text field, provide the ruleset to associate with your application.
    For example:
    Associating a rule with a ruleset
    A screenshot that shows a form with a text box to provide a ruleset for a rule
  7. In the Client Credentials section, download the client ID and client secret by clicking View & download, and then click Save.
    Note: You provide the client ID and client secret credentials when you register a remote system during creation of a remote case type. Ensure that you store the credentials safely.

Preparing a token profile for remote case types

After you prepare the OAuth 2.0 client registration for your remote case types, prepare a token profile. Token profiles secure data exchange between two parties, such as producer and consumer systems.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Security category, and then click Token Profile.
  3. In the list of instances, open the Remotecasetype_Producer token profile.
  4. In the form header, click SaveSave as.
  5. On the Save Token Profile As form, in the Name field, provide a unique label, and then click Create and open.
    For example: The following figure shows a sample new label for a token profile:
    Copying a token profie
    A token profile Save As form with a new label provided
    Note: Make note of the token profile name as this name is required during preparing identity mapping.
  6. In the form header, in the RS section, click Edit, and then, in the text field, provide the ruleset to associate with your application.
  7. In the Claims mapping section, click Add a row.
  8. In the Claim name field, enter sub, and then, in the Property field, enter pxRequestor.pyUserIdentifier.
  9. In the Claims mapping section, click Add a row.
  10. In the Claim name field, enter exp, and then, in the Property field, enter OperatorID.pyExpirationDate.
    Result: The following figure shows a correct configuration of the claims mapping:
    Claims mapping for the producer system
    The Claim mappings section of the Token Profile rule form configured for the producer system
  11. Click Save.

Preparing identity mapping for remote case types

After you prepare the client registration and token profile for your producer system, prepare identity mapping to ensure that Pega server correctly identifies operators in your application. You also define how to map the user identity information for use in the Pega application.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Security category, and then click Identity Mapping.
  3. In the list of instances, open the Remotecasetype_Producer identity mapping.
  4. In the form header, click SaveSave as.
  5. On the Save Identity Mapping As form, in the Name field, enter a unique label, and then click Create and open.
  6. In the form header, in the RS section, click Edit, and then, in the text field, provide the ruleset to associate with the identity mapping.
  7. In the Token validation section, in the Token processing profile field, enter the name of the token profile that you created for the producer system, as in the following example:
    For example:
    Token profile for identity mapping
    An identity mapping rule form with a provided token profile of a producer system
  8. Click Save.

Mapping the truststore to the token profile for remote case types

After you prepare the identity mapping, map the token profile to the truststore to ensure a secure encryption of data between your producer and consumer systems.

Before you begin: Create a truststore with a reference to a URL that is the JSON web key set URI from the Remotecasetype_Consumer token profile, as in the following example:
Creating a truststore with the URL from a token profile
Creating a truststore rule form with a URL as reference and the URL from the consumer system provided
For more information, see Creating a keystore for application data encryption and Configuring a consumer system for remote case types.
  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Security category, and then click Token Profile.
  3. In the list of instances, open the token profile that you created for your producer system.
  4. In the Security section, in the Truststore field, enter the truststore that you created for the producer system.
  5. Click Save.

Mapping the identity mapping to the client registration for remote case types

Ensure that the producer and consumer system can communicate correctly and securely by mapping the identity mapping to the client registration that you created for the producer system.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Security category, and then click OAuth 2.0 Client Registration.
  3. In the list of instances, open the OAuth 2.0 client registration that you created for the producer system.
  4. In the Supported grant types section, in the Identity mapping field, enter the identity mapping that you created for the producer system.
  5. Click Save.
What to do next: Configure the system that you want to use to receive remote case types as a consumer. For more information, see Configuring a consumer system for remote case types.
    • Previous topic Establishing trust between applications for remote case types
    • Next topic Configuring a consumer system for remote case types

    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.

    Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

    Close Deprecation Notice
    Contact us