Manually importing custom document-style report templates for requirements management

If you are using the Requirements management application, you must manually import customized document-style report templates by uploading files to the Jazz® Team Server.

Before you begin

To add or modify a template, complete the following steps:
  1. On the server, open the following directory: https://server:9443/application context root/reporting/initialization/templates

    For example, the full path might be C:\IBM\JazzTeamServer\server\conf\rm\reporting\initialization\templates\word for a Microsoft Word template.

  2. Open the appropriate subdirectory, and make the necessary changes to either the PUB or Microsoft Word template by using the appropriate tool. For PUB templates, you must have a licensed copy of the PUB Document Studio tool.
See Creating a document-style report on Engineering Lifecycle Management data by using Engineering Publishing.

Procedure

  1. Add any new Microsoft Word or PUB templates to the appropriate subdirectory.
  2. If the report template uses a custom style sheet for the Microsoft Word output, you must upload both the PUB and the Microsoft Word template. For Microsoft Word templates, you can use Microsoft Word or a similar compatible tool. For Engineering Document Generation , to function correctly, you must save Microsoft Word templates in the Word 2003 format.
  3. The \META-INF\MANIFEST.MF file contains information that is used to populate the reporting wizard with the appropriate PUB templates. If new templates are added, an entry must be added to this file. The new entry is similar to the following text: 
    Name: audithistory
Location: templates/rrdg/audithistory.dta
Label: Audit History
Description: Change history log
Content-Type: application/octet-stream
Is-Report: true
    The following table provides further information about the properties of a manifest entry:
    Table 1. Manifest entry properties
    Name Required Description
    Name Yes The name of the report template. The name must be unique in this file.
    Location Yes The directory path to access the report.
    Label Yes Textual label for the report template. This label is the title of the report template that is shown in the requirements management Reports wizard.
    Description No* Optional description for the report template.
    Content-Type Yes The content type that is used when you are uploading a report template.
    Is-Report No Determines whether the report template is available for selection in the requirements management Reports wizard. If present and set to "true", the template displays in the Select a Document-Style Report Type page of the wizard.
    Context No States in which context the report is displayed. Set to view, module, collection or review. For example, if you want to create a report that is only displayed in the module context, set the context to module.
    Important: You must have an empty line at the end of the MANIFEST.MF file
  4. After the changes are made, reinitialize the publish service on the server. To reinitialize,
    1. Open https://server:9443/application context root/admin in a browser.
    2. Click Debug.
    3. Under Services, click Publish Services.
    4. Click Initialize Service.
    Remember: You need Jazz Admin privileges to reinitialize the publish service.
    If the reinitialization is completed successfully, the following message is displayed: Publish Service initialized successfully.

Results

If you completed this procedure successfully and set the Is-Report property to true in the manifest file, the new template displays in the Select the Document-Style Report Type window of the Create a Document-Style Report wizard.
The Document-Style Report Type window displays a list of available templates.