Skip to main content

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

Blue Prism integration

Updated on April 6, 2022

You can integrate Pega Platform with an existing Blue Prism robotic automation system. This compatibility supports maximum efficiency and reduces implementation costs because you do not need to redo your current robotic automation solution while transitioning to the Pega-based application.

The following diagram demonstrates how Pega Platform integrates with Blue Prism to complete robotic assignments:

Blue Prism integration with Pega Platform
A diagram that shows how Blue Prism integrates with Pega Platform to complete robotic assignments.

Pega Platform integration stage

Pega Platform uses a dedicated landing page to connect to the Blue Prism process inventory. The inventory contains exposed processes (automations) that you can use in your application. You must synchronize your application with the process inventory every time you update the list of exposed processes in Blue Prism.

Note: Pega Platform supports Blue Prism processes with enforced document or literal encoding only.

See the following figure for a synchronization example:

Blue Prism service configuration
The Blue Prism landing page where you can configure the connection details and synchronize with the Blue Prism process inventory.
For more information, see Configuring the connection between Blue Prism and Pega Platform.

After you synchronize with the Blue Prism process inventory, case developers can select which Blue Prism process to run in the Assign to Robot queue smart shape while defining steps and stages in a case, as shown in the following example:

Selecting a Blue Prism process to run as part of a case
Configuring steps and stages in a case by adding an Assign to robot queue step and selecting a Blue Prism process to run.
For more information, see Integrating Open Robotics with case types in Dev Studio.

Blue Prism integration stage

To successfully process a robotic assignment from Pega Platform, your Blue Prism implementation must consist of a queuing process and a queued process.

When your application requests an automation from Blue Prism, the queuing process places that automation in a work queue and returns the assigned Blue Prism queue item ID to your application. After the queuing process is complete, the queued process runs the automation and responds to Pega Platform by using a REST service call. The response contains the automation results, and the queue item ID. Pega Platform uses the queue item ID to map the response data to a request and enable case progression.

To enable processing of the response data in Pega Platform, the queued process must meet the following criteria:

  • The process must contain a step to call the Pega Platform REST service through the http://host/prweb/api/OpenRoboticsBluePrism/v1/callback URL pattern.
  • The process must return data to Pega Platform in the JSON format.
  • The response payload must have the following structure:
    {itemId: “<the item id of the process>”,
        “status”: “<Completed> or <Did not complete>”,  
         <other outputs that are defined in the Blue Prism process>}

For more information, see the Blue Prism developer documentation.

To facilitate processing Blue Prism responses, Pega Open Robotics provides the callback REST endpoint out of the box, as shown in the following example:

Pega Open Robotics REST service configuration for processing Blue Prism responses
The configuration page for the REST service that Pega Open Robotics provides for processing Blue Prism responses. The page shows the callback endpoint URL.

  • Previous topic Customizing how UiPath Orchestrator authenticates calls from Pega Platform
  • Next topic Configuring the connection between Blue Prism and Pega Platform

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