The report manifest file defines the reports and their characteristics.
The file is located at com.ibm.xtools.publish.uml2\resources\reports\reports.manifest.
ReportManifest
XML tag for a report.
name
Any text string used to name of the report. This
information is displayed in the Name field of the Generate
Report window.
description
Any text string that describes the report.
This information is displayed in the Description field
of the Generate Report window and on the HTML source
page of the report as the description of the link to the report.
author
Any text string for the author of the report.
xsltFile
The transform file to use to generate the
report. The predefined transform files are located in <install directory>/plugins/com.ibm.xtools.publish_uml2_x_y_z/resources/reports, where x_y_z is the version number of the this plugin.
oclSelfType
The UML type of the data to be selected.
This is an optional field, but if this is used, oclQuery is
required. Examples of UML types are Class or Package.
oclQuery
The Object Contraint Language (OCL) phrase
to use for data selection on elements of type oclSelfType.
This is an optional field, but if this is used, oclSelfType is
also required.
outFileExt
File extension of the generated file.
USING_ICONS
Boolean attribute indicating if icons are
to be included in diagrams.
EXTRACTING_DIAGRAMS
Boolean attributes indicating if
diagrams are to be created. If false, the diagram report is text only.
DIAGRAM_FORMAT
Format to use for the diagram files
created when EXTRACTING_DIAGRAMS is true. Valid values are GIF, BMP, JPG,
or JPEG.
DETAIL_LEVEL
The level of detail to include. Valid
values are FULL for everything or MIMINUM for documentation only.
Example
The following example shows the XML used to
define a Metrics report. All data elements are included since there are no
oclSelfType nor
oclQuery attributes.
The
USING_ICONS,
EXTRACTING_DIAGRAMS,
DIAGRAM_FORMAT,
and
DETAIL_LEVEL attributes are required, but are not used
for this type of report.
<reportManifest name="Sample Metric Report"
description="Sample metric report for the selected model"
author="IBM Rational"
xsltFile="resources/reports/MetricsReport.xsl"
outFileExt="pdf"
USING_ICONS="false"
EXTRACTING_DIAGRAMS="false"
DIAGRAM_FORMAT="JPG"
DETAIL_LEVEL="FULL">
</reportManifest>