New HTML Report Generator

Starting from VP Suite 2.3 Service Pack 3, a new HTML report generator is introduced, replacing the one supported by the earlier versions. In addition to the fresh new look for the generated report, it also supports a higher level of customization such as content selection, front page, table of contents, table of figures and diagram ordering.

Generating a HTML report

1.	Start the Generate HTML dialog by any of the ways listed below.
	Method 1 - Through the menu
	Select Tools > Report > Generate HTML Report... from the main menu.
	Method 2 - Through the toolbar
	Select Click on the button on the toolbar.
	The Generate HTML is shown as below:
2.	Enter the output folder of the HTML report.
3.	Specify the report generation options and front page. Information about the generation options will be covered in the following section.
4.	Press the Generate button to start generating the HTML report.
5.	If you have enabled Launch Viewer, the report will be opened after the generation has been finished.
Options
	General > Diagram
	Field Description File location The target location of the HTML report. Launch viewer Enable it to launch the default HTML browser to open the generated report after the generation is completed. Generate table of contents Enable it to include the table of contents that list out the chapter's name. Generate table of figure Enable it to include the table of figures that list out the images name. Generate diagrams Enable it to include the diagram's image. Generate reference (file/URL) link Enable it to make the referenced file/URL defined in models click-able in the report. Generate models/diagrams link Enable it to allow internal linkage within the generated report. (e.g. A child model appear in the Children table of a package is linked to the actual position of that child) Copy reference files Enable it to copy files that are referenced by models to the /references folder. Linkage in report will be linked to files inside the references folder instead of the absolute paths defined in the project. Shape type style To select the way how models and diagrams titles are shown. Select Icon to show the title in pattern [$model_type_icon_image $model_name]. Select Text to show the title in pattern [$model_type_name $model_name]. Graphics (Anti-aliasing) Enable it to allow the anti-aliasing of images show in the report. Text (Anti-aliasing) Enable it to allow the anti-aliasing of text appear on the images show in the report. Encoding The encoding of the report contents. This option is extremely important when there are model data written in non-English. If a wrong encoding is chosen, the report content will not be displayed properly. Print Diagrams The tree on the left-hand-side list out all the diagrams in the project. Check them to include them in the report. The list on the right-hand-side shows the report content in order. You can press the up and down arrow to reorder the contents in the preferred order.
	Cover Page
	Field Description Generate cover page Enable it to generate the report cover page. Logo image path The file path of the logo image, that will be shown on the top left hand corner of the cover page. Title The report title. Organization name The organization that owns the report. The text will be shown near the bottom of the cover page. Author name The one who generate the report. The text will be shown under the organization name.

Sample Reports

	Use Case Diagram
	Use Case Description
	Class Diagram
	Entity Relationship Diagram
	Stereotypes

Downloads

• Project file
		courier_vpp.zip (0.2 MB)
• HTML report generated from courier.vpp
		courier_html.zip (0.6 MB)

Related Articles

Related Resources