Once you've created or downloaded a new Essential Architecture Manager Report, to get it into Essential Viewer, you must create a definition for the Report. This tutorial describes how to manage the Reports in your installation of Essential Viewer.

Each Report that is available in Essential Viewer is controlled from within the modelling environment, in the Essential Architecture Manager repository. Report Classifications can be added or removed from Essential Viewer by adding and removing 'Report' instances in the repository.

Essential Viewer Section of the Meta Model

Open Protege and open the Essential Architecture Manager project to browse your repository. Expand the EA Class class of the meta model, and then expand EA Support. In here, at the bottom of the list, you will find the class Essential Viewer. This is where the structure and content of Essential Viewer is controlled.

Define a New Report

Create a new instance in the Instance Browser, using the button, to define a new Report. Give it a meaningful name so that you can easily identify it in the repository. See the following section to learn more about the fields that are used to control the Report Classification.

Edit an Existing Report

The Report is managed using the following attributes:

• Name - the internal name of this Report, as described in the section above.
• Description - Short description of the purpose of the Report.
• Report Label - the label that is used for this Report as it appears in Essential Viewer, e.g. on the report list.
• Report XSL Filename - the name of the XSL file that is the entry point for the new report. Ensure that Unix-style directory separators are used and the Java runtime system will translate them as appropriate for your Essential Viewer platform. It is common for this XSL file to involve other XSL files 'under the covers'.
• Report Parameter1 - an optional input parameter for your report. This enables you to select a specific instance in the repository as the parameter for the report, e.g., the Strategic Logical Business Operating Model report needs the 'root' Business Role to be defined here.

Hide a Report

Any report can be easily hidden by unlinking it from the Report Groups or Report Classifications. You can use the button in the Instance Browser to find all the Report Groups and Report Classifications that refer to the report. From each Report Group and Classification, use the button to remove the report from the lists of contained reports.

Add a Hidden Report

A hidden Report can be re-introduced into Essential Viewer by adding it to the list of contained reports in the appropriate Report Group and Report Classifications, using the button.

Remove a Report

A Report definition can be completely removed from the Essential Viewer by deleting the Report instance from the Instance Browser, using the button. This will NOT remove the corresponding XSL (and any associated) files from the Essential Viewer web application.

Publish to Make Changes Take Effect

When you have finished managing your Reports, use the Essential Architecture Reporting tab in Protege to publish the repository to Essential Viewer.