Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Using a robotic automation as a source for a data page

Updated on May 4, 2020
Note: This content mentions Pega Express, which formerly referred to App Studio. Pega Express now unifies our low-code experience strategy with our delivery methods. You can find the Pega Express delivery methodology here.

Robotic process automations (RPAs) are automations that run in the back office. You can use a robotic process automation (RPA) as a source for a data page by using Pega® 7.4 with Pega Robot Manager 5. For example, you can use an RPA to obtain a credit score from a legacy system that you can then display on a Pega Customer Service application account overview dashboard.

Note: This article applies to Pega 8.2.x and below. For all other Pega versions, refer to developer help.

Robot Manager is required for using an RPA to source a data page. Use Pega Exchange to determine which version of Robot Manager is compatible with your Pega Platform version, then download it from Pega Exchange.

At run time, the data page invokes a REST endpoint that is hosted in Robot Manager. Using the data input from the data page, Robot Manager queues a request to be executed by an RPA robot. The RPA robot returns the result to Robot Manager, which in turn passes the result to the data page as a REST response. The run-time architecture is shown in the following diagram.

Runtime architectureRun-time architecture

Automation status and error handling

Robot Manager enforces two levels of validation and error handling to ensure that the RPA robot returns valid data. When an RPA robot completes an automation, it returns a status message to Robot Manager that summarizes the success or failure of the recently executed automation. The status message contains one of the following values: Completed, Completed with errors, or Did not complete.

When Robot Manager receives an automation status of "Completed with errors" or "Did not complete", the assignment is treated as a failed automation. The original assignment is completed, and a new assignment is opened and routed to the Failed Robot Automations workbasket. The Failed Robot Automations workbasket can be changed to suit your business needs. Because the original assignment is considered complete, any data returned by the robot is also returned to the data page. For this reason, map the pyAutomationStatus property to the data page so that you are aware of the automation status.

If the robot returns data to Robot Manager that violates the validation criteria specified on the original assignment, the original assignment remains open, and Robot Manager returns an HTTP response code of 500 that indicates that the data cannot be populated on the data page.

Configuring an RPA as a data page source

The high-level tasks for using an RPA as a data page source are as follows:

  1. In Pega Express or Designer Studio, build a simple case type to model the overall robotic automation. Include the input fields that you want to pass to the RPA robot in the case data model, for example, customer ID, mailing address, or account number. In addition, include the output data fields that you want the robot to pass back to your Pega application, for example, credit score, account balance, or claim number.
  2. In Pega Express or Designer Studio, build a simple case life cycle. The case life cycle must include the Route to robot smart shape. The smart shape queues the automation request to the RPA robot. This is the case that will be referenced on the data page. (Link to help for RPA smart shape).
  3. In Pega Robotic Automation Studio, build the automation logic for the robot to execute. Once your automation is completed, reference the robot activity name in the Queue for robot smart shape.
  4. Configure the location of the Robot Manager host server and the authentication profile to use when connecting to it.
  5. Configure the data page.

Configuring the Robot Manager host server and authentication profile

Configure the location of the Robot Manager host server and the authentication profile to use when connecting to it in the application that uses the data page.

  1. From the Records explorer, click SysAdmin > Dynamic System Settings.
  2. Search for the pegarobotics/RoboticAutomationRequestorProfile setting.
  3. In the Value field, enter the name of the authentication profile that the REST connector will use to connect to the REST service.
  4. Click Save.
  5. Search for the pegarobotics/RobotManagerHostDomain setting.
  6. In the Value field, enter the domain details and the HTTP scheme of the Robot Manager host server, for example, https://localhost:8443.

    For Pega 8.1.6 and 8.2.2 and later, enter the HTTP scheme including prweb, if applicable, for example, https://localhost:8443/prweb.

  7. Click Save.


Configuring the data page

When your automation is built and your case type is configured, you can configure the data page.

  1. From the Data Type Explorer, expand the data type, and click the data page that you want to source with an RPA.
  2. In the Source field, click Robotic automation.
  3. In the Robotic automation field, enter the name of the case type that you created.
  4. In the Timeout(s) field, enter the length of time that the data page will wait for data to be returned before timing out.
  5. In the Request Data Transform field, enter the request data transform to use to provide input data to the robot.
  6. In the Response Data Transform field, enter the response data transform to use to convert the results returned from the robot to the logical model used by the data page.
If you want to know the status of the automation to determine what action to take, configure your response data transform to read the pyAutomationStatus property. The status can be Completed, Completed with errors, or Did not complete.


The following example shows the case type data model, data page, request data transform, and response data transform for a data page that is sourced by an RPA that gets a customer's credit score. The data model for the Get credit score case type has two fields, Account idand Credit score. This information is used to configure the data transforms.

Case type data modelCase type data model

The following screen shows the data page configuration.

Data page configurationData page configuration

The request data transform passes in the customer ID and puts it into the Account idfield that is defined in the case type.

Request data transformRequest data transform

The response data transform takes the credit score from the physical data model and puts it into the CustomerCreditScorefield in the logical data model.

Response data transformResponse data transform

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