Designing templates with Rhapsody as a data source

Report designers can use Document Studio to import data source schemas and build report templates.

1. Review Designing document templates for an overview of the template development process.
   Start planning the structure of your document-style report and the data that might be included.
   For example, decide whether the final document-style report will be generated from one template or from multiple template files that each contain reusable pieces of content.
2. In Create a document template.
3. Add a data source schema to your document template.
   For Rhapsody, you can complete the following steps:
   1. In Document Studio, click Data > Add Data Source .
   2. In the Predefined field, select Rhapsody.
   3. In Type, select the type of the schema from the list.
      For Rhapsody, select REST.
   4. Edit the Schema field if needed or click Browse to select the path for the schema file.
      The base URL for Rhapsody is: https://server:port/Rational/Rhapsody/. Appended with ?metadata=schema, the URL is: https://server:port/Rational/Rhapsody/?metadata=schema

      The default location for the Rhapsody schema is Rational_Rhapsody_HOME\RPE\Schemas. Example: Rational_Rhapsody_HOME\RPE\Schemas\default.xsd

      When choosing a schema from a model with profiles applied and new terms, make sure the model with profiles and new terms are loaded in Rhapsody.

   5. Select the Authentication Type from the list.
      If you do not select a type, each type is tested until the correct type is found, which might increase document-style report generation time.
   6. If the resource is on a secured server, specify the Username.
   7. If the resource is on a secured server, specify the Password.
      Note: You can specify the user password or the application password that is generated by the configured third-party identity provider, such as SAML or OIDC. You must select Basic authentication method while using application password.
   8. Click Finish.
      The data source schema you selected displays in the Data Source View.
4. Add elements to the template.
   The product includes a comprehensive set of template elements that you can use to structure your document-style report. You can drag elements into the template content editor. For example, you can add a Container element to hold several paragraphs. Each paragraph might be controlled by a test condition that associates it only with specific data. For more information, see Template elements in the Palette view and Adding elements to a template.
5. Use queries, attributes, and variables to add data to a template. These items specify which pieces of information are generated in the report.
6. Add formatting and styling to the elements to control how they display in the output.
7. Create filters to narrow the data that is pulled into the report.
   You can use filters, which are detailed versions of the general data source URI, to point to specific subsets of data so that Engineering Publishing ( PUB) does not try to retrieve more information than necessary from the data source during report generation. These filters must be broad enough to retrieve all necessary data referenced by the template or the generated report cannot include complete data.
   See also Filter conditions supported by REST native filters for more information.
8. You can use a cast query filter to refine the results of a query. The type casting feature works as an alternate filter for data source elements, see Type casting for details.
9. Create sorts to organize the data in your report.