Generating RTF and HTML Model Reports

From ER/Studio Data Architect
Jump to: navigation, search

Go Up to Using ER/Studio Data Architect

One of ER/Studio Data Architect's most powerful applications is that of a documentation generator to communicate complex databases and associated metadata to the Enterprise. ER/Studio Data Architect is equipped with extensive report generation capabilities:

  • HTML Report Generation: Instantaneous generation of an HTML-based Web site designed to provide simple navigability through data models and model metadata using standard browsers such as Microsoft's Internet Explorer or Netscape Navigator.
  • RTF Report Generation: Instantaneous documentation generation compatible with applications like Microsoft Word.
  • In addition to providing model reviewers with reports, you can also make the model available so reviewers using ER/Studio Viewer or ER/Studio Team Server can see the actual model, but not make any changes to it.

The ER/Studio Data Architect Report Wizard guides you through the process of creating rich text format (RTF) and HTML reports based on your logical or physical models. The ER/Studio Data Architect Report Wizard lets you generate RTF and HTML reports. Due to the formatting differences between RTF reports and HTML reports, the information is presented in slightly different ways, even though the data, with few exceptions, is the same for both formats. Differences in the type of information reported is noted for each format type in the pages that have specific information about each object type's reports.

Why Use RTF Reports?

RTF reports are suitable for hard copy distribution. You can view the RTF-formatted reports using almost any popular word processing application.

You can select the object types to include in the report (such as entities, relationships, etc.) You can also select the amount of information about each object type to include in the report such as the summary of all instances of each object type, and/or detailed information about each object instance.

RTF reports include a title page, followed by a table of contents, followed by the reports. In general, and subject to the selections made for information that should be included in the report, each object type such as entity, relationship, etc. is introduced in a summary report that gives general information about each instance of each object type, followed by detailed reports for each instance of an object type. Much of the information in the report is presented in easy-to-read tables.

Why Use HTML Reports?

HTML reports are suitable for sharing on the internet or local Intranet. The reports require a browser that supports frames (and has them enabled). You can include a JPG, GIF, or BMP image of the submodels in your report and you can set the zoom level for each submodel individually.

Reports generated in HTML format have a similar feel to web pages. The title page is opened when the report is open. At the top of the title page and at the top of all pages in the report is a list that lets you select an object type's report page. The list includes only those object types that have a report page. If there is no information reported about a particular diagram object type, it is not included in the list. The report page for each object type has a list in a left-hand pane that provides links to specific instances of an object type. Information is presented in easy-to-read tables.

See Also