EPM Architect Help Topic not Available in Workspace After EPMA Patch 11.1.1.3.03 Installation

EPM Architect Help Topic not Available in Workspace After EPMA Patch 11.1.1.3.03 Installation [ID 1187735.1]

		Modified 07-SEP-2010 Type PROBLEM Status PUBLISHED

In this Document
  Symptoms
  Changes
  Cause
  Solution
     Solution I
     Solution II

Applies to:

Hyperion Planning - Version: 11.1.1.3.00 and later [Release: 11.1 and later ]
Information in this document applies to any platform.

Symptoms

Accessing the EPMA help menu in Workspace generates the following error:



HTTP Status 404 - /awb/docs/en/epm_architect/epma_datasource_wizard.html



--------------------------------------------------------------------------------



type Status report



message /awb/docs/en/epm_architect/epma_datasource_wizard.html



description The requested resource (/awb/docs/en/epm_architect/epma_datasource_wizard.html) is not available.

Confirm by navigating to:

%HYPERION_HOME%\deployments\Tomcat5\EPMAWebServer\webapps\awb\docs

The English files are not present (although German, Spanish, French etc are). English help files have not been deployed by the configuration utility.

Changes

EPM Architect was upgraded from 11.1.1.3 to 11.1.1.3.03

Cause

The patch replaces the .war files (awb.war and DataSync.war) in:

%HYPERION_HOME%\products\Foundation\BPMA\AppServer\InstallableApps

However, the newly installed awb.war is missing the Docs\en directory which contains all the English documentation for EPMA.

Solution

It is possible to extract the documentation from the previous version of the awb.war file that was replaced during the patch installation. The OPatch patching tool makes a backup of the files that have been replaced during the patcing process.

Solution I

The example below refers to an upgrade from 11.1.1.3 to 11.1.1.3.03, but if you are upgrading from an earlier patch level the procedure is the same, although the path in step 1 will be different.

Locate the old copy of awb.war:

%HYPERION_HOME%\.patch_storage\9650100_May_28_2010_11_38_29\files\products\Foundation\BPMA\AppServer\InstallableApps\awb.war.zip
Use 7zip or another compression utility to unzip the awb.war.zip file and extract the "Docs\en" subdirectory. Save this to a temporary folder.
Locate the current copy of awb.war:

%Hyperion_Home%\products\Foundation\BPMA\AppServer\InstallableApps\awb.war
Open awb.war using 7zip or another compression utility. You many need to change its extension to .zip first.
Copy the "en" directory from the temporary folder into the "Docs" folder within awb.war. In 7zip you can simply drag and drop to do this.
7zip may prompt you to update the .war file with the changes you made. Click "OK" to do so. If you changed the extension to .zip, change it back to .war.
Stop the EPM Architect web application services
Using the Hyperion Configurator utility, redeploy the EPM Architect web applications
Start the EPM Architect services (if they are not already started). Note that redeploying will set Windows services back to "Automatic" startup. Change this back to "Manual" if you would rather start services via a script.

Help should now be available in Workspace:

Navigate -> Administer -> Application library -> Help -> "Help on this Topic"

Solution II

Solution 1 (above) permanently resolves the problem by inserting the missing files into the awb.war file. This has the advantage of fixing the problem at source, so that if you need to redeploy the EPM Architect web application again in the future, the help files will be present. However, if EPM Architect has been manually deployed, or customized, redeploying it may not be a trivial task. In that case you may prefer to simply copy the English documentation folder that is attached to this article into the EPMA server file system.
The disadvantage with this solution is that the documentation will disappear again should you ever redeploy the EPMA web applications in the future.

Stop the EPM Architect web application services
Unzip the file attached to this article ("MissingENdoc") to a temporary folder
Copy the "en" folder unzipped in the previous step to:

%HYPERION_HOME%\deployments\Tomcat5\EPMAWebServer\webapps\awb\docs

Note that this location depends on the web application server used. The example above is for Tomcat (the "Embedded Java Container").
Start the EPM Architect web application services