Generating reports on designs by using Rational Publishing Engine

You can create report templates and generate reports by using the Rational® Publishing Engine product on a computer that can access the Design Management application.

Before you begin

You must complete the following steps before you can create report templates and generate reports:
  • Install the Design Management Server on a computer with a fully qualified host name (not localhost). The base URL for accessing the Design Management Jazz™ application is https://fully_qualified_host_name:port/dm. One or more project areas must exist on the server, and at least one model must exist in a project area.
  • Install either the IBM® Rational Software Architect Design Manager Import Engine, or the IBM Rational Rhapsody® Design Manager Import Engine on a client computer that is configured to access the Design Management application. If the Design Management application has existing projects that contain UML models that you want to use, you do not have to install the import engine.
  • Install Rational Publishing Engine, version 1.1.2 or later, with its Document Studio and Launcher applications, on a client computer. This product requires a separate license.
Note: Design Management Server is now compatible with version 2.0 of Rational Publishing Engine. You can add and execute RRDG based reports from the Common Reporting UI. RRDG templates are created using the Rational Publishing Engine Document Studio. These templates define the structure of a document-style report where data is collected via REST APIs and reports are exported in HTML, PDF, and MS Word formats. For more information on using this product with Design Management, see the Rational Publishing Engine Knowledge Center.

As a template author or a report generator, you must have an account on the Design Management application that has privileges for accessing the project areas that contain the artifacts to be used in the reports. In the Rational Publishing Engine applications, the Design Management account user name and password are specified by using the authentication type named "OAuth".

About this task

The following high-level steps describe how to generate reports by using Rational Publishing Engine to access artifacts on the Design Management application:
  1. In Rational Publishing Engine Document Studio, create a report template that uses data type schemas that are downloaded from a Design Management application.
  2. In Rational Publishing Engine Launcher, generate a report by configuring a report template with the artifacts that are obtained from a Design Management application.
For more information about creating reports about artifacts in the Design Management application, see the related link to the reporting tutorial. This tutorial demonstrates how to complete the following tasks:
  • Create a report template
  • Customize the layout and format of a report template
  • Associate elements in a report template with elements in a data source schema
  • Configure the data sources of a report template, which is also known as creating a document specification
  • Create reports that display recursive elements such as nested packages
  • Display specific artifacts based on their artifact type (filtering) by adding conditions to controls in the template and defining a filtering script on a container control
  • Convert artifact references to a specific type; this concept is similar to casting in programming languages such as Java™
  • Find collaboration comments for a specific Design Management artifact by creating a query for the Design Management reporting service
  • Find Open Services for Lifecycle Collaboration (OSLC) links for a specific Design Management artifact
  • Add diagram images to reports and create hyperlinks to live diagrams in a Design Management application
  • Show the traceability, by using OSLC links, between artifacts in different Jazz applications