Ant syntax for UML report generation with BIRT report designs
Refer to the following information when you are specifying
parameters in the custom script for generating UML reports with Business
Intelligence and Reporting Tools (BIRT) report designs, com.ibm.ccl.erf.rsa.report.ic.ant.UMLBirtReportPublish.
Note:
The script includes the following attributes:- If an attribute is optional, you can specify it or not. If you do not specify the attribute, the default value is assumed. A required attribute must have a valid value for the task to work.
- Write all paths as fully qualified paths, as in these examples: /root/myoutput/myModelProject1 (Linux) or c:\output\myModelProject1 (Windows).
- modelPath
- Required. Specify the fully qualified path of the model to publish.
- To find the fully qualified path, right-click the model in the Project Explorer view; and click Properties.
- targetOutputFolder
- Required. Specify the fully qualified path of the location to send the report. The folder must be accessible before you run the script.
- targetOutputFile
- Required. Specify the output name of the report, for example, myReport.
- reportDesignFile
- Required. Specify a valid URL path to a .rptdesign file.
- To find the fully qualified path, right-click the report design in the Report Explorer view; then click Properties. To register a report design in the Report Explorer view, see the topic "Registering RPTDESIGN report designs."
- overwriteExisting
- Optional. Specify whether the contents of the output directory should be deleted before a report is generated to this directory. The values are true (the default) and false.
- autoShowPublishedOutput
- Optional. Specify whether to display the report automatically after it generates.
- The values are true and false (default).
- errorHandling
- Optional. Specify how to handle errors. The values are ignore (the default), which ignores any errors that might occur and continue processing, and abort, which stops processing immediately and exits the task.
- outputType
- Optional. Specify the output format of the report. The values are html (default), pdf, doc, ppt, xls, and ps. The doc format is compatible with Microsoft Word 2003 and above.
- transform
- Optional. If the specified report design requires a transformation, enter the ID of the transformation.
- Note: For transformation IDs, see the topic called "Installed Transformations."
Note: Some information, such as links to Eclipse
documentation or to developer guides, is available only from the help
topics that are installed with the product.