Creating advanced reports
Facilitate the process of data analysis by presenting the data that you retrieve from the database in the form of a table.
In Pega Platform, you can create advanced reports by managing report definition rules that use a variety of features to organize data in tables. The report definition rules generate an SQL query that retrieves and sorts information from the PegaRULES database, an external database, or an Elasticsearch index.- In the header of Dev Studio, click .
- Create a report definition:
- In the Label field, enter the title or description of the record.
- Optional: To edit the name, in the Identifier field, click
Edit, and then enter a new name.By default, the Identifier field inherits the name from the Label field. A valid identifier name starts with a letter, and consists of letters, digits, and underscores.
- In the Apply to field, select a class for the report
definition, or select a work pool to report on all work types in the work pool.
- In the Add to ruleset list, select the ruleset in which you want to include the report definition.
- Optional: To associate the report definition with a work item, in the Work item to associate field, press the Down arrow key, and then select a work item.
- Click Create and open.
- In the Edit Report definition page, define the contents and
display of the report.For example, you can edit filters, include a chart, or manage the report body. For more information about the configurable options, see Report Definition rule form.
- Click Save.
- Adding or editing charts from the report definition rule form
You can add a chart to a summarized report by launching the Chart Editor from the report definition rule form.
- Adding maps to reports
You can display the data in a report definition by using a map, if the data supports this kind of visualization. For example, map charts are useful for reports on sales by region, activity by state, and incidents by county. You can select from a wide range of maps.
- Managing scheduled reporting tasks in Dev Studio
Managing scheduled reporting tasks in Dev Studio
- Setting resource limits for reporting
You can set system resource limits that apply when running reports and exporting report data. These resource limits specify the maximum number of rows to retrieve, the maximum elapsed time (in seconds) for the database query, and the number of rows to export at a time.
- Report Definition rule form
A report definition rule defines a report definition report. This rule generates an SQL query that retrieves and sorts information from the PegaRULES database, an external database, or an Elasticsearch index, and generates HTML that displays the results in a variety of formats. You have a range of options for interacting with the results, depending on the settings on the Report Viewer tab.
- Keystores
A keystore is a file that contains keys and certificates that you use for encryption, authentication, and serving content over HTTPS. In Pega Platform, you create a keystore data instance that points to a keystore file.
- Associations
Use an association to define a relationship between two classes based on matching values in pairs of properties. Associations are typically used to enable your application to automatically add a join to a report that displays properties from both classes referenced in the association.
- Keystores
A keystore is a file that contains keys and certificates that you use for encryption, authentication, and serving content over HTTPS. In Pega Platform, you create a keystore data instance that points to a keystore file.
- Removing standard reports and categories from the Report Browser
You can customize which standard reports and report categories are included in the Report Browser in the Case Manager portal. By default, many standard reports and report categories are included in the Report Browser. Managers can run these standard reports, or save copies and modify the reports to meet additional business needs.
- Creating a report category
In Dev Studio, you can create a category to classify reports. Categories allow managers to organize reports in the Report Browser.
- Creating and configuring an OAuth 1.0 client
Create an OAuth 1.0 client data instance to allow an external application to securely access Pega Platform by using OAuth 1.0.
- Creating a report shortcut
Manage, run, and share reports quicker by creating reports shortcuts. You can create a report shortcut by creating a shortcut rule.
- Specifying filter options for the Report Viewer
As a report developer, you can specify the options that case managers have for setting or modifying filter conditions in the Report Viewer. Typically, filter conditions display above the report results in the Report Viewer. However, you can specify whether filter conditions display, whether case managers can edit filter conditions, and whether they are prompted to change filter parameters before a report runs.
- Reviewing usage reports statistics
You can analyze report definition usage and performance in the current application to determine which reports are not used, and remove them to maintain only the required reports.
- Creating a dedicated ruleset version for manager reports
In the Report Browser in the Case Manager portal, managers create report definitions, report shortcuts, and report categories. To enable managers to create and modify these types of rules as they use the Report Browser, you must create a dedicated ruleset version for manager reports.
- Setting up reports database
In some cases, running reports can impact performance because of high demands on database processing. To reduce the performance impact of running reports, you can specify that some reports obtain data from a separate reports database, which can be a copy of all or part of the PegaRULES database.
- Standard reports by category
Standard reports by category
Previous topic Converting a summarized report to a list report Next topic Adding or editing charts from the report definition rule form