Generating documents with HP ALM as a data source

After you finish creating the report template and populating it with data points, you can generate a report in various formats.

About this task

You can generate documents with HP ALM as a data source. For more information, see the video Generating documents from HP ALM data.

Procedure

  1. In either Document Studio or Launcher, open the document generation wizard by clicking Document Specification > Generate > Configure and generate document.
  2. The Templates section lists the templates in the document specification. To add a template:
    1. Select the location of the templates to add:
      • From the central library: To select templates stored in Publishing Document Builder
      • From local or remote file: To select local or remote templates, you can either enter a URL to a template or click Browse to select a template.
    2. Select one or more templates to add.
      • If you selected From the central library and selected templates from Publishing Document Builder, click Add selected to add the templates to the document specification.
      • If you selected From local or remote file and entered a URL to an individual template, click Add URL to add the template to the document specification.
      • If you selected From local or remote file and browsed to add templates, when you click Open, the templates are added to the document specification.
    3. Optional: Repeat to add more templates from other locations.
    4. Optional: Reorder the templates in the document specification by selecting a template and clicking Up or Down.
    5. Click Next.
      After you add a template, the data sources and variables that are specified in the template are also added to the wizard.
  3. In the Data sources section, configure each data source.
    1. Select Manual configuration and provide a value for the data source by entering a URL or clicking Browse to select the JSON file.
      Example URL: http://[host]:[port]/qcbin/api/domains/DEFAULT/projects/RPETEST/defects.
    2. If the resource is on a secured server, specify the User name.
    3. If the resource is on a secured server, specify the Password.
    4. Select the Authentication Type from the list.
      If no type is selected, each type is tested until the correct type is found. Specifying a type allows this process to be eliminated.
    5. Optional: Enter an accept header.
      The default value is application/xml, */*.
    6. Optional: If you want to use your credentials with each data source, select the Apply these user name and password values to every configured and unconfigured data source option.
    7. Click Next.
  4. In the Output section, select the output types to generate:
    • Microsoft Word
    • PDF
    • HTML
    • XSL-FO
    • Excel
    1. Optional: For the Save location, click Browse to select a path to save the file for each output type.
      You can edit the path to be a relative path from the document specification. If you don't specify a save location for the output, the file is generated in a temporary location.
    2. Optional: For the Style sheet, click Browse to select a style sheet to use for generating each type of output.
    3. Optional: Microsoft Word output only: For the Macro, enter the name of the macro that is contained within the style sheet.
    4. Optional: Microsoft Excel output only: To insert a new sheet in the workbook, add the document break element. To specify the name of the new sheet, add it as a property of the document break. Make sure that the name is short enough to fit on the tab for the worksheet.
    5. Optional: To enter more metadata or configure other document properties that are not included in the wizard, click Edit metadata properties.
    6. Click Next.
  5. Verify the template and output information in the summary window.
  6. Select which action to take when you click Finish:
    • Run the document generation: Generates the output types that you specified.
    • Run the document generation and quit PUB: Generates the output types that you specified and closes the application after you exit the Results window.
    • Save and close this wizard without generating the document: Closes the document generation wizard but keeps Launcher open.