Generating a document-style report by using the PUB document-style report generation wizard

Edit online

You can use the document-style report generation wizard to configure the report requirements.

Procedure

  1. In either Document Studio or Launcher, open the document-style report 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.
    Note:
    • 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. Database: Enter the database name to connect to. By default, -data 36677@localhost is used.
      If -data is not specified, it is automatically appended for you. If no value is specified, Engineering Publishing retrieves the default value from the registry whenever possible.
    2. Path to doors.exe: Enter the full path to doors.exe.
      If the path is invalid or cannot be accessed, the wizard corrects the path for you when possible.
      Example: C:\Program Files\IBM\DOORS\version\bin\doors.exe
    3. Module URI, View, and Baseline: You can type these values or click Discover to use a wizard to select from a list of values.
      If you choose to use the discovery wizard, click Next and complete one of the following steps:
      • Click Next to select values for the Module URI, View, and Baseline. If you click Next, in the Select a view from the DOORS database window, you can select from lists of modules, views, and baselines. Then click Finish.
      • Enter a Module URI. After a module URI is entered, Finish is enabled and you can click it to use the default values for view and baseline. To use a view and baseline different from the defaults, enter View and Baseline values to use instead and click Finish.
        Note: If you manually edit the Module URI value and enter an incorrect value, you might prevent the output from being generated. When you provide an incorrect or null value for View or Baseline, the output generates from the standard view of the current module version. The output generates, but the data might not be correct.
    4. User name: Enter the DOORS® account name.
    5. Password: Enter the DOORS account password.
    6. Choose whether to use the Use running DOORS instance during document generation option:
      • If DOORS is expected to be running from the location you specified for the Path to doors.exe field when you generate a document-style report from this document specification, select the Use running DOORS instance during document generation option. Processing time can be faster when you use the running DOORS instance.
      • If DOORS is not expected to be running from the location you specified for the Path to doors.exe field when you generate a document-style report from this document specification, clear the Use running DOORS instance during document generation option to start a new instance.

    When incorrect values are replaced by PUB in the wizard, the values are also updated in the Properties view for the data source and in the run time flag values.

  4. In the Variables section, configure each variable.
    Note:
    • 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.
  5. 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.
  6. Verify the template and output information in the summary window.
  7. 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.
    Note: If you are using the document generation wizard from the DOORS add-in, selecting Save and close this wizard without generating the document closes the wizard and the Launcher application.