Skip to main content

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

Exposing the My cases landing page in other applications as a mashup gadget

Updated on August 26, 2022

Enable users of other applications to view and manage cases in a consolidated list that gathers cases that are associated to specific users without logging in to Pega Process Fabric Hub.

The My cases landing page consolidates cases from your registered applications. You can use the My cases widget as a mashup gadget in another Pega application, a non-Pega application, or an external web page. For more information, see The My Cases landing page to enhance case management.
Note: Pega applications that you build on Cosmos React do not support mashups.

For Cosmos React applications, you can use Pega Digital Experience (DX) API to expose the list in other applications. For more information, see Exposing Interwoven Worklist and My cases data in other applications through DX API.

You can expose the My cases landing page in other applications as a mashup gadget by creating a Pega Web Mashup channel in Pega Process Fabric Hub, and then generating mashup code with the Data-Portal.MyCases harness rule, which renders the My cases landing page.

  1. Create a Pega Web Mashup channel and generate mashup code for the My cases widget in Pega Process Fabric Hub:
    1. In the navigation pane of App Studio, click Channels.
    2. In the Create new channel interface section, click Web mashup.
    3. On the New Web mashup interface form, in the Basic options section, in the Name field, enter a name for the mashup.
    4. Optional: To distinguish this channel interface from other mashup channel interfaces, in the Description field, specify the purpose of this channel interface.
    5. In the URL field, enter the Pega Process Fabric Hub URL by using the following pattern: https://host-name/context-root/servlet-name.
      Note: Because some users might have access to several applications in their operator record, as a best practice, always use a Pega Process Fabric Hub URL alias with mashups. For more information, see Adding an application URL alias.
    6. Optional: To generate the mashup snippet with URL encryption, turn on the Use encryption switch.
      Note: When the Use encryption switch is on, dynamic parameters are not supported.
    7. In the Configuration section, in the Action list, select Display a page.
    8. In the Class field, select the class name of the My cases landing page harness rule.

      The default harness rule class is Data-Portal.

    9. In the Harness field, select harness rule name.

      The default harness rule name is MyCases. If you change the My cases harness rule in the system, select your rule name and class. Otherwise, use the default rule name and class name.

    10. Optional: To use a data transform, in the Data transform field, select a required data transform.
    11. Optional: To block the page from editing, turn on the Read only switch.
    12. In the Thread name field, enter a name for the thread that handles the mashup, for example, MyCasesGadget.
    13. Optional: To defer the load of the mashup gadget, turn on the Defer mashup load switch, and then, in the page script, configure the initiation of the mashup loading process based on your preference.
    14. Optional: To validate a mashup gadget request that has dynamic parameters in the mashup code, turn on the Allow passing dynamic parameters switch.
      Dynamic parameters are any parameters that you enter in the mashup code on the external page. For example, if you have a custom parameter, CustomerID, and you want to pass the value for this parameter, which uses the ID of users who visits the page, you include the parameter on the external page, which makes the parameter dynamic. Static parameters are all the parameters that the system generates with the mashup code.
    15. Configure the output options for the mashup by performing actions in step 13 of Creating a mashup.
      For example, the following figure shows a sample configuration of the output options:
      Sample mashup output configuration
      Sample mashup output configuration with the auto resizing mode.
    16. Optional: To add a custom parameter, in the Custom parameters section, click the Add a row icon, and then enter the parameter name and value.
    17. In the What is a mashup section, click Generate mashup code, and then, in the Mashup code window, select the type of code that you want to copy:
      • To copy the iframe code, above the iframe code window, click Copy.
      • To copy the mashup code, above the Mashup code window, click Copy.
      Note: Selecting the iframe code improves the response time of a mashup but does not support passing dynamic parameters.
    18. Close the Mashup code window.
    19. Click Save.
  2. Configure Pega Process Fabric Hub to allow incoming messages from the host site by performing steps from 21 through 23 in Creating a mashup.
  3. Deploy your mashup by inserting the code in another application or web page:
    Pega application
    1. Create a section. For more information, see Creating sections.
    2. Convert to the full section editor. For more information, see Converting sections to full section editor.
    3. On the HTML tab, unselect the Auto-generated HTML checkbox.
    4. In the HTML Source area, paste the copied mashup code.
    5. On the section rule form, click Save.
    6. Embed the section in another section in which you want to view the My cases gadget. For more information, see Creating an embedded section.
    Non-Pega application or an external web pageEmbed the mashup code on the web page or in the front-end files of your application by following standard development procedures.

    For more information, see Creating a mashup and Pega web mashups for embedding Pega Platform UI in external web pages.

  4. If your Pega application is built on the Theme UI-Kit, you can expose the My cases gadget as a dashboard widget of the Case Manager portal:
    1. On the Settings tab of the new section rule, select the Dashboard widget checkbox.
    2. Configure the Widget title field and Category field.
    3. Optional: To provide a description for the widget, in the Widget description field, enter a description.
    4. Optional: To provide an icon for the widget, next to the Widget icon field, click Show Image Viewer, and then select an image from the image catalog.
    5. In the Case Manger portal, add the widget to the dashboard. For more information, see Adding a widget to your dashboard.
  • Previous topic Exposing Interwoven Worklist in other applications as a mashup gadget
  • Next topic Exposing Interwoven Worklist and My cases data in other applications through DX API

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