|
|
 Application Dependency Discovery Manager
|
Home > Reports > Report Best Practices
Report Best Practices
To learn more about the TADDM Sensors and Reports Community and how you can contribute, click here . This is a Community page, and anyone can contribute. Sign in in to the wiki and begin contributing to the TADDM Sensors and Reports Community.
This page includes best practices for creating BIRT reports.
Checklist for report authors
Review the following checklist before creating a BIRT report:
- Ensure that the name of the data source for your report is "TADDM Data Source". This is important for running the reports in the TADDM Domain Manager, since the JDBC parameters may not be correctly overwritten otherwise.
- Verify that all report strings are added to a .properties file. All report strings will eventually be globalized. Therefore, they should be added to a .properties file, rather than directly to the report, for ease of globalization.
- Verify that all SQL statements use the generated TADDM views, not the TADDM tables. Views have been added to the TADDM database as a buffer, to protect consumers from changes to the database tables. Reports written using the TADDM database should also use these views, so that changes to the tables do not cause the reports to stop functioning.
- Unit test the report. Run the report against a populated TADDM database. Ensure that the report launches and displays data properly. Compare the new report against existing reports on the Domain Manager, if any existing reports have a similar format.
- Test on TCR. Perform basic unit testing of the report in a TCR server.
- Test the report's performance. Run the report against a large database (if available) to test its performance with large data sets.
- Reports should not contain open source. If you find a need to include open source, please click here and provide your feedback.
- Export the data from your report as an XLS file. Ensure that the data are accurate and can be properly sorted. If the data cannot be sorted due to the formatting of the report, you should also produce a "data-only" view of your report. Basically, create a completely non-formatted (but otherwise identical) version of your report. Add a link from your formatted report to your data-only view, such that clicking the link will launch the data-only view.
- Provide a verbose description of your report so others in the community browsing your report description can understand the value this report will bring to them if they download it.
Special considerations for authors who work for IBM
IBMers who wish to contribute Reports need to follow a few Constraints & Additional Steps
Links
The following links provide additional information for creating BIRT reports:
|
|
|
|
