Skip to main content


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

Using virtual reports in Activities

Updated on July 8, 2022
Applicable to deployments with Search and Reporting Service and embedded Elasticsearch.

Load the specific report definition into the Clipboard, and modify the virtual instance of that report to maintain the original report unaffected. For example, use an Activity that leverages a report about sales, and then add a specific filter that applies only to the particular client to create a unique virtual report.

The original report that you load into the Clipboard becomes clipboard page, and a template for your virtual report. You modify the clipboard page that contains the data from the template.
  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Technical category, and then click Activity.
  3. In the list of activities, select the activity in which you want to use virtual report.
  4. In the activity rule form, on the Pages & Classes tab, specify the clipboard page name and the class that stores the report definition that you want to use as a template.
    For example: In the Page name field enter VirtualReport, and in the Class field, enter Rule-Obj-Report-Definition.
  5. In the activity rule form, on the Steps tab, select the step after which you want to run the report definition, and then click Add a step.
  6. Load the report definition that serves as a template:
    1. In the Method field, specify the method or rule that runs the report.
      For example: Enter Obj-Open.
    2. In the Step page field, enter the name of the clipboard page that you specify in 4.
  7. Modify the report definition to use it as a virtual report:
    1. In the lower-left corner of your activity rule form, click Add a step.
    2. In the Method field, enter the method name that you want to use to modify the report.
      For example: Enter Java to modify the report by using the Java code.
    3. Click the Expand method parameters button, and then, in the Method Parameters box, update the report.
  8. Use the pxRetrieveSearchData activity to run the virtual report that you modify:
    1. In the lower-left corner of the rule form, click Add a step.
    2. In the Method field, call the pxRetrieveSearchData activity by entering Call Rule-Obj-Report-Definition.pxRetrieveSearchData.
    3. Click the Expand method parameters button, and then, in the Method Parameters section, provide details of the report definition that you use as the template for the virtual report.
      For example:

      In the pyReportClassName field, enter the class name of the report that you modify.

      In the pyReportName field, enter the name of the report that you modify.

      In the pyReportPageName field, enter the clipboard page name that you specify in 4.

  9. In the upper-right corner of the rule form, click Save.

Tags

Pega Platform 8.7 System Administration

Have a question? Get answers now.

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

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us