Creating report templates

You can use Rational® Publishing Engine Document Studio to create a report template, load the schemas for the data types to report on, and design the layout for the report by using the palette tools. A report template has .dta as a file name extension.

Before you begin

You must have Rational Publishing Engine Document Studio version 1.1.2 or later open, and you must be in the RPE Studio perspective. You must know which data types that you want to report on, and be a member of the projects to report on.

Procedure

  1. In Rational Publishing Engine Document Studio, in the RPE Studio perspective, click File > New > Document Template.
  2. Load the schema for an element: Click Data > Schema Discovery > REST Schema Discovery, and complete the pages in the wizard:
    1. On the Base Configuration page, specify values for the following fields:
      • Name: Specify a name that identifies the type of schema being returned. For example, if you are loading the schema for a UML Package, you might specify Package in this field. You can also edit this name in the Outline view of the editor.
      • Base URL: Specify a URL that includes the Design Management Server hostname and port, host application, and reporting service, as in the following example: https://hostname:9443/dm/reporting

        The URL that you specify

      • Authentication type: From the list, select OAuth.
      • User and Password: Specify the username and password that grant access to the resources in the Design Management application.
    2. Click Next.
    On the Locate Resource Using Data Service page, also known as the schema page, the resources that exist at the base URL are displayed.
  3. On schema page, in the "XML schema" pane, select an element from the XML schema navigation. In the "Element attributes" pane, select the href check box and any other attributes that you want to display about a resource; then click Next.
  4. On the Select Resource URL Discovered By Data Service page, also known as the resource page, select a resource. If you have previously loaded a custom metamodel, information about the metamodel is displayed in this list. After you select a resource, complete one of the following steps:
    • To display the schema for the selected resource, click Next. To explore the data types, repeat steps 3 and 4 until the data source schema to import is displayed on the resource page of the wizard.
    • To download the schema for the selected resource into the report template, click Finish.
  5. On the resource page, click the resource whose schema you want to import; then click Finish. The schema is imported into the template and displayed in the Data Source Schemas perspective. From this perspective, you can access the schema elements as you customize the report template.
  6. Click File > Save.

Results

In Rational Publishing Engine, check the Console view for errors. You can now customize the template.

Hidden content

Nav and search titles

Index entries

This topic does not contain 'alt' text.