![]() ![]() ![]() |
Agilian provides several report generation facilities for documenting your the project. Report Writer streamlines your work by keeping the project and document in sync. HTML/PDF report generation facility outputs your project as web pages and PDF documents, portable to different platforms and environments. Word report generation outputs reports in MS Word format. Project Publisher exports the project into interactive web pages that can be read in any web browsers with no additional plug-in required. Report Writer can extract data from models. Features of sorting elements allow you to prepare a systematic report.
A report is generated by converting project or diagrams in Agilian to other types of document, such as HTML and PDF.
With report, users without VP can still read the project and diagrams. For example, if the user has installed a browser, he can read the Agilian project if the project is converted to HTML report.
Although both HTML report generation and Project Publisher can generate web pages, they are different. For HTML report, it is a document-like presentation. All the content is shown in one page. On the other hand, for project publisher, it acts like a viewer, allowing reader to browse the project content. There are 3 views - Diagram, Model, Class. Each one is a perspective of the project.
![]() |
Figure 6.1 - Generate PDF Dialog |
Field | Description |
---|---|
Output path |
To select the destination file for the generated report. You can type the path in the text field or you can browse the location by clicking on the ...button. |
Launch viewer | If this option is selected, the default browser of the system will be opened automatically to show the generated document. |
Generate table of contents | If this option is selected, table of content for this document will be generated to the report |
Generate table of figures | If this option is selected, table of figures for this document will be generated to the report |
Generate diagrams | If this option is selected, the image of the selected diagrams will be generated to the report. |
Generate diagram properties | If this option is selected, the properties of the selected diagrams will be generated to the report. |
Generate diagram summary | If the option is selected, the summary of the selected diagrams will be generated to the report. |
Generate reference (file/URL) link | Select to generate links for referenced files/URLs defined in models. |
Generate models/diagrams link | Select to generate links for navigating to related models and diagrams. |
Shape type style |
Icon - using Icon to represent the type of shape and diagram elements Text - using text to represent the type of shape and diagram elements |
Sort element by | Automatic - sorting elements by listing them in the most logical order, which is to follow most users’ understanding of that kind of diagram Follow tree - sorting elements by following the sort order of the diagram tree in the tool id or name - sorting elements by their ID or names You can refer to the section 'Sorting Elements in Report'. |
Details | |
Children | Select to generate children of model |
Members | Select to generate members of model |
Properties | Select to generate properties of model |
Relationships | Select to generate relationships of model |
References | Select to generate references of model |
Sub-diagrams | Select to generate sub-diagrams of model |
Tagged values | Select to generate tagged values of model |
Comments | Select to generate comments of model |
Anti-aliasing | |
Graphics | To enable/disable the graphic anti-aliasing of the diagram images. |
Text | To enable/disable the text anti-aliasing of the diagram images. |
![]() |
Figure 6.2 - PDF Report |
![]() |
Figure 6.3 - The Generated PDF Report |
There are two image quality options for the PDF Report: Anti-aliasing for Graphic and Text.
As the dimension of the paper limits the size of the image in the PDF report, Agilian provides an extra image quality option in the PDF report to control how the output image will be displayed in the report.
To change the diagram quality option, select the Anti-aliasing option.
![]() |
Figure 6.4 - Define image quality |
This option allows the user to define the page settings, such as the paper size and orientation of the report. To configure the page settings:
![]() |
Figure 6.5 - Page setup |
Field | Description |
---|---|
Page size | To select the paper size of the generated report. |
Page Orientation | This option is used to select the orientation of the report (portrait/landscape). |
Page Margin | To specify the page margins of the report. |
Agilian supports a wide range of page sizes for PDF report generation. Different paper sizes can be selected in the Page size drop-down menu.
![]() |
Figure 6.6 - Select the Page Size |
To select the page orientation for the output report, select the desired orientation option in the Page Orientation section.
![]() |
Figure 6.7 - Select the Page Orientation |
To adjust the page margins enter the value in the text box at the margin side you want to adjust, or drag the margin in the preview page.
![]() |
Figure 6.8 - Adjust the page margin |
![]() |
Figure 6.9 - Define a Header/Footer |
Header/Footer Style | Description |
---|---|
![]() |
To format text style, such as font style, size and color. |
![]() |
To insert an image to the header or footer |
![]() |
Insert page number |
![]() |
Insert page count |
![]() |
Insert date |
![]() |
Insert time |
![]() |
Insert project name |
![]() |
Insert report file name |
![]() |
Insert user name |
![]() |
Figure 6.10 - Define Document Info |
Field | Description |
---|---|
Title | The title of the report. |
Author | The author of the report. |
Subject | The subject of the report. |
Keywords | The keywords of the report. |
Info header | The info header of the report. |
Info header content | The info header content of the report. |
Allow modify | Select to allow modification on the report. |
![]() |
![]() |
Figure 6.11 - The generated PDF Document Info |
![]() |
Figure 6.12 - Define the cover page |
The Generate Word dialog box provides a set of options for changing the report style. To display the dialog box, perform one of the following actions:
![]() |
Figure 6.13 - Generate Word Dialog |
Field | Description |
---|---|
Output path | To select the destination path for the generated report. You can type the path in the text field or you can browse the location by clicking on the ...button. |
Launch viewer | If this option is selected, the default application of the system will be opened automatically to show the generated document. |
Generate table of contents | If this option is selected, table of content for this document will be generated to the report |
Generate table of figures | If this option is selected, table of figures for this document will be generated to the report |
Generate diagrams | If this option is selected, the image of the selected diagrams will be generated to the report. |
Generate diagram properties | If this option is selected, the properties of the selected diagrams will be generated to the report. |
Generate diagram summary |
If the option is selected, the summary of the selected diagrams will be generated to the report. |
Generate reference (file/URL) link | Select to generate links for referenced files/URLs defined in models. |
Generate models/diagrams link | Select to generate links for navigating to related models and diagrams. |
Shape type style |
Icon - using Icon to represent the type of shape and diagram elements Text - using text to represent the type of shape and diagram elements |
Sort element by | Automatic - sorting elements by listing them in the most logical order, which is to follow most readers’ understanding to that kind of diagram Follow tree - sorting elements by following the sort order of the diagram tree in the tool id or name - sorting elements by their id or names You can refer to the section 'Sorting Elements in Report'. |
Details | |
Children | Select to generate children of model. |
Members | Select to generate members of model. |
Properties | Select to generate properties of model. |
Relationships | Select to generate relationships of model. |
References | Select to generate references of model. |
Sub-diagrams | Select to generate sub-diagrams of model. |
Tagged values | Select to generate tagged values of model. |
Comments | Select to generate comments of model. |
Anti-aliasing | |
Graphics | To enable/disable the graphic anti-aliasing of the diagram images. |
Text | To enable/disable the text anti-aliasing of the diagram images. |
To generate a Word Report:
![]() |
Figure 6.14 - The Generated Word Report |
There are two image quality options for the Word Report: Anti-aliasing for Graphic and Text.
Since the dimension of the paper limits the size of the image in the Word report, Agilian provides an extra image quality option in the Word report to control how the output image will be displayed in the report.
To change the diagram quality option, select the Anti-aliasing option.
![]() |
Figure 6.15 - Define image quality |
This option allows the user to define the page settings, such as the paper size and orientation of the report. To configure the page settings:
![]() |
Figure 6.16 - Page setup |
Field | Description |
---|---|
Page size | To select the paper size of the generated report. |
Page Orientation | This option is used to select the orientation of the report (portrait/landscape). |
Page Margin | To specify the page margins of the report. |
Selecting the Page size
Agilian supports a wide range of page sizes for Word report generation. Different paper sizes can be selected in the Page size drop-down menu.
![]() |
Figure 6.17 - Select the Page Size |
To select the page orientation for the output report, select the desired orientation option in the Page Orientation section.
![]() |
Figure 6.18 - Select the Page Orientation |
To adjust the page margins enter the value in the text box at the margin side you want to adjust, or drag the margin in the preview page.
![]() |
Figure 6.19 - Adjust the page margin |
To define the Header/Footer of the document:
![]() |
Figure 6.20 - Define a Header/Footer |
Here, a separator can be added to the report to separate the region between Header, Content and Footer.
Agilian supports several types of header/footer style for the Word report. They are described in the table below:
Header/Footer Style | Description |
---|---|
![]() |
To format text style, such as font style, size and color. |
![]() |
To align content to left. |
![]() |
To align content to center. |
![]() |
To align content to right. |
![]() |
To insert an image to the header or footer |
![]() |
Insert page number |
![]() |
Insert page count |
![]() |
Insert date |
![]() |
Insert time |
![]() |
Insert project name |
![]() |
Insert report file name |
![]() |
Insert user name |
To define the document info:
![]() |
Figure 6.21 - Define Document Info |
Field | Description |
---|---|
Title | The title of the report. |
Author | The author of the report. |
Subject | The subject of the report. |
Keywords | The keywords of the report. |
![]() |
Figure 6.22 - Define the cover page |
![]() |
Figure 6.23 - HTML Report |
The Generate HTML dialog box provides a set of options for changing the report style. To display the dialog box, perform one of the following actions:
![]() |
Figure 6.24 - Generate HTML dialog |
Field | Description |
---|---|
Output path |
To select the destination file for the generated report. You can type in the path in the text field or you can browse the location by clicking on the ... button. |
Launch viewer | If this option is selected, the default browser of the system will be open automatically to show the generated report. |
Generate table of contents |
If this option is selected, table of contents for this document will be generated to the report. |
Generate table of figures | If this option is selected, table of figures for this document will be generated to the report. |
Generate diagrams | If this option is selected, the image of the selected diagrams will be generated to the report. |
Generate diagram properties | If this option is selected, the properties of the selected diagrams will be generated to the report. |
Generate diagram summary | If the option is selected, the summary of the selected diagrams will be generated to the report. |
Generate reference (file/URL) link |
Select to generate links for referenced files/URLs defined in models. |
Generate models/diagrams link |
Select to generate links for navigating to related models and diagrams. |
Copy reference files | Select to copy referenced files defined in models to the report output directory. |
Shape type style |
Icon - using Icon to represent the type of shape and diagram elements Text - using text to represent the type of shape and diagram elements |
Sort element by | Automatic - sorting elements by listing them in the most logical order, following most readers’ understanding of that kind of diagram Follow tree - sorting elements by following the sort order of the diagram tree in the tool id or name - sorting elements by their id or names You can refer to the section 'Sorting Elements in Report' near the bottom of this chapter. |
Details | |
Children |
Select to generate children of model. |
Members |
Select to generate members of model. |
Properties |
Select to generate properties of model. |
Relationships |
Select to generate relationships of model. |
References |
Select to generate references of model. |
Sub-diagrams |
Select to generate sub-diagrams of model. |
Tagged values |
Select to generate tagged values of model. |
Comments |
Select to generate comments of model. |
Anti-aliasing | |
Graphics | To enable/disable the graphic anti-aliasing of the diagram images. |
Text | To enable/disable the text anti-aliasing of the diagram images. |
Print Diagrams | To select which diagram will be generated in the report. |
![]() |
![]() |
Figure 6.25 - Generating HTML report | Figure 6.26 - The generated HTML report |
There are two image quality options for the HTML Report: graphics and text anti-aliasing. To enable/disable the anti-aliasing options, check/uncheck the anti-aliasing options checkbox. The below two images show the difference in graphics with anti-aliasing enabled (left) and graphics with anti-aliasing disabled (right).
![]() |
![]() |
Figure 6.27 - Images with anti-aliasing | Figure 6.28 - Images without anti-aliasing |
![]() |
Figure 6.29 - Set the Document Info |
Field | Description |
---|---|
Title | Specify the title of the HTML report. |
Author | Specify the author of the HTML report. |
Keywords | Specify the keywords meta-tag of the HTML report. |
![]() |
Figure 6.30 - Configure the front page |
![]() |
Figure 6.31 - Project Publisher |
![]() |
Figure 6.32 - Published project |
![]() |
Figure 6.33 - Diagram Navigator |
![]() |
Figure 6.34 - Model Navigator |
![]() |
Figure 6.35 - Class Navigator |
![]() |
Figure 6.36 - Menu Navigator |
![]() |
Figure 6.37 - The Diagram Content |
![]() |
Figure 6.38 - Shape link to the descriptions |
![]() |
Figure 6.39 - Jump to an element |
![]() |
Figure 6.40 - Back to top button |
![]() |
Figure 6.41 - Open Specification button |
![]() |
Figure 6.42 - Model list |
![]() |
Figure 6.43 - The Model Content |
The parent hierarchy is shown as a list of models on top of the page. You can click on a parent in the hierarchy to view its details.
![]() |
Figure 6.44 - Parent Hierarchy |
The summary of the relationships of the model is shown in the Relationships Summary section. Click on a relationship and it will take you to the Relationships Detail section.
![]() |
Figure 6.45 - Relationship summary |
Certain types of model have their own properties, for example, attributes and operations of class, or columns of ERD table. They are also included in the content page as custom sections. For instance, the Operations Overview and the Operations Detail sections show the overview and details of the operations of a class respectively.
![]() |
Figure 6.46 - Other Class details |
The Report Writer is a sophisticated tool for report creation. Users can output the existing project as reports by documenting their project within Agilian. Agilian offers seamless integration of UML modeling tool with word processors to provide a unified documenting environment. By dragging the models from Agilian to Report Writer, data is extracted from models and content is created in Report Writer.
Retaining the conformance between documentation and design is a tedious task. Report Writer maintains the consistency between them. If you create a new model, the content will be appended to the existing one. If you remove a model, the generated element will be removed. If you re-edit the models, the content will be refreshed.
Users can also apply their own style for the generated element, to the Report Writer more flexible.
If it is the first time you have started the Report Writer, the Report Engine Installation dialog box will be displayed asking for the installation of Report Engine.
![]() |
Figure 6.47 - Report Engine Installation Dialog |
Upon launching Report Writer for the first time, the Template dialog box will be displayed and ask for the information of the new report. Enter the report information and select a desired report theme for the report, preview of the selected theme is shown on the preview pane. Click OK to start Report Writer when everything is ready.
![]() |
Figure 6.48 - Templates Dialog |
When Report Writer is launched you are taken to the Report Writer environment where you can create and edit your reports. Three distinct panes are presented on the screen: the Project Explorer, Template Pane and the Writer Pane.
![]() |
Figure 6.49 - Report Writer |
The Diagram Navigator displays all diagrams within the project in a form of a project tree and organizes them by their diagram type. Through the use of a folding tree structure you can browse the names of these diagrams by either expanding or collapsing the folders and perform sorting by diagram type and name.
![]() |
Figure 6.50 - Diagram Navigator |
Button | Icon | Description |
---|---|---|
Collapse | ![]() |
To collapse all the nodes within the project tree. |
Expand | ![]() |
To expand all the nodes within the project tree. |
Show Diagram View | ![]() |
To show only diagrams but not models in the tree. |
Sort by Name | ![]() |
To sort diagrams within the project tree by alphabetical order of their names |
Sort by Type | ![]() |
To sort diagrams within the project tree by their diagram type. |
Move Selected Model Up | ![]() |
To move selected models upwards. |
Move Selected Model Down | ![]() |
To move selected models downwards. |
Refresh | ![]() |
To refresh the project tree within the Diagram Pane. |
The Model Pane displays models within the project in a form of a project tree. Notice that not all the model elements are displayed, and only the elements that are available for generating report content are shown.
![]() |
Figure 6.51 - Model Tree |
Button | Icon | Description |
---|---|---|
Collapse | ![]() |
To collapse all the nodes within the project tree. |
Expand | ![]() |
To expand all the nodes within the project tree. |
No Sorting | ![]() |
To display the models within the project without sorting. Ordering of models will be based on their order of creation. |
Sort by Name | ![]() |
To sort models within the project tree by alphabetical order of their names |
Sort by Type | ![]() |
To sort models within the project tree by their model type. |
Move Selected Model Up | ![]() |
To move the selected models upwards. |
Move Selected Model Down | ![]() |
To move the selected models downwards. |
Refresh | ![]() |
To refresh the project tree within the Model Pane. |
The Template Pane displays all the templates available for the model or diagram selected in Property Pane.
![]() |
Figure 6.52 - Template Pane |
Each template represents the corresponding report content of a particular model or diagram. By dragging a template into the Writer Pane, the report content will be printed on the report. There are three types of template: Text, Image and Table. Each of them has its own appearance in the report content.
Type | Icon | Description |
---|---|---|
Text | ![]() |
The generated element block is mainly composed of text. It is mainly used in the documentation template of elements. |
Image | ![]() |
The generated element block is mainly composed of images. It is used in the diagram template for UML Diagrams. |
Table | ![]() |
The generated element block is mainly composed of tables. Most of the content-related templates use this type of template. |
![]() |
Figure 6.53 - Writer Pane |
Icon | Button | Function |
---|---|---|
![]() |
New Report... | To create a new report. |
![]() |
Save Report | To save modified reports. |
![]() |
Import Report... | To import an external document (either an .sxw or a .doc file) as a report. |
![]() |
Export Report... | To export the current report as an .sxw or .doc file. |
![]() |
Export All Reports... | To export all the reports within the current project. |
![]() |
Update from Model | To update the content within the current report from the Agilian models. |
![]() |
Print Report... | To print the current report by supplying the printer name. |
![]() |
Undo | To undo the last action you performed. |
![]() |
Redo | To redo the last action you performed. |
![]() |
Select Report | To select a report from the current project for editing. |
![]() |
Remove Report... | To remove the existing report(s). |
![]() |
Click to Show Stylist | To display the stylist dialog box for modifying the style. |
![]() |
Copy Style to Current Report | To copy the style settings defined in another report. |
![]() |
Click to Show Bookmarks | To display bookmarks that outlines the boundary for each generated element. |
![]() |
Insert Hyperlink | To insert a hyperlink. |
![]() |
Click to Generate Model Documentation | To include documentation of model when generating content. |
![]() |
Close Report Dialog | To close Report Writer and go back to Agilian. |
The term "Generated element" here means a block of report content generated by Report Writer and consists of details of a particular diagram or model element.
To create a generated element block:![]() |
Figure 6.54 - Template Pane |
![]() |
Figure 6.55 - Drag the template from template pane and drop it onto report |
![]() |
![]() |
Figure 6.56 - Drag the template to report |
![]() |
The update process will replace ALL the contents within each generated element without notification. Therefore please insert the content carefully and ensure that it is not located inside the scope of any generated elements. |
![]() |
To create a new report, select from main menu Report > New Report...or click on the New Report...button on the toolbar. |
Creating a new generated element within the boundary of an existing one is dangerous because the content may be messed up during a report update process. To avoid this, you can display bookmarks to indicate the start and end position of each generated element, and to prevent dropping a new one within the scope of the existing generated element.
![]() |
Figure 6.57 - Showing bookmarks |
A style in Report Writer is a collection of formatting attributes that describe the nature of paragraphs. The generated element highly adopts the predefined styles in Report Writer therefore users can customize the related styles to bring consistency to the whole document. There are two ways for applying style to report.
The Stylist dialog box allows you to configure the pre-defined styles. To display the Stylist dialog box:
![]() |
Figure 6.58 - Stylist |
To edit the style, right-click on the highlighted style and choose Modify...from the popup menu. This displays the dialog box for the selected style. You can now adjust it with your own preference. When everything is ready, please click OK to commit the settings and exit the dialog.
![]() |
Figure 6.59 - Edit Paragraph Style |
![]() |
Figure 6.60 - Style Change |
![]() |
Figure 6.61 - Copy Style Dialog |
Select a desired report for getting the style configuration and click Copy Style. The style configuration in the current report is replaced by the style configuration of the selected report. All the predefined styles will be overwritten.
Level | Paragraph Style |
---|---|
0 | Heading 1 (VP) |
1 | Heading 2 (VP) |
2 | Heading 3 (VP) |
3 - 9 | None |
You can export report as file and edit it outside Agilian. Supported format includes Microsoft Word 97/2000/XP document (with extension .doc) and OpenOffice.org 1.0 Text Document (with extension .sxw).
![]() |
Figure 6.62 - Confirm overwrite existing report |
In reality, software design keeps evolving from time to time. Originally, users needed to modify the related documents manually to ensure that it is fully conformed to the latest design. Report Writer binds closely with the Agilian project, and hence generated elements can then be updated without affecting the user-defined content.
To update a report, choose the desired report for updating from the drop-down menu and click the Update from Model button from the toolbar or select Report > Update from Model from main menu.
Update process will start automatically. Data will be extracted from project and replace with the content within the existing generated element.
![]() |
Please do not click on the Writer Pane while the update process is undergoing, as it may affect the accuracy of the content. It can also damage the generated element, so that updating cannot be performed anymore unless the damaged block is removed manually. |
![]() |
The update process will replace ALL the contents within each generated element without notification. Therefore please insert your content wisely and ensure that it is not located inside the scope of any generated element. |
There are two ways for printing the reports. The first one is to print the currently opened report and another one is to print all the reports within the project. The following steps demonstrate how you can print reports in Report Writer.
![]() |
Do not click on the Writer Pane while the printing process is undergoing, it may affect the print job. |
Sorting out the elements in the report helps to prepare a report which is well-organized.
There are three ways of sorting in a report:
We will use a PDF report as an example.
To set the sorting option:
1. Select Tools > Report > Generate PDF Report... from the main menu.
![]() |
Figure 6.63 - Select Generate PDF Report... |
2. This shows the Generate PDF dialog box.
![]() |
Figure 6.64 - Generate PDF dialog box
|
3. Select how elements will be sorted from the Sort element by drop-down menu.
![]() |
Figure 6.65 - Select way of sorting |
4. Press the Generate button.
Different ways of sorting
The report generated is sorted by listing elements in the most logical order, following most users’ understanding of that kind of diagram.
![]() |
Figure 6.66 - Sorting by Automatic
|
The report generated is sorted by following the sort order of the Diagram Navigator in the tool.
![]() |
Figure 6.67 - Sort by Follow tree |
The report generated is sorted by name or ID of the element.
![]() |
Figure 6.68 - Sort by id or name
|
|
|