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.

Configuring and publishing Federated Case Management Repository data in FCM 7.1.2

Updated on September 10, 2021
Note: Starting with Pega Platform™ version 8.6, Federated Case Management and its features, such as configuring remote case types in Dev Studio, is deprecated. To continue sharing work between applications, switch to App Studio and create low-code and user-friendly remote case types. For more information, see Remote case types.

Federated Case Management (FCM) enables you to integrate multiple Pega Platform applications. Users in a federation (a group of applications connected by FCM) can work on cases in any application within a federation without performing multiple logins or opening multiple browser windows. The appropriate data is automatically shared across the applications in a federation, and consolidated views of work and assignments are visible within any application in the federation.

Each local application processes and maintains its own cases and data, and publishes data to a centralized database, the Federated Case Management Repository (FCMR). You can customize the set of properties published to the FCMR as well as the process of publishing data to the FCMR. You also can configure publishing case data to the FCMR on a real-time basis, or on a schedule that you set. In addition, you can enable, disable, and configure publishing to the FCMR for each case type independently.

You might want to configure and publish data to an FCMR in the following scenarios:

  • You need to access and perform actions on remote work objects from the central or master system.
  • You need to create a new work object in the remote system from the central or master system.
  • You need to get the most urgent work across multiple remote systems.

Configuring and publishing FCMR data

Before you publish case data to the FCMR, identify all the Pega Platform applications that you want to include in the federation.

To configure the FCMR and publish case data to it:

  1. Ensure that all Pega Platform instances in the federation are installed and running.
  2. Specify a unique system name for all systems within the federation. When you open a work object from the federated case list, you need to know the system where the work object resides. For example, both PMF and PQD use the system name to open a work object.
    If there is only one system in the federation or all applications are in the same system, you only need to configure the Authentication/RedirectGuests system setting in substep 2d. You can skip the other substeps.
    1. Create or edit a Data-Admin-System instance to generate a unique system name for each system in the federation.
    2. Create copies of all requestor types (App, Batch, Browser, and Portal) for the new system name, which you can find in the SysAdmin category.
    3. Change the Dynamic System Setting prconfig/identification/systemname/default to the unique system name that you created in step 2a.
    4. Create a Dynamic System Setting named prconfig/authentication/redirectguests/default with the value set to false, and restart the system. This starts the Pega Platform node with the given system name.

      To verify whether this step was successful, check the value of the pxSystemName property on your pxProcess clipboard page. The clipboard page should show the configured system name.

  3. Create a business scenario.
    1. Create the same operator across all systems in the federation.
    2. Create an application in each of the Pega Platform systems.
  4. Create a central FCMR database.
    Data that is published from all systems in the federation is pushed to this database.
  5. Create a Data-Admin-DB-Name instance with the name FCMR in all systems that points to the new FCMR database.
  6. Import the pzFCMR_7_1_2.jar file to all systems. This Rule Admin Pro (RAP) contains the Pega-FCM related assets, and you can find it with the FCM distribution media. Importing the RAP ensures that database tables are created automatically in the FCMR database.
  7. Include the Pega-FCM ruleset in the application stack in all systems, and then log in again.
  8. Select the Publish work remotely check box in the Application rule for cases that are allowed to publish data to the FCMR. Repeat this in all the systems in the federation.
  9. Publish administrative data for each system in the federation, following these steps:
    1. Access the Federated Case Management landing page by clicking Dev Studio > System > Settings > Federated Case Management.
    2. From the Data type menu, select Administrative.
    3. Click Publish.


After you complete these steps, all applications start pushing data to the FCMR database.

Use the Federated Case Management landing page to bulk publish existing case and administrative data from an application joining a federation.

Federated worklists and case lists

You can use the following two gadgets, which are included in the Pega-FCM ruleset, to view and access data in the FCMR database:

  • pyFCMRFederatedCaseList7 – The federated case list gadget provides case managers with access to all cases in a federation, including those currently assigned or resolved, and so on. The case list is filtered and sorted by customer, product, location, or other criteria that you define.
  • pyFCMRFederatedWorkList7 – The federated worklist gadget presents users with a merged list of assignments from all their applications. The local application processes and maintains its own cases and data, and publishes data to the FCMR database.

For the federated worklist and case list, you can modify the views to include different data, filtering, and sorting criteria.

Pega Web Mashup gateway

FCM uses the Pega Web Mashup gateway to create and open remote cases. You need to configure the Pega Web Mashup gateway on all the systems that attempt to access remote cases. For configuration information, see Configuring Pega Web Mashup with the Gateway Configuration Console. Ensure that the host name in the host configuration is the same as the system name (which is case sensitive) for each system covered in step 2.

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