Skip to main content

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

Creating cases from a web mashup

Updated on May 11, 2022
Applicable to Theme UI-Kit and Theme Cosmos applications

Manage the business processes of users who use external software by embedding a case into their external web page in the form of a web mashup. For example, you can embed a case type for job application processing on a web page that displays job offers.

By generating mashup code in HTML and inserting it into an external web page or application, you enable users to interact with Pega features and create cases without having access to Pega Platform software. For more information, see Pega web mashups for embedding Pega Platform UI in external web pages.
Note: Web embeds replace web mashups in Cosmos React applications. For more information, see Creating web embed and Embedding Pega Platform UI in web pages.
Before you begin:
  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 that you want to use to create case types.
  4. Optional: To distinguish this channel interface from other Mashup channel interfaces, in the Description field, specify the purpose of this channel interface.
    For example: Enter Case type for processing job applications.
  5. In the URL field, enter the URL for your mashup:
    • If you want the user to open the default application for their operator record, use the URL pattern.
    • If you want the user to access a specific application, use the<application alias> URL pattern.
    • If your application uses an authentication service and you want users to open the default application for their Operator ID record, use the<authentication service alias> URL pattern.
    • If your application uses an authentication service and you want users to access a specific application, use the<application alias>/<authentication service alias> URL pattern.
    • Because some users might have access to several applications in their Operator ID record, the best practice is to always use application aliases with mashups. For more information, see Adding an application URL alias.
    • Mashups support all Pega authentication services only when the URL syntax in the data-pega-url attribute is correct. For more information, see Mashup attributes.
  6. Optional: To generate the mashup snippet with URL encryption, turn on the Use encryption switch.
    Note: When the Use encryption switch is on, mashup requests do not support dynamic parameters.
  7. In the Configuration section, in the Action list, select Create a new case.
  8. In the Case type list, select a case type that you want to use.
  9. In the Flow name field, enter the starting process of the case type .
    Note: The starting process applies only to case types without the Create stage. For more information, see The Create stage.
  10. In the Thread name field, enter the name of the thread that handles the mashup.
  11. Optional: To delay the load of the mashup gadget until a future point during page load or as part of a user interaction with the page, turn on the Defer mashup load switch.

    You can then invoke the method to load the mashup at the appropriate time either within the onload event of the host page or after some other event on the page starts.

  12. Optional: To retain the state of the case after users refresh the browser that displays the mashup, turn on the Retain mashup state on browser refresh switch.
    Note: Consider the following limitations when using this option:
    • The option to retain the case state is not backwards compatible by default.
    • The option to retain the case state works only if users load the mashup gadget on the same thread, and the thread is available during a browser refresh. This setting does not work if users set the thread name dynamically while loading the mashup.
    • The state is retained if the reload occurs in the same session.
    • The option to retain the case state does not work for temporary work objects, for which the system does not generate work IDs.
  13. Optional: To validate dynamic parameters in the mashup request, turn on the Allow passing dynamic parameters switch.
  14. Configure the output options for the mashup:
    1. In the Skin list, select the skin rule that you want to use for the mashup.
    2. In the Iframe resizing list, select the resize mode for the mashup.
    3. In the Initial skeleton list, select the skeleton to provide a template for the mashup.
      Note: You can check how the skeleton renders the content by clicking Skeleton preview.
  15. Optional: To add a parameter, such as a parameter for custom authentication, in the Custom parameters section, click the Add a row icon, and then enter a parameter name and value.
  16. 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: The mashup code option also creates an iframe when the mashup loads. Selecting the iframe code improves the response time of a mashup but does not support passing dynamic parameters.
  17. Close the Mashup code window.
  18. Click Save.
  19. Optional: To preview how different devices display the mashup code, in App Studio, click Preview application, and then select the channel that you want to preview by clicking the channel name next to the application name.
What to do next: Paste the HTML code that you copy into a static web page or web view of an external web application to display your embedded case.
Note: To put multiple mashups on a single web page, include the mashup static script pzIncludeMashupScripts in the HTML code only once.

For relevant training materials, see the Pega Web Mashup module and the Creating a Pega Web Mashup mission on Pega Academy.

  • Previous topic Calling an activity or automation from a process
  • Next topic Directed Web Access in configuring assignments for external users

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