Table of Contents

Creating, editing, and viewing reports in Pega Robot Manager 8.4.2

The reporting feature in Pega Robot Manager extends the capabilities offered by Pega Platform, so that you can create, edit, and view reports from applications that include Pega Robot Manager in their application stack. These reports can cover health, exceptions, or usage data collected from Pega Robot Runtime.
One important characteristic of reports in Pega Platform (including Pega Robot Manager), is that the reports are not static documents. Instead, opening a report executes an Elasticsearch query that fetches the current records from the Elasticsearch storage. The Elasticsearch query runs in the background. This can cause an issue with reports that cover an open-ended interval, such as the current month or the last ten days, because the content of the reports updates every time you open it.

Archiving and purging data can affect the content of a report, both for the data from a time interval that is still open, and for data in reports that cover a past period.

Modifications to the default Pega Platform reporting behavior

Installing Pega Robot Manager extends the reporting functionality of Pega Platform to include Health Statistics, Robot Usage Statistics, and Exception Statistics. Robot Usage Statistics categorizes data into different interval groups for performance purposes. You can choose to view hourly, daily, monthly, and yearly usage statistics. When creating reports, you can limit their scope to information that is relevant to department, work group, and specific activities and automations performed by your robots. By default, the reports cover the context of the operator and the current application only.
In Pega Robot Manager, you can archive and purge operational data independently for each table. However, purging and archiving data are limited to the current application only.

 

Setting up Pega Platform to use reports in Pega Robot Manager

Reporting in Pega Robot Manager uses Elasticsearch for faster processing of reports. To further improve the process, you set a dedicated Search node for quicker indexing of records from Pega database to the Elasticsearch data store.

 

Pega Robot Runtime 19.1.23 or later is required for reporting.
  1. Log in to Dev Studio as Application Administrator.

  2. Verify that at least one of the active nodes has a node type which contains Search or is set to Universal. For more information about nodes, see Assigning node types to nodes for on-premises environments.

  3. In the navigation panel of Dev Studio, click Records > SysAdmin > Dynamic System Settings and confirm the values of the following Data Admin System settings:

    • indexing/useDataInstances row (owning ruleset: Pega-SearchEngine) – true.
    • reporting/searchdata/enabled (owning ruleset: Pega-Reporting) – true.
    • pegarobotics/defaultTimezoneForRMReporting (owning ruleset: Pega-Robotic-AutomationPackageManagement) – GMT.
      The defaultTimezoneForRMReporting setting provides the preferred timezone for the Collection Interval column of daily, monthly, and yearly usage reports. Hourly reports use the time zone defined on the requestor's Operator ID record. Do not modify this setting to avoid discrepancies between the hourly reports and the daily, monthly, or yearly reports.
  4. In the navigation panel of Dev Studio, click Records > SysAdmin > Queue Processor, and confirm the values of the following queue processors:

    • pyBatchIndexClassesProcessor – the Enable Queue Processor switch is turned on.

    • pyBatchIndexProcessor – the Enable Queue Processor switch is turned on.

  5. In the Instances of Queue Processors list, select the pyProcessOperationalStatistics queue processor and perform the following actions:

    1. Confirm that the following message is displayed at the top of the screen: All queue processors are rule resolved against the context specified in the System Runtime Context. Otherwise, perform the following steps:

      1. Click System Runtime Cotext.
      2. In the Applications section, click Add application.
      3. In the Name field, enter PegaRobotManager.
      4. In the Version field, enter 8.
      5. Click Save.
      6. Wait for the system to refresh.
    2. Configure the Associated with node type and Number of threads per node fields according to the expected load. 

  6. At the top of the screen, on the toolbar, click Configure > System > Settings > Search

  7. Click Dedicated.

  8. Under the Status column, ensure that the status of all dedicated indexes for Usage statistics is AVAILABLE.

Enabling reporting on Pega Robot Manager

For more information about enabling the reporting feature on Pega Robot Manager, see Enabling reporting on Pega Robot Manager.

Reporting user roles

Starting from Pega Robot Manger 8.4.1, you can add three different roles: ReportAdmin, ReportWriter, and ReportUser. The Administrator role includes the ReportAdmin role by default.

For more information about user roles, see User roles

Out-of-the-box reports

By default, out-of-the-box reports display in all applications built on Robot Manager. Report titles and visibility are editable for ReportWriter, but only ReportAdmin can delete reports.

 

Disabling the ingest data for reporting across different aggregation tables

By default, usage intervals collection settings are inherited from the built-on (parent) application. If the built-on application also inherits the settings from its parent application, the application stack follows until the dependency resolves. If no application contains its own instance of the settings, the Pega Robot Manager uses default settings. The Pega Robot Manager always collects the data half-hourly, but you can determine how the data is aggregated and stored. You can choose to ingest data into the hour, daily, monthly and yearly tables. You choose which table to source your data when creating reports.

  1. In Pega Robot Manager, log in to your application with Report Admin privileges.
  2. From the Pega Robot Manager dashboard, choose Settings.
  3. Click Reporting.
  4. Click More > Copy settings.
  5. In the Copy settings for reporting dialog box, set the data aggregation details:
    a) In the Select an application to copy from list, select an application from which to copy the settings.
    b) Select check boxes with intervals.
    c) Click Submit.
    The Inherited from column of the applied intervals displays the Current application status.
  6. Optional: To remove a usage interval, click the Remove from current application icon.

Creating custom reports

You can create reports that include data that is related to applications that include Pega Robot Manager in their application stack.

  1. In Pega Robot Manager, log in to your application with Admin, Report Writer, or Report Admin privileges.
  2. From the Pega Robot Manager dashboard, choose Reports.
  3. In the top-right corner of the screen, click New report.
    The Create new report modal dialog box appears.
  4. In the Report on list, select the report statistics type:
    • ​​​To retrieve information about robotic sessions, Robot Runtime and the package versions loaded, select Health Statistics
    • To retrieve information about fatal exceptions such as stack traces, select Exception Statistics.
    • To retrieve information about automations and activities (which includes robot activities and public automations), select Robot Usage Statistics.
  5. ​​​​​If you select Robot Usage Statisticsin the Usage data aggregated section, choose a data aggregation option.
  6. Optional: If you want the viewers of your report to see information relevant to their department only, select the Apply department scoping check box.
    Each robot is assigned to a work group and a department. By selecting this option, you exclude from the report all the data that is not applicable to the department to which the robot is assigned.
  7. In the Report type list, select a report type to create.
  8. Click Submit.
  9. In the upper-right corner, click Done editing.
  10. In the Save report as modal dialog box, enter the report details:
    a) In the Title field, enter the report title.
    b) In the Description field, enter the report description.
    c) In the Category list, select the report category.
    d) Click Submit.

Renaming report columns

You can set meaningful names for columns when creating reports in Pega Robot Manager.

  1. In Pega Robot Manager, log in to your application with ReportAdmin or ReportWriter privileges.
  2. Access a report, and then click Edit report.
  3. Hover over the column, and then click the Open Menu icon.
  4. In the list of options that appears, select Heading.
  5. In the Column heading field, enter a name for the column.
  6. Click Apply changes.

Replacing IDs with labels in reports

Some data in reports use IDs. When editing a report, you can use formatting options to replace IDs with labels in the following columns: Organization ID, Division ID, Unit ID, User ID, and Workgroup ID.

  1. In Pega Robot Manager, log in to your application with ReportAdmin or ReportWriter privileges.
  2. Access your report, and then click Edit report.
  3. Next to the column header, click the Open Menu icon.
  4. If the report does not include the column for which you want to change the ID, drag the column from the Data Explorer section into the report.
  5. In the list of options, select Format.
  6. In the Format values field, enter the appropriate value:
    a) To replace the ID with the name of the Organization ID column, enter pxOrganizationName.
    b) To replace the ID with the name of the Division ID column, enter pxDivisionName.
    c) To replace the ID with the name of the Unit ID column, enter pxUnitName.
    d) To replace the ID with the name
    of the User ID column, enter pxUserName.
    e) 
    To replace the ID with the name of the Workgroup ID column, enter pxWorkgroupName.
    f)  To replace the ID with the combined name of the Organization, Division, and Unit ID columns, enter pxOrgDivUnitName.
    g) To get the name of the unit from the combined name of the Organization, Division, and Unit ID columns, enter pxUnitNameFromOrgDivUnit.
  7. Click Apply changes.
  8. Click Done editing.

Adjusting time periods

You can set the time periods with which to calculate the values for the duration fields.

  1. In Pega Robot Manager, log in to your application with ReportAdmin or ReportWriter privileges.
  2. Access your report, and then click Edit report.
  3. Hover over the duration column, and then click the Open Menu icon.
  4. In the list of options, select Format.
  5. In the Format values field, enter Duration, and choose one of the options.
  6. Click Apply changes.
    The selected column displays the calculated time period.

Viewing reports

Viewing reports requires ReportAdmin, ReportUser or ReportWriter privileges. For more information about viewing reports, see Running reports.

Exporting reports 

You can export reports from Pega Robot Manager and save them on your computer as PDF or Microsoft Excel files.

  1. In Pega Robot Manager, log in to your application with ReportAdmin, ReportUser or ReportWriter privileges.
  2. From the Pega Robot Manager dashboard, choose Reports.
  3. Select the report that you want to export.
  4. Click Actions, and select one of the export options.

The system exports the selected file.

Deleting reports

You can delete reports in Pega Robot Manager that you do not need anymore. 

  1. In Pega Robot Manager, log in to your application with ReportAdmin or ReportWriter privileges.
  2. From the Pega Robot Manager dashboard, choose Reports.
  3. Select a view of the reports that you want to consider for deletion:
    a) To view your reports only, click the My Reports tab.
    b) To view all available reports, click the All reports tab.
  4. Right-click a report and click Delete.
  5. In the Delete report modal dialog box that appears, confirm the report deletion by clicking Submit.

Changing report category

You can change report category to Public or Private any time. Organizing reports into different categories based on the purpose facilitates navigation to the reports.

  1. In Pega Robot Manager, log in to your application with ReportAdmin or ReportWriter privileges.
  2. From the Pega Robot Manager dashboard, choose Reports.
  3. Change the report category:
    Choices Actions
    Change the category from private to public

    a) On the My Reports tab, click the report.

    b) Click Actions > Save as.

    c) In the Save report as modal dialog box, enter a title and description.

    d) In the Category list, select one of the Public report categories.

    e) Click Submit.

    Your private report saves as a new file and becomes available for other workers.

    Change the category from public to private

    a) Click the All reports tab.

    b) Select a Public report.

    c) Click Actions > Save as.

    d) In the Save report as modal dialog box, enter a title and description.

    e) In the Category list, in the Private section, select My Reports. Click Submit.

    Your private report saves as a new file and is visible only to you.

    Move a public report to a different category of public reports

    a) Click the All reports tab.

    b) Next to the report, click the Actions icon, and then click Move.

    c) In the Move report modal dialog box, in the Report category list, select a Public category to which you want to move your report.

    d) Click Submit.

    Your public report moves to the selected category.

Using report tiles

The main screen of Pega Robot Manager displays recently opened reports that you can manage, in the form of tiles. Depending on your user privileges, you can perform different actions on the reports.
For more information about user privileges, see User roles.

  1. In Pega Robot Manager, log in to your application.
  2. From the Pega Robot Manager dashboard, choose Reports.
  3. Hover over the report, and click the Actions icon.
  4. Select the action that you want to perform:
    Choices Actions
    Open the report Click Open.
    Edit the report details

    a) Click Edit.

    b) If you want to edit the report title, in the Report title field, enter a new title.

    c) If you want to edit the report description, in the Report description field, enter a new description.

    d) Click Submit.

    Move the report to a different category

    a) Click Move.

    b) In the Report category list, select the category to which you want to move the report.

    c) Click Submit.

    Copy the report shortcut

    a) Click Copy.

    b) If you want to edit the report title, in the Report title field, enter a new title.

    c) If you want to edit the report description, in the Report description field, enter a new description.

    d) In the Category type list, set the report to public or private.

    e) In the Report category list, select the report category.

    f) Click Submit.

    Remove a tile from the list Click Remove.
    Delete a report

    a) Click Delete.

    b) Click Submit.

    Schedule a report run

    a) Click Schedule.

    b) Under the Task Scheduling section, schedule a run, and click Submit.

     

Archiving operational data

You can use Pega Robot Manager to archive the data of the currently viewed application, and make it available in the archive tables. The archived data is not available for reporting.

  1. In Pega Robot Manager, log in to your application with ReportAdmin privileges.
  2. From the Pega Robot Manager dashboard, choose Settings.
  3. Click Reporting.
  4. Click More > Archive data.
  5. In the Archive data modal dialog box that appears, select an entity type that you want to archive, and then click Next.
  6. Select date range to archive, and then click Next.
  7. Click Submit.

Purging operational data

You can use Pega Robot Manager to purge data from the currently viewed application. Purging removes data permanently.

  1. In Pega Robot Manager, log in to your application with ReportAdmin privileges.
  2. From the Pega Robot Manager dashboard, choose Settings.
  3. Click Reporting.
  4. Click More > Purge data.
  5. In the Purge data modal dialog box that appears, select an entity type that you want to purge, and then click Next.
  6. Select date range to purge, and then click Next.
  7. Click Submit.
Suggest Edit

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.