Created On: 30 March 2011
Problem:
I would like to customize the EnterpriseLink error messages so they have the same look and feel as the rest of my application.
Resolution:
EnterpriseLink Server will generate warning and error messages under various circumstances. The messages may vary from "Out of EnterpriseLink User Licenses" to "EnterpriseLink is still working on your request." You can alter the web pages that appear under these circumstances. This document describes how this is done.
Overview
EnterpriseLink server will generate error messages under certain circumstances, similar to the way a web server will generate messages such as "page not found" if you specify a URL for which no page exists. Just like in web servers, the EnterpriseLink Server error message web pages can be customized.
The error message web pages exist outside of the projects. They are global files that affect all projects on that server. If you have your EnterpriseLink Server arranged in a cluster of nodes, ensure that all of the error messages files are in sync on all nodes.
You can create these error message files with any tool such as a text editor or HoTMetaL that can be used to generate HTML web pages.
You can even use EnterpriseLink Builder to generate these static web pages and use Export to HTML menu item under the File menu. These are static pages, created with the New Page menu under the File menu. These pages are not associated with any host screen (unless you want a similar page to come up under specific responses from the host.) When exported these will have the same background colors, graphics and styles as the rest of your application web pages. You can store these pages in the EnterpriseLink Repository. Using EnterpriseLink Builder to generate them is a good idea because it will give a constant look and feel to your web pages.
Message File Location
The standard EnterpriseLink installer places the error message directory under the EnterpriseLink installation directory. The directory is named "errors" and contains a number of HTML files. This directory does not need to be identified as a "virtual directory" to your web server. EnterpriseLink Server will read in these files and generate them directly to the user.
You can internationalize your error messages. Directories under the "errors" directory indicate the 3-character ISO language and sub-language code. If the language and sub-language in use on your server is not found as a subdirectory the error message files are taken from directly under the "errors" directory. Should it not be possible for EnterpriseLink Server to read in these files at run-time, it will revert back to the old-style of messaging: Generating a web page with the message on a blank background.
Error message files are named "00001.html" for error message 00001, for example.
When customizing your error messages you can include the string %%SSURL anywhere on the web page. This is replaced with the web address that caused the error. Often clicking on a hyperlink to this URL will return the user to the last correct web page. The URL often is used in a hyperlink:
Click here to return to the latest page.
Note: You should back up your customized error message files before installing a new version or updating your copy of EnterpriseLink. Error messages are subject to change from release to release and the install/update process might override your customized error message files.
Old KB# 33821
#EnterpriseLink
#Rumba
#SupportTip