Adding a New Report

7 min

How to add a new report

If you have created a new report you will need to add it to the Repository to make it accessible in the viewer, as described below.

If you amend one of the Essential Views we recommend that you rename it and add a new report so that, in the case where we update it, you do not lose your changes.

Navigate to Capture > EA Support >Essential Viewer >Report, create a new report and add the following slots:

  • Name – note this is an internal name, not the one that will show in the portal
  • Description – this will show in the report in the portal
  • Report XSL Filename – this is the route to a view, for any new view you create this should be user/[the_filename_of_your_view].xsl
  • Report Label – this will be the name shown in the portal
  • Enabled on homepage? – this will show the report if ticked
  • Report Screenshot Filename – this is the path to the screenshot that will be shown on the report in the portal, put this in user/images/[your_image_filename.png/gif/jpg]
  • History Label Prefix – used in the History tab for clarity.


Note: Default Qualifying Report is important but see below for more detail


For summaries, e.g. Application Summary, Essential needs to know what instance you are interested in viewing, e.g. show me the summary for the Essential application. We use the catalogues as a way of allowing you to select an instance to see a summary of. The figure below shows the pattern, i.e. a report points to a summary via a catalogue.

Np86nzhavtaz8gevk1jiq Cataloguesforsummary

This is where we use the Default Qualifying Report slot. We specify the summary as our report, but we add a catalogue as our Default Qualifying Report. So for an application summary, we would use our Core: Application Provider Catalogue by Name or Core: Application Provider Catalogue as Table as the qualifying report.

Classifying a Report for the View Library

If you want your report to appear in the View Library, you need to assign it a classification, we do this via the ‘Classified As’ slot where you can associate a Report Classification Taxonomy Term with the report. You can choose:

  • Report Classification::Enterprise Architecture Views
  • Report Classification::Business Architecture Views
  • Report Classification::Application Architecture Views
  • Report Classification::Information Architecture Views
  • Report Classification::Application Architecture Views
  • Report Classification::Technology Architecture Views
  • Report Classification::Support Views
  • Report Classification::Catalogue Views

When you look at the View Library, you will see the report in that section of the View Library.

Assigning a Report to a Portal

To assign a report to a portal you need to start at Portal Configuration

Qn Gybhfufhzs7e741kvl Portalconfig

  1. If you need to create a new portal, select Portal and click new. Name the portal and assign/create any panels you want.
  2. Now create your Portal Sections, add a new portal section in the Portal Sections slot of the Portal:
    • Assign a sequence number for where you want the portal section to appear against other sections
    • Assign the section a label, which will appear at the top of the section
    • Now add the reports in the Portal Section Reports slot.
      • Click New, this will open relationship class that ties the report to the portal (we use a relation class as you can then add a report to multiple portals)
      • Select the report you want to show

To update the Menu Items on the views, go to Capture, EA Support/Essential Viewer/Menu
Management/Report Menu Item. This lists all the views that appear in a menu, and you can uncheck the Enabled box to switch them off. This will remove them from all menus.

Publish to Make Changes Take Effect

When you have finished configuring your portals:

Essential Cloud

  • Go to the Publish tab and publish to the relevant viewer

Essential Open Source

  • Use the Essential Architecture Reporting tab in Protege to publish the repository to Essential Viewer.

Updated 23 November 2023

Contact Us