Developing a report

Report provides a flexible way for you to design and construct report. All you need to do is to select your target model element/diagram, drag the target template(s) from Property pane and then drop it/them on the report (diagram). You cannot type in the report directly, however, Report allows you to add text, image and table to diagram as necessary. After that, you can export the result to a HTML/ PDF/ Word document. Since Report maintains the linkage between project data and report content, you can refresh the report upon project changes. As a result, it saves your time on repeating the steps for creating report. All predefined templates can be edited in order to fit into your specific needs. An efficient way to customize your own templates is also available. Details about how to edit template will be covered in next chapter.

Creating a Report

Right click on Report on Diagram Navigator and select New Report from the pop-up menu.

Create a report diagram
Create a Report

Developing a report in Report

After you have created a Report, you can select your model elements, and drag and drop them on it.

  1. Select model element(s) you created previously on Diagram Navigator/ Model Explorer/ Class Repository.
    Select a model element
    Select a model element
  2. Select and drag your target template(s) from Property pane, and drop it/ them on the diagram.
    Drag and drop target template on the diagram
    Drag and drop target template on the diagram
    NOTE: If the Property pane is hidden, you can open it by selecting View > Panes > Property from the main menu.

Refreshing report content

Refreshing report content would be time-consuming if you have to repeat the same steps of creating report to update your report content. VP-UML accommodates the refresh button on Report’s toolbar to help you refresh your report content shortly. You can refresh the content of reports, including model elements and diagrams, to retrieve the latest updates and changes.

Return to your Report and click Refresh button on its toolbar.

Refresh report content
Refresh report content

As a result, the modified element(s) will be updated.

Adding custom text

The text box is used for editing data on report. The significant characteristic is, you can display many different types of data with applying RTF within the text boxes.

  1. Select the space where you want to insert text beforehand.
  2. Click Text box button on the Report's toolbar.
    Insert a text box
    Insert a text box
  3. Enter text in the text box. You can use the pop-up formatting toolbar to convert your plain text into RTF when you want to emphasize some terms/ phrases.
    Format text
    Format text

Adding image

Report supports inserting images. An image can be a logo or picture that is placed on the report. You can not only place pictures on the empty space of report, but also fit them inside table cells. In this sense, you can insert your company logo into any preferred place within the report when you are doing a company report. The advantage is, you can spare no effort in arranging a series of images in report and then resize them.

  1. Select the space where you want to insert an image beforehand.
  2. Click Image button on the Report's toolbar.
    Insert an image
    Insert an image
  3. Select the directory of your target image and then click Open button in Choose image(s) dialog box.
    As a result, the selected image is inserted.
    Image is inserted
    Image is inserted

Editing image

You may find that the image on report template is not clear enough since the image is oversized. This also affects the quality of image in both exported report and the printout. It is recommended that you would edit an image and split a diagram on report template to make it legible. After creating multiple diagram templates (the same diagram template) on report, edit each diagram template to show different parts of diagram. It is regarded as splitting diagram. Finally, you can combine those fragmentary diagrams (separate diagram templates) to form a complete diagram after you print out the report.

  1. Drag multiple diagram templates on the diagram in advance.
  2. Click each image so that a bar will appear at the bottom of the image. You can edit the image through the bar. Initially, the whole diagram is displayed to fit the placeholder. As you can see, the slider is placed on Display whole diagram. Now, the extra large diagram is quite blurred.
    The whole diagram is displayed inside the placeholder
    The whole diagram is displayed inside the placeholder

    To zoom in the particular part of diagram, drag the slider to Zoom 100% (Actual Size).

    Zoom in the image
    Zoom in the image
  3. To resize the image, drag the border of placeholder.
    Resize the image
    Resize the image
  4. NOTE: You can only edit the diagram templates you dropped on the report, but not inserted images.
    NOTE: The default setting of image on Report is Disable Auto Fit Placeholder. Nevertheless, once you zoom or resize, it will turn to be Enable Auto Fit Placeholder automatically.

Adding table

Table is one of the important elements while displaying data. It provides a presentable format for data representation. Report enables you to present data with RTF in tabular form by simply pressing Table button on the Report’s toolbar.

  1. Select the space where you want to insert a table beforehand.
  2. Click Table button on the Report's toolbar and select the table size, i.e. the number of columns and rows in the table.
    Select the table size
    Select the table size
  3. Complete the table.

Various page display options

Page display is especially useful when you view the overview of report layout. VP-UML supports 4 display options: single page, single page continuous, two-up and two-up continuous.

Click the Page Display Option button to select a page display option from the drop-down menu.

Select an option
Select an option