Sponsor Link: EAS Training - Get training in the Essential toolset. Register your interest now. Read more
     
Home Reporting Managing Report Classifications
Managing Report Classifications PDF Print E-mail

Report Classifications in Essential Viewer group analysis reports within a report list, e.g. by architectural layer, and are used by each Report Group to present the list of reports available in that group. This tutorial describes how to manage the Report Classifications in your installation of Essential Viewer.

Report List screenshotThe 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 Classifications can be added or removed from Essential Viewer by adding and removing 'Report Classification' 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 Classification

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

Report Classification Definition screenshotThe Report Classification is managed using the following attributes:

  • Name - the internal name of this Report Classification, as described in the section above.
  • Description - Short description of the purpose of the Report Classification.
  • Report Classification Label - the label that is used for this Report Classification as it appears in Essential Viewer, e.g. on the report list.
  • Report Classification Sequence Number - the position in which this classification should appear in the report list page.
  • Report Classification Colour - an HTML hexadecimal colour, e.g. #909090, used for the table and fonts for the reports in this classification in the report list.
  • Report Classification Introduction Text - a longer description of the Report Classification to introduce it. This appears at the top of each section of the report list.
  • Report Classification Contained Reports - the set of reports that are members of this Report Classification and will appear in the list. Use the link_instance to add reports to this group, unlink_instance to remove reports from the group and new_instance to create a new report definition that is in this group.

 

Remove a Report Classification

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

This will remove the Report Classification from the repository. If you are uncertain about removing this report classification, we recommend that you back up your repository (e.g. File -> Save Project As...) before proceeding

Publish to Make Changes Take Effect

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

 

 
Related Articles