Skip to main content

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

Best practices and prerequisites for Blue Prism integration

Updated on November 23, 2022

Learn about the best practices and prerequisites for integrating Blue Prism with your Pega Platform application. For your application to call Blue Prism and for Blue Prism to call back with the results, you must define the required processes and infrastructure in your Blue Prism Control Room.

Blue Prism processes

  • Pega Platform supports only Blue Prism processes. To handle the request and response between Blue Prism and your application, Pega Platform recommends that you define two processes. The current implementation follows the Blue Prism main and liaison processes pattern. For more information, see the Recommended Approach section of your Blue Prism developer documentation.

    The pattern consists of the following:

    • Queuing process: The queuing process queues the request from Pega Platform to a Blue Prism work queue and returns the queue item ID of the request to Pega Platform. At a predefined interval, a Blue Prism job scheduler pulls the item from the Blue Prism work queue and processes it.
    • Queued process: After the queuing process is complete, the queued process executes the automation and calls Pega Platform back with the results of the request, the status, and the queue item ID. The queued process returns the results by using the REST service that Pega Platform exposes. Pega Platform uses the queue item ID to map the response data to a case. For more information, see the Service configuration section of this document.

    These processes ensure that Blue Prism handles your requests asynchronously and updates Pega Platform later with your results.


    Make sure that you expose the queuing process so that Pega Platform can call it. Pega Platform supports document/literal encoding. For more information, see your Blue Prism developer documentation.

Service configuration

  • Pega Platform exposes a REST service that Blue Prism uses to call Pega Platform back with the results of the request. To call the Pega Platform service, enter the following URL in your queued process:


  • The payload that the queued process returns to Pega Platform should include the item ID and status in the following format:

    {itemId: “<the item id of the process>”, “status”: “<Completed> or <Did not complete>”, <rest of the outputs that are defined in the Blue Prism process>}

    To map the processes in your application, Pega Platform expects all of the outputs as well as the fields specified in the payload.

    Note: You must convert the data that the queued process returns to Pega Platform into JSON format.

For more information, see your Blue Prism developer documentation.

Data types

  • The current Pega Open Robotics integration for Blue Prism only supports simple data types.

    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