Reporting

Ribbon

Select the element in the Specification Manager, and the 'Specification - Specify > Element > Documentation' option, then the required submenu option:

• Generate Documentation (DOCX/PDF/RTF)
• Publish as HTML
• Publish as Joomla! Article
• CSV Import/Export
• QA Reports and Metrics
• Spell Check Current Package

Generate documentation in report document format

Enterprise Architect provides a comprehensive report generation facility, through which you can create a range of reports on different aspects of your model. You can apply this facility to the elements of a Specification Package, to generate a report in any of these formats:

• DOCX
• PDF
• RTF

Select the 'Generate Documentation (DOCX/PDF/RTF)' option.

The 'Generate Documentation' dialog displays, with the 'Element' field set to 'Selected Elements' as the target contents of the report, and the 'Template' field set to 'Specification Manager List'.  The output file extension determines the output format of the document.

Generate documentation in web page format (HTML)

As you develop the Specification Package elements you can publish them on the web, where the outline structure closely mirrors the Package structure and makes it very simple to explore on-line. You export the Package to web pages, where the web report provides an easy to use, highly detailed, JavaScript-based structure. In addition, any hyperlinks in the elements make browsing to related information very simple.

Select the 'Publish as HTML' option.

The 'Publish as HTML' dialog displays, with the Specification Package name in the 'Package' and 'Title' fields.

Generate documentation as a Joomla! Article

An Enterprise Architect Package can be published as an Article (HTML page) in a local Joomla! installation, using the 'Publish as Joomla! Article' dialog. All child Packages of the selected Package will be automatically included for publishing.

Select the 'Publish as Joomla! Article' option.

The 'Publish as Joomla! Article dialog displays, with the Specification Package name in the 'Package' field.

Generate spreadsheet file (CSV) and import from a spreadsheet

In Enterprise Architect you can import data from a spreadsheet into a Package and export element data from a Package into a .csv file.

You can perform both of these operations within the Specification Manager, to bring in an existing set of element definitions to the Specification Package or transfer the Enterprise Architect element definitions to a different location.

Select the 'CSV Import/Export' option.

As part of either operation, you need to create a CSV Specification file.

Whilst your display might be filtered to show a specific type of element, the operations work on the Package itself and incorporate all types of element within the Package.

After you perform an import, refresh the display (press F5) to show the imported elements.

Generate Quality Assurance reports and Metrics

Enterprise Architect provides several Quality Assurance reports for checking the development and impact of development of the elements in a Package. You can access these within the Specification Manager, so that the Specification Package is automatically the target of the report.

You can also view and adjust the metrics report should you want to monitor the impact on the project metrics of the work that the elements in the specification might entail.

Spell-check the Package

Before generating and/or printing any information from the Specification Manager, you could run the system Spell Checker over the Specification Package to remove any errors that might exist in the element names and text.

Select the 'Spell Check Current Package' option to display the 'Spell Check: <Package Name>' dialog, and click on the Start button.