Previewing a document-style report with the document generation wizard

For document-style reports with large amounts of data, you can generate a document-style report from the Launcher and Document Studio applications with only a subset of the data to decrease generation time.

Before you begin

Every template is associated with a blank document specification by default. When you preview or publish a template from the Document Studio application, this blank document specification can be customized or used without customization to generate the output. The Document Studio keeps the template in sync with the default document specification when you open or save the template.
Note: These instructions apply to most data sources, but not all data sources. For instructions for each data source, see the Integrating documentation for your data source.

About this task

The subset of data that is included in the preview is the first 10 data entries by default. You can change this number in the Engine Preferences:
  1. Click Window > Preferences > PUB > Engine preferences.
  2. In the Preview query results limit, enter the number of data entries to include in the preview.

There is no difference in generating previews from the Launcher application or the Document Studio application. When you use the wizard to generate document-style reports, the same options are provided in both applications. However, in the Launcher application, you have the ability to configure details for the document preview in the Document Specification and Properties views without using the wizard.


  1. In the Launcher or Document Studio, click Document Specification > Preview > Configure and Preview Document.

    You can also click the Configure and preview icon Configure and Preview Document icon in the toolbar.

    A configuration wizard opens to allow you to make additional selections for the preview before it is generated.
  2. In the Data sources section, configure each data source.
    • If a data source has a default value or you enter a default URI, the data source is listed as configured and the default value is used in the output unless you select another value.
    • If you move past the Data sources section and then click Back to change a data source, the section always opens to the first data source in the list.
    • To select artifacts from a specific configuration, first set Global Configuration (GC) URL in the Configuration context. Then, select an artifact by using Resource picker, otherwise Resource picker displays the contents from a default stream of the selected project area.

    1. Select a data source from one of the following locations:
      • Manual configuration: To select a local or remote data source because no other configuration information exists for this data source in the configuration layer.
      • Load from configuration layer: To select a value from the configuration metadata that was entered for the data source in the template.
    2. Depending on the selection you made in the previous step, you can enter a URL for the data source, click Browse to select one, or select a value from the configuration layer.
    3. Select an authentication type.
      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.
      • Auto
      • Basic - Use this setting to generate document-style reports from reports that are exported from the Jazz Reporting Service.
      • Form
      • OAuth
      • OAuth-OSLC
      • SSL Certificate: Specify the certificate path and the password.
      • Smart-Card: Enter the smart card certificate name and the password.
      • Kerberos-SPNEGO
    4. Enter your credentials for the data source application.
      Note: The user can specify the user password or the application password that is generated by the configured third-party identity provider, such as SAML or OIDC. User must select Basic authentication method while using application password.
    5. Optional: Enter an accept header.
      The default value is application/xml, */*.
    6. Optional: In the Extra headers field, select a POX (Plain Old XML) link, for example <>; rel="profile". This approach is useful when creating traceability document-style reports from Engineering Lifecycle Management applications.
    7. 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.
    8. Click Next.
  3. In the Variables section, configure each variable.
    • If a variable has a default value, it shows as configured and the output uses the default value unless another value is selected.
    • If you move past the Variables section and then click Back to make further changes to a variable, the section always opens to the first variable in the list.
    1. From the drop-down menu, select an option:
      • Manual configuration: To enter any value for the variable if there isn't any other configuration information for this variable in the configuration layer.
      • From configuration layer: To select a value from the configuration metadata that you entered for the variable in your template.
    2. Enter or select a value for the configuration.
    3. 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/Excel output only: For the Macro name, 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-style report 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.
  7. Click Finish.
    Tip: If you are generating the document-style report remotely, you can close the Document Studio or Launcher application before the document-style report generation completes without interrupting the process. If you are generating the document-style report locally, do not close the Document Studio or Launcher application until the document-style report generation completes.