Word Report Generation

Word Report Generation is a new feature in VP Suite 2.3 SP3. It use for generate report in Microsoft Word format (.doc). Like generate PDF report, it supports a higher level of customization such as cover page, header and footer, table of contents, table of figures and diagram ordering.

Generating a Word report

Start the Generate Word dialog by any of the ways listed below.

Method 1 - Through the menu
Select Tool > Report > Generate Word Report... from the main menu

Method 2 - Through the toolbar
Click on the button on the toolbar

The Generate Word dialog is shown as below:
Enter the File location of the Word report. Make sure that the file path spcified is not pointing to a file that is opened.
Specify the report generation options, cover page, header and footer. Information about the generation options and how to work with the header and footer will be covered in the following sections.
Press the Generate button to start generating the Word report.
If you have enabled Launch Viewer, the report will be opened after the generation has been finished.

Option

General > Diagram

Field	Description
File location	The target location of the Word report. Make sure that the file path specified is not pointing to a file in-use.
Launch viewer	Enable it to launch the default Word viewer to open the generated report after the generation is completed.
Options
Generate table of contents	Enable it to include the table of contents that list out the chapter’s name and the corresponding page numbers.
Generate table of figure	Enable it to include the table of figures that list out the images name and the corresponding page numbers.
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 real position of that child)
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].
Details
Children	Enable it to generate the children details for each class
Member	Enable it to generate the class members details for each class
Properties	Enable it to generate the properties details for each class
Relationships	Enable it to generate a page to list out the relationships for each class
References	Enable it to generate a page to list out the reference for each class
Sub-diagram	Enable it to generate a page to list out the sub-diagram details for each class
Tagged values	Enable it to generate a page to list out the Tagged values for each class
Comments	Enable it to generate the comment for each element
Anti-aliasing
Graphics	Enable it to allow the anti-aliasing of images show in the report.
Text	Enable it to allow the anti-aliasing of text appear on the images show in the report.

General > Page

Field	Description
Page size	The size of report pages.
Page Orientation	Select Portrait to indicate that the report is wider horizontally than it is vertical. LandScape is opposite to Portrait.
Page Margin	Specify the border of pages. You can enter the value directly or drag the dotted line to adjust the value interactively.

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.

Document Info

Field	Description
Title	The property title for the generated document
Author	The property author for the generated docuemnt
Subjects	The property subject for the generated document
Keywords	The property keyword for the generated document

Working with header and footer

To edit the header and footer of the report, open the Header/Footer tab from the Generate Word dialog box.

You should see there are two input area in the dialog, which correspond to the header and footer respectively. You can select the items to be appeared in each section. Here are the steps:

Click on either the header and footer.
You can enter the contents directly and/or select a variable from the list appear at the center of the Generate Word dialog box. Below is a table that describe what does each variable stand for.

Variable Image	Name	Descriptions
	Selection Font	Click on it to select a font for the section.
	Add Image	Click on it to select an image to be added to the cursor position. The selection is recorded such that you can reuse the same image the next time.
	Insert page number	Click on it to add a page number variable to the cursor position.
	Insert page count	Click on it to add a page count variable to the cursor position.
	Insert Date	Click on it to add a date variable to the cursor position.
	Insert Time	Click on it to add a time variable to the cursor position.
	Insert project name	Click on it to add a project name variable to the cursor position.
	Insert Report file name	Click on it to add a report file name variable to the cursor position.
	Insert user name	Click on it to add a user name variable to the cursor position.
	Left Alignment	Click on it to align the text and variable on Footer/Header to left
	Cneter Alignment	Click on it to align the text and variable on Footer/Header to center
	Right Alignment	Click on it to align the text and variable on Footer/Header to right