Configuration Options - Database Configuration Configuration Options - Command Line Options

Configuration Options - Report Configuration

Veduta reports can be configured by modifying template files. The template files contain standard HTML and processing instructions. The HTML and processing instructions can be changed to produce a wide variety of reports and allow seamless integration with an enterprise's existing reports.

The Veduta Report Templates

Note: Veduta uses Apache Velocity to generate the reports from template files. A discussion of how Apache Velocity works is outside the scope of this document - however the Velocity documentation will provide more info for those who are interested.
The Veduta report templates are located in the installation subdirectory templates\velocity\.

The following subdirectories specify the format, and then the style chosen in the report.xml. An example will make this clear.

If the report.xml specifies a format thus: 

    <format style="release/imgs">html</format>
the template files can be found in the directory templates\velocity\html\release\imgs.

The template files have the suffix .vm. Currently only file is used - report.vm.

Note: Currently Veduta only supports the HTML format. Planned formats include XHTML, SVG and XML

Changing The Templates

The template files consist of the native format (in this case HTML) intermixed with processing instructions. The processing instructions are used by Veduta to insert report content (for example: the images, the graphs, the report names and descriptions) and can be edited with care. Processing instructions are preceeded by # symbols. For example: 
  <body class="body">
  #foreach ($report in $reports.getReports())
    <table>
    ...
    </table>
  #end
  ...
  </body>
The HTML native format can be easily changed to modify layout, colours etc. Common changes include inserting an enterprise's standard logos, stylesheets, logos and contact details as appropriate.

Note that Veduta should be stopped and started again for the template changes to take effect. Old reports will be automatically regenerated as Veduta reads the log data back in.

Creating New Templates

Creating new templates is straightforward. The following steps should be followed:
  1. Create a new directory under templates\velocity\html\ with a new style name.
  2. Copy an existing report template there, and modify appropriately.
  3. Modify the format setting in report.xml to reflect this change.
For example, if your new report style is called myStyle, then create a new directory templates\velocity\html\myStyle, copy a report.vm there, modify it, and reference it in your report configuration as: 
    <format style="myStyle">html</format>
Configuration Options - Database Configuration Configuration Options - Command Line Options