Checking for template errors

You can verify that a template is free from issues before generating the output. To view a list of issues, run the verification tool and review the list in the Problems view. To generate a preview of the document to check for formatting issues, run the Preview tool.

Before you begin

Review the information in the Console view in either Document Studio or the Launcher for issues. If there are issues from a document generation, the information might lead you to solutions for fixing your template.

Running the verification tool

Procedure

  1. Open the template in Document Studio.
  2. Click Template > Verify Document Template. The Problems view opens and lists of errors and warnings from the template.
  3. Resolve the errors and warnings that are listed in the template.

What to do next

Tip: When testing your templates:
  • Create small input sources for testing: Create special versions of the input sources and keep changing them to evaluate conditions contained in the templates.
  • Preview large input sources: Processing of a template is made faster, by limiting the amount of data returned by each query. You can configure the number of data objects per query in the preferences. For example, instead of showing the a complete module with 100 objects, only the first 10 objects are processed.
  • Test multiple input sources individually: Input sources can be deactivated by setting their ignore property to true in the document specification. Test a template with single input sources first before testing it with all input sources simultaneously.

Generating a document preview

Before you begin

You can select the number of results that display in the preview in the Query results limit preference. See Setting the engine preferences.

About this task

Tip: To suppress the Preview wizard and preview without completing these steps, click Window > Preferences > RPE > Document execution and for Use Publish Wizard, select No.

Procedure

  1. In Document Studio or Launcher, click the Preview icon Preview icon in the toolbar.
  2. If the Report configuration window opens, your template requires additional configuration before the preview can be generated.
    1. If there is an Attention icon Attention icon next to an item in the Name column, the default value is being used as the current value. You can double-click the cell in the Current value column to configure the value.
    2. Click Run when you are finished configuring to start generating the preview.
  3. If you have not configured all of the data sources in a document specification, you be might be prompted to do so:
    • Click Yes to continue with preview without configuring the data sources.
    • Click No to cancel the preview.
    • If you are using the Document Studio application, you can click Change perspective to open the Launcher application and configure the data sources. If you are using the Launcher application, the Change perspective option does not display.
    If you select Yes, the preview generates and the Results window opens.
  4. In the Results window, select the output format in which to open the preview.

What to do next

Review the information from the document generation in the Console or Problems view to identify issues.

Feedback