Overview of EGL Rich UI deployment

In relation to EGL Rich UI, the word deploy refers primarily to the creation of an HTML file that embeds previously generated JavaScript™ output. You specify the details needed for deployment by configuring the EGL deployment descriptor, as described in Adding Rich UI deployment entries in the EGL deployment descriptor.

Here is additional detail on the process:
  1. The EGL generator creates the following two outputs for each handler or library: a JavaScript™ file, and a deployment file that lists all of the parts referenced by the part being generated.
  2. The deployment files specify what JavaScript™ files are included in the HTML file. After adding the JavaScript™ files, this step can add the HTML file to the target project.
In the target project is configured for IBM® WebSphere® Application Server, the following statements apply:
  • The EGL deployment step writes the generated HTML file and all supporting files (such as graphics and properties files) to the WebContent folder of the web project. The supporting files include graphics and properties files, and the EGL Rich UI Proxy. The files in the WebContent folder can be incorporated into a WAR file for installation on a web server.

    For details about the EGL Rich UI Proxy, see Service access in Rich UI.

  • The deployment step also writes content to an Enterprise Application project, which is installable as an Enterprise Archive (EAR) file. The EAR file acts as a container for the WAR file.
In the target project is configured for Apache Tomcat, the following statements apply:
  • The EGL deployment step writes the generated HTML file and all supporting files (such as graphics and properties files) to the WebContent folder of a web project. The supporting files include graphics and properties files, and the EGL Rich UI Proxy. The files in the WebContent folder can be incorporated into a WAR file for installation on a web server.

    For details about the EGL Rich UI Proxy, see Service access in Rich UI.

  • An Enterprise Archive (EAR) file is not provided for Apache Tomcat because that web server does not support the use of EAR files.
  • If you have a package named services, ensure that the package does not include Rich UI handlers, images, or any content other than services. The reason for this restriction is an Apache Tomcat naming convention: the application server accesses only the services in the WebContent/services folder. For example, if an image is in that folder, the image will not be displayed in the browser because Apache Tomcat will not serve it.

In each case, EGL deployment supports globalization, as noted in Use of properties files for displayable text. When you specify a name for the HTML file, the deployment adds locale detail to the name, along with the file extension .html. For example, if you specify myFile.htm and request an output that uses runtime messages in American English, the deployment step creates the file named myFile.htm-en_US.html.

EGL compresses the application to reduce the size of generated HTML files during deployment and uses gzip to compress the files the server sends to the browser.