Reporting > Native reporting system > How to edit or add a report > GUI editor > Add Report dialog
  
Add Report dialog
Note Unlike the Edit <report name> dialog, the name of the Add Report dialog does not reflect the name of any report since the report has yet to be named or saved as part of a report description file.
This dialog lets you choose the items that you want to report on: Diagrams, Symbols, or Definitions.
You can report on the properties of any of these objects, and on the relationships that exists between them (for relationships between objects, see Encyclopedia metamodel).
This graphic is described in the surrounding text.
Report Name
Type the name of the report. The report name appears at the top of the printed report page. The name displays in the report list at the center of the Reports dialog.
Report Type
See Selecting a report type.
Description
Type a brief description of the report. The description displays in the communication bar at the bottom of the Reports dialog.
Output file
See Output file.
Style sheet
See Style sheets for HTML reporting.
Current Diagram
Select this box to limit the scope of the report to the objects in the active diagram displayed in the System Architect workspace.
Clear this box to search the entire encyclopedia for the values that you choose.
When this box is selected, the following statement is added to the report specification:
WHERE Current = T
For more information, see WHERE command.
Use Inheritance
Select this box to report on the properties of objects that inherit those properties from another object because an “is a” relationship exists between them.
Level 1 reporting
Specify the starting class as either Diagram, Symbol, or Definition. You are limiting your search by this selection and you must go forward from this point in the encyclopedia to define additional relationship levels. Make sure that you are beginning your selection at the highest level necessary to collect the information you want.
The next level is made visible by using the scrollbar. Further levels are made available as you pick a class for that level, up to the maximum supported.
Level 2 reporting
Specify the next encyclopedia level from which you want to gather information. Remember, you must go forward to define additional relationship levels. Your selections on this level are governed by the level one selection.
Level 3 reporting
Specify the next encyclopedia level from which you want to gather information. Remember, you must go forward to define additional relationship levels. Your selections on this level are governed by the level one and level two selections.
Note You can specify more selection levels. Each report is limited to a maximum of nine levels.
Screen draft/Raw data
See Selecting a report type.
Page Setup
Open the Page Setup dialog.
Draft/Generate
Display a preview of the report in a draft format without sending it to the printer.
The preview displays the report text in a default COURIER font. This means some columns might overlap in the draft preview, while printing out properly, due to possible font spacing differences.
Class
Class is a database field, specified as either Diagram, Symbol or Definition.
Start from the right place in the database, since the time required to run the report is directly related to the number of records that are read. It is often useful to include an extra level of extraction criteria in the start of the report, even if nothing is printed at that level. For an example of a report that uses this extra level, see Example: Using extraction specification levels.
If a text editor is used to write the report, the class can also be specified as the Class Number; the number which indicates a diagram (Class Number = 1), a symbol (Class Number = 2), or a definition (Class Number = 3).
See also Relations between objects.
Properties to Print
Opens the Select <class> Properties to Print dialog.
Print
Opens the Print <report name> dialog (see Choices for printing a report) where you direct the formatted report output to the printer or to a designated file.
Related topics
Edit <report name> dialog
Editing and adding a report
Using the Text Editor to edit or add a report
Parent topic
GUI editor