Configuring the Mashup channel

You can configure the Mashup channel in your application to embed Pega Platform content in an external application, for example, to create new work for a case type or to display a harness. Mashup code is generated as HTML that you can copy, paste, and view within a page or view of an external application.

You can also quickly test how the generated mashup code looks in a test demo mobile app. To view your mashup, you must download the Pega Mashup Preview mobile app from the Apple App Store or Google Play, and scan a QR code by using the app.

  1. In Dev Studio, click the name of your application, and then click Channels and interfaces.
  2. In the Create new channel interface section, click Mashup.
  3. In the Name field, enter a name for the Mashup channel interface.
  4. Optional: To distinguish this channel interface from other channel interfaces that use the Mashup channel, enter short text in the Description field that describes the purpose of the channel interface.
  5. Enter the Pega Platform URL and specify whether it is encrypted in the mashup.
    1. In the URL field, enter the URL for a Pega Platform instance, for example:
    2. To generate the mashup snippet with URL encryption, select the Encrypt check box.
  6. In the Action list, click a Pega Platform action, for example: Create new work.
    Depending on the selected action, you might have to specify additional information. For example, for the Create new work action, you must specify the case type.
  7. Enter additional configuration and action parameters.
    1. In the Thread name field, enter the name of the thread that handles the mashup.
    2. In the Resize type list, select the resize mode for the mashup gadget.
    3. Optional: To load the mashup gadget after the rest of the page, select the Is defer loaded check box.
    4. Optional: In the Skin name field, press the Down Arrow key and select a skin name to use for the selected action.
    5. Optional: To supply an action parameter, in the Action parameters section, click the Add a row icon and enter a parameter name and value.
  8. Optional: Test your cases for the Pega Platform application in a demo mashup mobile app.
    1. Click Try Mobile Mashup.
    2. Download and install the Pega Mashup Preview mobile app from the Apple App Store or Google Play.
    3. Open the mobile app and scan the displayed QR code.
      You can also enter the URL for the Pega Platform application from step 5 and enter the credentials manually.
    4. Click the Mashups tab.
    5. If you selected Create new work in step 6, click the case name that you specified to verify that you can create new work, and check the branding for the app.
  9. Click Generate.
  10. Copy the generated HTML code from the Mashup code text area, for example, click Copy to clipboard.
    You can then paste the HTML into a web page or a view of an external application.
  11. Click Save.