This article provides help and troubleshooting advice for resolving errors reported by Essential Viewer.

File Not Found Errors

Errors that report that a View Template (XSL Template) file cannot be found are raised when a View Template cannot be loaded by Essentia Viewer.

Resolution

Check that the definition of the XSL Filename Path in the relevant Report instance in the Essential Modeller environment includes the folder that the View is deployed to, e.g. 'common', 'application', 'technology'. Additionally, check that the folder path uses the internet and Unix-style folder separator, '/' and does not include Windows-style '\' characters.

Confirm that the requested View Template XSL file is available in the required location. Explore the 'essential_viewer' webapp folder in your Java Web Application Server, e.g. Apache Tomcat, to find the relevant XSL file, which should have a '.xsl' suffix.

Where the file not found concerns an XML document, e.g. reportXML.xml, check that the reportXML.xml file is not empty. This file should be located in the 'essential_viewer' webapp folder in your Java Web Application Server. If reportXML.xml is empty, re-publish the repository snapshot from the Essential Modeller environment using the Essential Architecture Reporting Tab.

Invalid Characters

Characters that are not valid for XML processing or HTML rendering can find their way into the reportXML.xml, e.g. Microsoft Office smart-quotes that have been imported via a spreadsheet, or copy-and-pasted from earlier versions of Microsoft Office applications into Protege form fields.

Resolution

Any invalid characters must be removed from the reportXML.xml document to resolve this error. Ideally, the characters should be identified in the Essential Repository and removed from the modelling environment. Exploring the reported area of the reportXML.xml document will help to identify the instance that needs to be updated. Alternatively, a script is available from the Essential Project Team to be run in the Protege Script Console Tab that will identify and repair instances that have invalid characters in their fields.

MalformedURLException

Essential Viewer may report a MalformedURLException when attempting to load the requested View Template. This is often caused by either the use of Windows-style folder / directory separators ('\') in the definition of the location of a View Template XSL file, e.g. in the Report XSL Filename field of a Report instance in the modelling environment. In addition, unusual characters in the full path to the requested XSL file can also cause this exception to be raised, e.g. directories or folders with characters such as '[' or ']'.

Resolution

This error is resolved by ensuring that internet or Unix-style folder separator characters ('/') are used in the specifications of the location of the View Template XSL files, replacing any Windows-style separators ('\'). If this is not the cause, ensure that the full path of your Java Web Application and the location of the Essential Viewer webapp folder (e.g. C:/Program Files/Apache Software Foundation/apache-tomcat-6/webapps/essential_viewer) does not contain any unusual or invalid characters.