Report Groups in Essential Viewer provide the top level grouping of analysis reports that is used on the homepage. This tutorial describes how to manage the Report Groups in your installation of Essential Viewer.

The structure and content of the analysis reports that are available in Essential Viewer are controlled from within the modelling environment, in the Essential Architecture Manager repository. Report Groups can be added or removed from Essential Viewer by adding and removing 'Report Group' 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.

Create a New Report Group

Create a new instance in the Instance Browser, using the button, to define a new Report Group. 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 Group.

Edit an Existing Report Group

The Report Group is managed using the following attributes:

• Name - the internal name of this Report Group, as described in the section above.
• Description - Short description of the purpose of the Report Group. This is used on the homepage.
• Report Group Label - the label that is used for this Report Group as it appears in Essential Viewer, e.g. on the homepage.
• Report Group Introduction Text - a longer description of the Report Group to introduce it. This appears at the top of Report List page that is shown when a Report Group is selected from the homepage.
  
• Report Group Image File - the image that is used on the homepage. The file must be available in the WebContent/images directory of the Essential Viewer deployment.
• Report Group Contained Reports - the set of reports that are members of this Report Group. Use the to add reports to this group, to remove reports from the group and to create a new report definition that is in this group.

Remove a Report Group

A Report Group can be removed from the Essential Viewer by deleting the Report Group instance from the Instance Browser, using the button.

Publish to Make Changes Take Effect

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