Generating report

Report generation is the process of producing a report for sharing your design work and model specification with teammates and clients. You can generate reports in different formats such as HTML, PDF or MS Word for reading or publishing in different environments. They differ in file format, but have the same layout. In this chapter, we will go through the core steps in report generation.

To generate a report:

1. Select Tools > Report from the main menu. Then select Generate HTML Report..., Generate PDF Report... or Generate Word Report... depending on the type of report you want to generate.
2. In the Generate HTML/PDF/Word dialog box, fill in the output path where the report should be generated to.
   

   NOTE:

   For HTML report, specify the folder of the HTML files to be generated. For PDF report, specify the file path of PDF file (*.pdf) to be generated. For MS Word report, specify the file path of the document file (*.docx) to be generated.

3. Select the grid(s) and/or diagram(s) to be included in report.
   

   Select diagram to include in report

4. Make any necessary configuration such as the page layout, cover page, etc. For details about configuration, refer to the next chapter.
5. Click Generate to proceed with generation.

Overview of report generation dialog box

Overview of report generation dialog box

The bottom part of report generaition dialog box for MS Word report

No. Name Description 1 Content The main page of report generation that lets you select the diagram(s) to generate report. 2 Options Configurable options for detailed report configuration. 3 Page Setup The setup of layout of report. 4 Header/Footer The content of header and footer. 5 Document info To define document info. 6 Template You can define a template for report generation by clicking on the drop down menu next to Template, and selecting <New>. Once a template is defined, you can select it from the same drop down menu, and proceed with generation with the template. For details about report customization, read the next chapter. 7 Use external template Click to link to an external template file. 8 Edit template Click to edit the template selected in the drop down menu of Template. 9 Delete template Click to delete the template selected in the drop down menu of Template. 10 Import template Click to import a template file into the current project. 11 Output path The output path of report to be generated. 12 Launch viewer Check to open the report automatically after generation. 13 Available diagram list The list of diagrams in opening project. 14 Selected diagram list The list of diagrams selected to generate report. 15 Preview Preview of diagram being selected in the list of selected diagram 16 Reset Reset changes made in this dialog box 17 Reset to default Reset changes made in this dialog box to default settings. 18 Set as default Set the settings in this dialog box to default. 19 Generate Click to generate report. 20 Cancel Click to close the report dialog box. 21 Apply Click to apply the changes made in report, causing reopening of this dialog box to restore the applied settings. 22 Help Click to read the help contents. 23 Word template path Available only to MS Word report generation, this option enables you to specify the path of MS Word document file that you want the generator to use as template. Report generator will append the template file content in front of generated report. In other words, you can prepare a file for cover page. Apart from this, style will also follow the definition in template file. For details, please read the section Generating MS Word report with template (MS Word report only).

Description of report generation dialog box

Generating MS Word report with template (MS Word report only)

At the bottom of the MS Word report generation dialog box, there is an option Word template path, with a text box next to it for filling in the path of template file. A Word template file provides the start up contents and defines the style of report. During report generation, the generator will make a copy of the template file, treat the copied file as base, append the generated content to the copied file, and save the file to the destination path. By using a word template, you can define your own headers/footers, cover page, start up content, styles for your generated report.

A generated report with style defined in template applied

Sorting diagrams in report

By default, diagrams show in report follows the order defined in diagram tree in the Generate PDF dialog box. We may, however, sort the diagrams to make them appear in desired sequence. To sort diagram(s), select the diagram(s) to be ordered on the list at the center of dialog box, and click   or  to sort.

Reorder diagram

Sorting shapes in report

Custom sorting

1. Select the diagram to sort and click  to expand it.
2. Select the shape(s) to sort.
3. Click or to sort.
   

   Sort shapes

Automatic sorting

1. Select the diagram to sort and click to expand it.
2. Select from the drop down menu Sort element a way to sort.
   

   Select the way to sort shape

   
   

   Way of sorting Description Automatic The way of sorting elements is automatically managed. The order is often based on the flow and/or position of elements, which is the most logical order, following most users' understanding of that kind of diagram. Sort by Tree Sort diagram elements by following the order defined in Diagram Navigator. Sort by Name Sort diagram elements alphabetically base on their name, in ascending order. Custom The way of sorting elements is controlled by user, through selecting elements and pressing or .

   Different ways of sorting