Reporting overview

Reporting is the process of using an SQL (Structured Query Language) query to retrieve and sort information from the Pega Platform™ database, an external database, or the Elasticsearch index. This process generates HTML that displays the query results in a variety of formats in the Report Viewer.

The Report List provides report shortcuts to the reports that are available for you to run. In the Report List, report shortcuts are assigned to one of the following categories based on the purpose of the report:

  • Case Metrics
  • Open Cases
  • Service Level Performance
  • Step Performance

Organizational roles for reporting

The following roles are essential for reporting:

  • Application Developers (Developers) are responsible for building embedded reports, reports that analyze the design and structure of the application itself, and more complex ad hoc reports. They must be:
    • Trained in Pega Platform.
    • Very familiar with database concepts.
    • Very familiar with the design of the application, and particularly of the application data model, so that they understand the meaning and content of all relevant data elements included on reports.
  • Business analysts and end-user managers (End users) who frequently develop or customize reports must be:
    • Familiar with the business processes which the application supports.
    • Familiar with the application data model, so that they understand the meaning and content of all relevant data elements included on reports.
  • Database administrators (DBA's) are responsible for maintaining the Pega Platform database and monitoring report usage. In addition to their usual background, they should have basic training in Pega Platform so that they understand how application data is stored in the database.

Important terminology

Dashboard: A dashboard is an assembly of charts based on reports that is designed to provide a manager or stakeholder with a quick view of the current status of the work the reports cover. Viewers can normally drill down (see below) into the charts to see more details about the information they depict.

Drill down: In summary reports, and in charts associated with them, users can generally click on an entry in the report or a section of the chart to 'drill down' into the report and see in more detail the data supporting the top-level display.

List report: Displays information in a spreadsheet format about work objects of a particular class, where each row represents data about a single work object and each column presents the data held in a database field associated with the work objects.

Report Browser: The Case Manager portal includes a report browser that lets a manager create new reports, modify existing reports, and share reports with other managers.

Report Editor: The Case Manager portal includes a report editor that helps you modify reports so they contain the data you want displayed in a clear and compelling way. You can add charts to summary-type reports, set data filtering, and fine-tune right down to the pixel width of the report columns. The Data Explorer helps you find the properties and create the calculations you want your report to include.

Report Viewer: The composite Manager portal includes a report viewier that lets a manager review, modify (including adding charts to summary-type reports), and export reports.

Summary report: Displays summarized or aggregated information (grouped by subtotals, averages, dates, or other factors) for work items or class instances.

Trend report: A trend report organizes data along a time line or other progress indicator. Managers use trend reports to understand their business processes: for instance, a manager may want to see a report of the number of sales made per month over the past year.

Relational database: A relational database stores information in multiple tables, and then assembles information related to a particular data object based on relationships between the various tables. For instance, in a system managing employees, the table holding the basic employee record might hold the person's first and last name, a code for the person's department that refers to an entry in the "Dept" table, a code for the person's job title that refers to an entry in the "Positions" table, and so on. Pega Platform uses SQL commands (see below) to tell the database what data to retrieve.

SQL: Pega Platform uses Structured Query Language (SQL) to query the database for the information the report needs. SQL is a language designed for managing data in relational database management systems. The Report Viewer simplifies selection and assembly of SQL statements: creating Pega Platform reports requires no extensive knowledge of SQ.

Have a question? Get answers now.

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