Skip to main content

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

Enabling the collection of Pega Robot Runtime data for reporting

Updated on December 20, 2022

Collect health and usage statistics for Pega Robot Runtime to create meaningful reports that help you understand the performance of your robotic workforce.

The reporting feature in Pega Robot Manager extends Pega Platform capabilities to enable creating, editing, and viewing reports from applications that include Pega Robot Manager in their application stack.
Before you begin: Ensure that a RuntimeConfig.xml version other than the Master file is available. Otherwise, create a new version. For more information, see Creating Runtime configuration files.
  1. In the navigation pane of Pega Robot Manager, click SettingsRuntime configs.
  2. On the Runtime configs tab, click the RuntimeConfig.xml version that you want to edit.
  3. On the Settings tab for the selected version, click Edit to open the XML editor.
  4. In the XML editor, set the PublishToRobotManager enabled attribute to true.
  5. Customize data collection according to your business needs by configuring any of the following attributes:
    • HealthStatistics enabled – Indicates whether to collect health statistics, including login information, the Pega Robot Runtime version, the package name and version, and any fatal exceptions.
    • UsageStatistics enabled – Indicates whether to collect the automation and activity usage statistics.
    • publishInterval – Indicate how often (in minutes) Pega Robot Runtime publishes the health and usage statistics data to Pega Robot Manager.
    • ssoUserIdRule – Required for SSO authentication only. Specify how Pega Robot Runtime forms the UPN for the Pega Security Token Service (STS) server. You can set this attribute to the following values:FullUPN – Format the user ID as [email protected]. This is the default value.PartialUPN – Format the user ID as username@support.Username – Format the user ID as username.
      Note: By setting this attribute, you ensure that the user identifiers in Pega Robot Manager match the identifiers that Pega Robot Runtime sends in the operational data payload.
    For example:
    <PublishToRobotManager enabled="true" ssoUserIdRule="FullUPN">
    		<HealthStatistics enabled="true" />
    		<UsageStatistics enabled="true" publishInterval="60" />
    		<RobotActivityLog enabled = "false" eventsToLog = "1"/>
  6. Enable the OpenSpan.Events.OperationalEvents.OperationalEventConsumer by setting the consumer enabled attribute to true.
    For example:
    <consumer enabled="true" assembly="OpenSpan.Events" type="OpenSpan.Events.OperationalEvents.OperationalEventConsumer" 
    sendFailuresBeforeWaiting="3" waitForRetryTime="60000" eventSources="Operational">
  7. Click Save to confirm your settings.
  8. In the Save changes modal dialog box, describe the change, and then click Submit.
  9. In the Assigned to section, ensure that this file is assigned to a user, department, work group, or a robot operator whose data you want to report on. Otherwise, perform the following actions to assign the RuntimeConfig.xml file:
    Note: The entity assignments take precedence over any application-default settings.
    1. Click Assign new.
    2. In the Assign new modal dialog box, select the entity to which you want to assign the file.
    3. Click Submit.

The following example shows that data collection is enabled and customized on Pega Robot Runtime, and that the file is assigned to the correct entities:

Enabling data collection on Pega Robot Runtime
Configuring the RuntimeConfig.xml file in Pega Robot Manager to enable data collection for reporting on Pega Robot Runtime
    • Previous topic Setting up Pega Platform to use reports in Pega Robot Manager
    • Next topic Modifying data aggregation intervals for reporting

    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