IBM WebSphere XML Document Management Server Component, Version 7.0.0.0 Interim Fix 6 Readme

© Copyright International Business Machines Corporation 2012. All rights reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents

 


About this interim fix

This interim fix is a cumulative fix which includes all the latest changes for the IBM® WebSphere® XML Document Management Server (XDMS), Version 7.0.0.0. This interim fix is recommended for all customers with an XDMS 7.0 installation.

This interim fix is installed using the WebSphere Update Installer as well as some manual updates.

Fix and update history

Interim Fix 006:

  • Bad build date format causes WebSphere Application Server UPDI installer fail to install the XDMS .pak files – APAR LI76827
  • Slow responses (the 200 OK acknowledgement) to subscribe requests when subscription is created for the directory level. – APAR LI76696

Interim Fix 005:

  • Problem with ACL document accesss. The ACL document name is returned instead of the ACL document content. – APAR LI76269
  • Under high load the XDMS server gets into a state where it will return a 404 error on all PUTs. – APAR LI76160

Interim Fix 004:

  • Enhance XDMS performance when used with Oracle (version 11.2 and higher) as the backend database – APAR LI75162

Interim Fix 003:

  • Oracle database scripts have been updated to include appropriate DROP TABLE and DROP INDEX commands – APAR LI75009
  • Initial Notify, for UA Profile Event based, Directory level Subscription, enhanced to include entire file list, contained within the directory – APAR LI75007
  • Issue of FFDC log, with MissingResourceException, being created, during Enabler startup, has been resolved – APAR LI75154

Interim Fix 002:

  • Support the API changes in WebSphere Application Server 7.0 while performing HTTP Digest Authentication – APAR LI74776

Interim Fix 001:

  • Removes the restriction that rls-services documents could only contain one service element (URI). Multiple service elements (URIs) are now supported. - APAR LI74815
  • Adds Oracle patches. - APAR LI74815
  • Rerunning the Oracle database scripts (SharedLists and SharedGroups). - APAR LI74815
  • Full support for the Shared Enablers XDMS EAR (certain known bugs have been fixed). - APAR LI74815
  • Converting to Oracle thin driver (issues with Oracle temp space leak with Oracle thick driver). - APAR LI74815
  • Support for documents of any size is now available for XDMS with Oracle. - APAR LI74815

 

Software compatibility

The supported software products and version numbers for XDMS are documented in the information center. This interim fix runs with the same software except as noted below.

  • Operating Systems: Same as XDMS version 7.0
  • Application Server: This interim fix has been tested on WebSphere Application Server Fix Packs 6.1.0.23 and 7.0.0.7.
  • Java
    1. JDK, version 1.6.0 SRX (included with WebSphere Application Server Network Deployment version 7.0.0.7)
    2. JDK, version 1.5.0 SRX (included with WebSphere Application Server Network Deployment version 6.1.0.23)
  • Databases
    1. IBM DB2™ Enterprise Server Edition Version 9.5 FixPack 4
    2. Oracle Database version 11.2

Note: Beginning with Interim Fix 4 XDMS, when used with Oracle database as the backend, will function only if the Oracle database version is 11.2 or higher. Customer’s using Oracle database version lower than 11.2 should not migrate to Interim Fix 4 or 5.


Installation requirements

Software requirements

Software requirements for XDMS Interim Fix 6 are consistent with the details included in the information center, except for the information on the supported databases. Beginning with XDMS Interim Fix 5, only Oracle 11.2 or higher versions are supported. Oracle database 11.1.0.7, as mentioned in the XDMS information center, is no longer supported.

Refer to the information center for further details about software requirements: http://publib.boulder.ibm.com/infocenter/wtelecom/v7r0m0/topic/com.ibm.xdms.doc/com_sw_prereqs.html

Installation instructions

The IBM WebSphere XDMS 7.0.0.0 Interim Fix will refresh the local files on the WebSphere Application Server (WAS) installed file system.  However, you must manually load the new files into the WebSphere Application Server by following this procedure.

Before you begin

Before you begin the installation, ensure that:

  • The appropriate fix pack (WebSphere Application Server 6.1.0.23 or 7.0.0.7) has been applied to the server where the IBM WebSphere XDMS has been installed.
  • IBM WebSphere XDMS 7.0 has been installed.
  • Websphere Update Installer 7.0 is already installed on the application server.
  • The IMS Update Installer Plugin is already installed on the WAS Update Installer (Note: After applying the IMS Update Installer Plugin, if you have upgraded or installed a new version of the WAS Update Installer (UPDI) itself, then you won’t be able to apply this Interim Fix. You need to download and run a reset script available on the Support download site which will then allow installation of this Interim Fix (IBM WebSphere XDMS, Version 7.0.0 interim fix 5). For details see the IMS Update Installer Plugins installation page for 7.0.0.0: http://www.ibm.com/support/docview.wss?uid=swg24017457
  • You are logged in to the operating system as the actual root user in a UNIX® environment.

Apply the Interim Fix

You must log in with the same root user authority level when unpacking a fix, a fix pack, or a refresh pack. To apply the Interim Fix, complete the following steps:

  1. Download the IBM WebSphere XDMS 7.0.0 Interim Fix 5 package 7.0.0.0-WS-WAS-IMS-XDMS-IF000005.pak into the was_root/updateInstaller/maintenance directory.
  2. Start the update installer as described by WebSphere and select the XDMS Interim Fix to be installed.
  3. Repeat for each server running IBM WebSphere XDMS 7.0, including the Deployment Manager and Aggregation Proxy servers.

Note: Due to a date formatting issue in the XDMS 7.0.0 Interim Fix 5 packaging, there are two exceptions (ParseException and NullException) logged into the WebSphere UPDI result logs when installing the XDMS 7.0.0 Interim Fix 5 pak file. The exceptions should not prevent the XDMS 7.0.0 Interim Fix 5 from being successfully installed, and therefore can be ignored.

Reload the XDMS Core OSGI Bundle

The XDMS Core OSGI bundle is installed in was_root/plugins/com.ibm.ws.xdms_7.0.0.jar.  Run the update installer for the XDMS 7.0.0.0 Interim Fix on all WebSphere Application Servers running an XDMS Enabler, including the server hosting the Deployment Manager and the Aggregation Proxy.  Then run the following steps to reload the OSGI bundle on each server.

  1. Stop all running application servers.
  2. Stop all running node agents.
  3. Stop all deployment managers.
  4. For each node profile (e.g. AppSrv01, AppSrv02), execute the following scripts:

·         AppSrv0n/bin/osgiCfgInit.sh

·         AppSrv0n/bin/clearClassCache.sh

  1. Repeat for each server running IBM WebSphere XDMS 7.0, including the deployment manager and Aggregation Proxy servers.

Redeploy the Shared Enablers XDMS EAR

The Shared Enablers XDMS is an all-in-one application EAR that contains all of the AUIDs from every other XDMS application. The EAR included with the XDMS 7.0.0.0 release was not fully supported and some bugs have been fixed in the EAR. In order to take advantage of these fixes, the EAR that was installed by the XDMS 7.0.0.0 installer needs to be redeployed with a version from the Interim Fix.

  1. Shared Enablers Application is not already installed:
    1. Create a cluster and server for the Shared Enablers EAR (refer to the Preparing the Environment section of the XDMS information center).
    2. Run the XDMS installer from the media, and install the SharedEnablers application.
  2. Navigate to WebSphere Application Server administration console > Applications.
  3. Check Shared Enablers XDMS application. Click unistall.
  4. Save it to the master configuration.
  5. Use the Install New Application task to deploy the IBMSharedEnablersXdms.ear.
    1. Click Applications > Enterprise Applications > Install New Application.
    2. Browse to the location of the IBMSharedEnablersXdms.ear file. The default location is was_root/installableApps/xdms/.

Note: was_root is the installation root directory for WebSphere Application Server Network Deployment. By default, this directory is:

        1. For AIX: /usr/IBM/WebSphere/AppServer
        2. For Linux: /opt/IBM/WebSphere/AppServer
    1. Leave the context root blank. (This is initially seen on WebSphere Application Server 6.1.)
    2. Click Next.
    3. Accept the defaults on the Select installation options panel.
    4. Click Next.
    5. Select the SharedEnablersXDMS and SIPNotify modules.
    6. Select SharedEnablerCluster from the clusters and severs list.
    7. Click Apply. Verify that the server name for both modules should deploy to the SharedEnablerCluster.
    8. Click Next.
    9. Click Finish.
    10. Click Save to save changes to the master configuration.
    11. Restart Shared Enablers server(s).

Converting to the Oracle thin driver

The XDMS 7.0.0.0 release required the use of the Oracle thick (OCI) driver. This required the user to install the full Oracle client on all Websphere servers running XDMS. This Interim Fix releases the dependency on the Oracle thick driver and full Oracle client installation and allows XDMS to use the Oracle thin driver. There are memory leaks present using the thick driver. Therefore, the thin driver is required after installing this Interim Fix.

Note: This only needs to be done for XDMS setups using Oracle. This step can  be skipped if XDMS 7.0.0.1 has already been installed.

If you are installing for first time, ignore any instructions for installing the Oracle thick client on the servers.

  • Copy OJDBC thin drivers from the Oracle database server to a specific directory (for example, /oracle/jdbc/lib) on the deployment manager and the application servers.
  • Install using the Interactive Installer, as instructed in the XDMS 7.0.0.0 Information Center.
  • After a successful installation, go to the WebSphere Application Server administration console: Resources > JDBC > datasources.
  • For each XDMS datasource (including datasources for SIB and usage record), click datasource under Oracle data source properties, in the URL box. Then, change oci to thin.
  • Add the hostname and port to the URL between @ and the database sid, separated by colons.

·         For example: jdbc:oracle:thin:@hostname.example.com:1521:dbxdms

  • Click Save to save changes to the master configuration.
  • Restart the deployment manager, node agents, and the application servers.
  • Go to the WebSphere Application Server administration console: Resources > jdbc > datasources. Verify the XDMS datasouce (including datasources for SIB and usage record) connection to the Oracle database by executing the "Test Connection" on the datasource.

If you already have an existing XDMS installation using the Oracle thick driver prior to installing the XDMS V7.0.0 Interim Fix 4, execute the following steps to switch to the Oracle thin driver.

  • Copy the OJDBC thin drivers from the Oracle database server to a specific directory (for example /oracle/jdbc/lib) on the deployment manager and the application servers.
  • Remove from Class Path and Native Library Path the references to the Oracle thick driver directory under the XDMS, SIB, and usage record Oracle JDBC providers.
  • Add to the Class Path and Native Library Path the directory for the Oracle OJDBC thin driver.
  • Remove the following environment variables and export the reference from the setupCmdLine.sh file on the deployment manager and the application servers:

·         ORACLE_HOME TNS_ADMIN CLASSPATH LIBPATH LD_LIBRARY_PATH

  • Go to the WebSphere Application Server administration console: Resources > JDBC > datasources.
  • For each XDMS datasource (including datasources for SIB and usage record), click datasource under Oracle data source properties, in the URL box. Then, change oci to thin.
  • Add the hostname and port to the URL between @ and the database sid, separated by colons.

·         For example: jdbc:oracle:thin:@hostname.example.com:1521:dbxdms

  • Click Save to save changes to the master configuration.
  • Restart the deployment manager, node agents, and the application servers.
  • Go to the WebSphere Application Server administration console: Resources > jdbc > datasources. Verify the XDMS datasouce (including datasources for SIB and usage record) connection to the Oracle database by executing the "Test Connection" on the datasource.

Adding Oracle patches

Note: This only needs to be done for XDMS setups with Oracle.

The listed Oracle patches are only available for Oracle V11.1.0.7 on the Linux x86_64 operating system from the Oracle metalink2 patch Web site. For the other Oracle supported operating system platforms, contact Oracle support for the listed Oracle patches.

The following Oracle patches need to be installed onto the Oracle database:

  • Bug 8432909 (supersedes 8413065 and 8261767)
  • Bug 8490391
  • Bug 8498942

Rerunning the Oracle database scripts

Note: This only needs to be done for XDMS setups with Oracle.

The XDMS 7.0.0.0 release had a restriction that rls-service documents could only contain one service element each. This restriction is removed with the new database scripts. Also, the index has been changed to take advantage of the Oracle XMLIndex functionality.

Warning: Rerunning the database scripts will drop old tables and delete any existing documents.

  1. Rerun the SharedList, SharedGroup, and SharedEnablers database scripts where applicable (SharedProfile, SharedPolicy, and PresenceRules XDMS database scripts do not need to be rerun).
  2. Copy files in the /WAS_ROOT/installableApps/xdms/scripts/dbScripts/xdms/Oracle directory on a server where the Interim Fix has been applied to the Oracle database server.
  3. Connect as the Oracle user: su - oracle.
  4. Run the script(s): ./IBMSharedListXDMSOracle.sh db_name db_user db_user_password
  5. Repeat the process for SharedGroup and SharedEnablers.

 

Configuring the HttpDigestTAI interceptor for Aggregation Proxy

If Aggregation Proxy is deployed on WebSphere Application Server 7, the custom properties for the HttpDigestTAI interceptor, related to LDAP, are no more required. The presence of these properties will not affect the functionality of Aggregation Proxy, however its recommended to remove these properties from the WebSphere Application Server admin console.

 

Note : This step needs to performed only if the Interim Fix is applied over XDMS 7.0.0.0 release and can be skipped if XDMS 7.0.0.1 has been installed.

 

Steps to re-configure HttpDigestTAI interceptor:

1.      Aggregation Proxy Application is not already installed :

a.       Create a cluster and server for the Aggregation Proxy EAR (refer to the Preparing the Environment section of the XDMS information center)

b.      Run the XDMS installer from the media, and install the Aggregation Proxy application.

2.      Navigate to WebSphere Application Server administration console > Global security >Trust association > Interceptors

3.      Click on “com.ibm.glm.http.security.tai.HttpDigestTAI

4.      Check all the properties beginning with “Ldap” and click on Delete

5.      Click on Apply

6.      Click Save to save changes to the master configuration

7.      Restart Aggregation Proxy server(s).

These changes apply to, only when the Aggregation Proxy application is deployed on a WebSphere Application Server 7 environment and should not be made if the deployment is done on a WebSphere Application Server 6.1.x environment.

 

Changes to XDMS Subscribe/Notify functionality

Post XDMS Interim Fix004, a UA-Profile Event based Subscription to an entire directory, will send, as part of the Initial Notify, the information of all the files, currently located within the directory, to the client. This is opposed to the previous behavior where only the directory details were sent back, without the details of the files contained in it. With this change the content of the Initial Notify for UA-Profile Event based subscriptions will be similar to the one obtained during the Initial Notify for XCAP-DIFF Event based directory level subscriptions, with the only exception that “doc-selector” attribute will be used, instead of “sel”,  in the Initial Notify, to indicate the file information.

 

If the custom clients, used for receiving the Initial Notify, are not configured to accept entire file list information, it will be required to modify them, to enable them to handle the new content in the Initial Notify.

 

Verify the installation

Examine the SystemOut.log of each application server running an XDMS Enabler.  Search for “IBM WebSphere XML Document Management Server”.

 

[7/11/12 12:31:45:630 IST] 0000000 osgi          I

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

        IBM WebSphere XML Document Management Server 7.0.0.0

        Build Level: 20120711_0504 07/11/2012 05:04

        Licensed Materials - Property of IBM

        5724-O05

        © Copyright IBM Corp. 2006, 2012 All Rights Reserved.

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

 

Ensure that the Build Level matches 20120711_0504

Configuration instructions

The configuration for XDMS is the same as that described in the information center, except as specified in either the XDMS 7.0 Readme (WebSphereProductsForTelecomReadme.html) or this Readme.

Tune the XDMS as recommended by the XDMS Performance Tuning Guide.pdf

For optimal and proper performance of your XDMS installation, download the tuning guide and follow the instructions found here:

http://www.ibm.com/support/docview.wss?rs=3248&context=SSWJLZ&uid=swg27016067&loc=en_US&cs=UTF-8〈=en

 


Updates, limitations, and known problems

When XDMS is used with Oracle (version 11.2 or higher) as the backend database, the following drawbacks might persist:

  • Operations involving the use of RLS-SERVICE and SHARED GROUP documents might be noted to have slower performance when compared to documents of other AUIDs.
  • Performing NODE LEVEL operations on XML documents (irrespective of AUID) could cause memory leaks on the Oracle server, which might subsequently cause the XDMS application to stop functioning.

Note: IBM intends to address these issues in subsequent releases of the XDMS product.

Additional updates, limitations, and known problems about XML Document Management Server are documented in technotes on the IBM Software Support Web site: http://www.ibm.com/software/pervasive/xdms/support/

As limitations and problems are discovered and resolved, the IBM Software Support team updates the knowledge base. By searching the knowledge base, you can quickly find workarounds or solutions to problems that you experience. The following link launches a customized query of the live Support knowledge base. To create your own query, go to the Advanced search page.


Trademarks

The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both: IBM, WebSphere, DB2, and AIX

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

Other company, product, or service names may be trademarks or service marks of others.