GWME-7.2.1-11 GroundWork Iframe Portlet Display Issue Repair Patch

Contents
Description

This updated update is for all GroundWork customers running 7.2.1 or 7.2.2 software and desiring to use the new GroundWork Iframe Portlet in complex ways.

What is in this update?

This Technical Bulletin provides a documented and scripted method of applying the changes addressed in http://jira/browse/GWMON-13506 for issues related to writing the client side page. There are two issues described here.

The error message

Invalid Input
The target blockeID to update is not found: UIMask Workspace

at the bottom of the screen is transient, it disappears once the page is loaded. There may be issues with loading if the refresh interval is smaller than the time required to load a very big dashboard (Grafana dashboards are popular).

However, what the error message is indicating is that the top-level portal decoration content, (including the banner and menu bar), is no longer displayed. This has been confirmed visually. While true, it is also evident that the page URL is unchanged. Refreshing the page brings the portal back.

Just before the message above is rendered, a "Loading" alert interstitial dialog is displayed. It was not immediately clear where this alert was originating. One thing worth noting is that the IFrame content is fairly heavy and might indeed be taking time to render.

Issue One To repair, a new portal-groundwork-base.war renders IFrame using innerHTML instead of previous method document.write(). Document.write can replace the entire document if executed after page is loaded. This explains what the customer might see: likely it is a client-side timing/race issue.

Issue Two To repair, the "Loading..." alert dialog issue follows timeouts on busy connections/servers for portal ajax calls made when selecting tabs/panels on pages where these are defined. The new patched portal.war file to be installed in the /usr/local/groundwork/jpp/gatein/gatein.ear directory suppresses the alert for these calls to the server. Modifications were made to iframe.jsp. Other portlets that rely on this code have been screened and found to perform as before the change.

Prerequisites
To use the new GroundWork Iframe Portlet, which is not a choice in the basic install, you must do these steps independently of the patch:
  1. Log in to the portal as the Portal Administrator Account
  2. Navigate to Group => Portal Administration => Application Registry
  3. Choose Import Applications

Once those steps are done you can create pages (covered elsewhere in documentation) using the GroundWork Iframe Portlet.

Installation Steps
There are currently no attachments on this page.
  1. As the root user, copy the attached tarball to an empty directory on the GW server already in place.
  2. Unpack the tarball using the command:
    tar xf TB7.2.1-11-gw-iframe-fix.tgz
    
  3. Change into the directory created by untarring:
    cd TB7.2.1-11-gw-iframe-fix
    
  4. Run the installer script:
    ./TB7.2.1-11_install.sh
    

    The install script will test that you are on a 7.2.1 or 7.2.2 system (which is required), that you have not already installed this patch, and that you want to go ahead.

  5. Respond to the install-confirmation prompt when it appears.
  6. New files will be copied into place. Monitoring in general can continue while this patch is installed; there is a momentary restart of the web service which may terminate some user sessions.
Usage

Once this is installed you will be able to use the GWOS Iframe Portlet for complex dashboards without issues.

Uninstalling

Reversal of this patch will remove the changes made to the GW server by restoring the previously backup up files. This will ensure that changes unrelated to this patch will remain undisturbed.

  1. As the root user, navigate to the patch-unpack directory you created when installing the patch, (if that directory no longer exists, first unpack the patch again).
    cd TB7.2.1-11-gw-iframe-fix
    
  2. Run the uninstall command:
    ./TB7.2.1-11_uninstall.sh