Topics
Prev Next

Report Constants

The Document Editor (for generated report templates) provides a set of fields that represent data on the report itself, such as the report name, title, generation date, version, author and status. When the report is generated, each field is replaced by the current value of the data item. These are called report constants.

You can insert a report constant anywhere in your template - in text, in headers or footers, or in cover page material. They are particularly suited for cover pages.

Constants

Constant

Replaced by

See also

ReportClipboard

The image currently held on the clipboard.

ReportAuthor

The Enterprise Architect login ID of the user who is generating the report.

ReportStatus

(For a report generated on a root Package) The status of the Package, from the Package Properties.

(For a report generated on a single element) The status of the element, from the element Properties.

Otherwise, the constant remains empty.

ReportName

(For a report generated on a root Package) The name of the Package, from the Package Properties.

(For a report generated on a single element) The name of the element, from the element Properties.

Otherwise, the constant remains empty.

ReportAlias

(For a report generated on a root Package) The Alias of the Package, from the Package Properties.

(For a report generated on a single element) The Alias of the element, from the element Properties.

Otherwise, the constant remains empty.

ReportVersion

(For a report generated on a root Package) The version of the Package, from the Package Properties.

(For a report generated on a single element) The version of the element, from the element Properties.

Otherwise, the constant remains empty.

ReportDateLong

The system-generated date in long format.

ReportDateShort

The system-generated date in short format.

ReportFilename

The file name of the generated report, as recorded on the 'Generate Documentation' dialog.

ReportFilenameShort

The current filename of the generated report. (Will change if the file is renamed on disk.)

ReportTitle

The name of the template used to generate the report, as selected on the 'Generate Documentation' dialog.

ReportSource

The name of the Repository that was used to generate the document.

For file-based repositories, this will be the file path and name of the project file.

For DBMSs this will be the name of the database used.

Insert a Report Constant

Right-click on the point in the template to insert the data field and select the 'Report Constants | <field name>' option.