IBM Support

Remediation of select OpenPages deliverables may be required due to upgraded Apache POI libraries

Troubleshooting


Problem

Policy Import Trigger, Custom FastMap Reader, Custom Triggers and Helpers may fail with an error message due to dependencies on Apache POI libraries that have been updated in OpenPages.

Symptom

1. Policy Import Trigger may fail with an error such as 'An unknown error has occurred while processing a business rule trigger'.

2. FastMap Import may fail with error.

3. You may find errors such as 'java.lang.NoSuchMethodError' related to Apache POI libraries in OpenPages aurora.log or OpenPages Server systemout.log

Cause

The Apache POI libraries included with OpenPages have been updated and some APIs have been deprecated and updated.

Diagnosing The Problem

Perform the steps below to diagnose the problem:

1. Navigate to <OP_HOME>/profiles/<OP_NODE>/installedApps/OpenPagesCell/op-apps.ear, Verify the Apache POI version used by the OpenPages server in your environment.
2. Update the classpath on your build environment to make sure you use the correct Apache POI along with its dependent jars.

Apache POI version used by the OpenPages server

Apache POI along with its dependent jars

Apache POI 3.8

poi-3.8-20120326.jar

poi-ooxml-3.8-20120326.jar

poi-ooxml-schemas-3.8-20120326.jar

poi-scratchpad-3.8-20120326.jar

commons-logging.jar

log4j.jar

commons-collection.jar

commons-codec-1.8.jar

xmlbeans.jar

Apache POI 3.15

poi-3.15.jar

poi-ooxml-3.15.jar

poi-ooxml-schemas-3.15.jar

poi-scratchpad-3.15.jar

commons-logging-1.2.jar

log4j-1.2.17.jar

commons-collection4-4.1.jar

commons-codec-1.10.jar

xmlbeans-2.6.0.jar

Apache POI 3.17

poi-3.17.jar

poi-ooxml-3.17.jar

poi-ooxml-schemas-3.17.jar

poi-scratchpad-3.17.jar

commons-logging-1.2.jar

log4j-1.2.17.jar

commons-collection4-4.1.jar

commons-codec-1.10.jar

xmlbeans-2.6.0.jar

3. Recompile the Custom Trigger and Helper code and identify all the compilation errors related to the Apache POI libraries.

Resolving The Problem

1. Out of the Box Triggers:

If your environment started with a fresh install of 7.2*, 7.3 or 7.4, then all of the "out of the box" triggers are included in openpages-solutions.jar in <OP_HOME>/aurora/op-ext-lib. The fixpack installers have updated openpages-solutions.jar with the changes required to remediate the triggers for the Apache POI upgrade.

If your environment started with a fresh install prior to 7.2*, then the "out of the box" triggers are included in openpages-ext.jar in <OP_HOME>/aurora/lib. Since your custom triggers are also included in openpages-ext.jar, please follow the steps below to merge the remediated out of the box triggers with any customization you may have.

1. Backup openpages-ext.jar from <OP_HOME>/aurora/lib/

2. Extract "openpages-ext.jar" from <OP_HOME>/aurora/lib/ to <OP_HOME>/merge/
3. Extract “openpages-solutions.jar” from <OP_HOME>/aurora/op-ext-lib to <OP_HOME>/merge/ [allow/choose to overwrite existing file]
4. Zip/Jar the files and folders under the “merge” folder as “openpages-ext.jar”
5. Copy the Updated “openpages-ext.jar” to <OP_HOME>/aurora/lib/ [allow/choose to overwrite the file.

2. Custom Triggers and Helpers:

Use the Apache POI change log documentation https://poi.apache.org/changes.html to remediate the Custom Triggers and Helpers.

* If your environment is at 7.2.0.x, upgrade to the 7.2.0.6 fixpack to get POI 3.15 version support in OpenPages.

* If your environment is at 7.3, upgrade to the 7.3.0.3 fixpack to get POI 3.17 version support in OpenPages.

* If your environment is at 7.4.0.x or 8.0.0.1, upgrade to the 8.0.0.2 fixpack to get POI 3.17 version support in OpenPages.

Document Location

Worldwide

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSFUEU","label":"IBM OpenPages with Watson"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"7.3.0.1;7.3.0.3;7.2.0.6;7.1.0.4;8.0.0.1;8.0.0.2","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
24 January 2019

UID

swg22005130