IBM WebSphere XML Document Management Server Component, Version 7.0.0.0 iFix 1 Readme

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

Contents

 

About this iFix

This iFix 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 iFix is recommended for all customers with an XDMS 7.0 installation.

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

Fix and update history

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.3.
  • Java™: Same as XDMS version 7.0
  • Databases: Same as XDMS version 7.0
  • In addition, if the WebSphere Application Server Network Deployment version is 7.0.0.3, the following iFixes must be applied:

    APAR File Name
    PK74054 7.0.0.0-WS-WAS-IFPK74054.pak
    PK78434, PK80305 7.0.0.3-WS-WAS-IFPK80305.pak
    PK80775 7.0.0.0-WS-WAS-IFPK80775.pak
    PK81028 7.0.0.3-WS-WAS-IFPK81028.pak
    PK81897 7.0.0.3-WS-WAS-IFPK81897.pak
    PK82137, PK84684 7.0.0.3-WS-WAS-IFPK84684.pak
    PK83245 7.0.0.3-WS-WAS-IFPK83245.pak
    PK83447 7.0.0.3-WS-WAS-IFPK83447.pak
    PK83467 7.0.0.1-WS-WAS-IFPK83467.pak

Installation requirements

Software requirements

Software requirements for XDMS are included in the information center. Refer to the following information for details:

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 iFix 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.3) 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 iFix. You need to download and run a reset script available on the Support download site which will then allow installation of this iFix (IBM WebSphere XDMS, Version 7.0.0 iFix 1). 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 iFix

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 iFix, complete the following steps:

  1. Download the IBM WebSphere XDMS 7.0.0 iFix 1 package 7.0.0.0-WS-WAS-IMS-XDMS-IF000001.pak into the was_root/updateInstaller/maintenance directory.
  2. Start the update installer as described by WebSphere and select the XDMS iFix 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 iFix 1 packaging, there are two exceptions (PasreException and NullException) logged into the WebSphere UPDI result logs when installing the XDMS 7.0.0 iFix 1 pak file. The exceptions should not prevent the XDMS 7.0.0 iFix 1 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 iFix 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 iFix.

  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/.
    3. Note: was_root is the installation root directory for WebSphere Application Server Network Deployment. By default, this directory is:
      • For AIX: /usr/IBM/WebSphere/AppServer
      • For Linux: /opt/IBM/WebSphere/AppServer
    4. Leave the context root blank. (This is initially seen on WebSphere Application Server 6.1.)
    5. Click Next.
    6. Accept the defaults on the Select installation options panel.
    7. Click Next.
    8. Select the SharedEnablersXDMS and SIPNotify modules.
    9. Select SharedEnablerCluster from the clusters and severs list.
    10. Click Apply. Verify that the server name for both modules should deploy to the SharedEnablerCluster.
    11. Click Next.
    12. Click Finish.
  • Click Save to save changes to the master configuration..
  • 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 iFix 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 iFix.

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

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

    1. 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.
    2. Install using the Interactive Installer, as instructed in the XDMS 7.0.0.0 Information Center.
    3. After a successful installation, go to the WebSphere Application Server administration console: Resources > JDBC > datasources.
    4. 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.
    5. 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

    6. Click Save to save changes to the master configuration.
    7. Restart the deployment manager, node agents, and the application servers.
    8. 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 iFix 1, execute the following steps to switch to the Oracle thin driver.

    1. 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.
    2. 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.
    3. Add to the Class Path and Native Library Path the directory for the Oracle OJDBC thin driver.
    4. 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

    5. Go to the WebSphere Application Server administration console: Resources > JDBC > datasources.
    6. 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.
    7. 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

    8. Click Save to save changes to the master configuration.
    9. Restart the deployment manager, node agents, and the application servers.
    10. 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 (supersedes 5723545)

    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 ifix 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.

    Verify the installation

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

     

    [8/10/09 23:39:09:230 EDT] 0000000a osgi          I

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

            IBM WebSphere XML Document Management Server 7.0.0.0

            Build Level: 20090709_1412 2009-07-09 14:12

            Licensed Materials - Property of IBM

            5724-O05

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

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

     

    Ensure that the Build Level matches 20090709_1412 2009-07-09 14:12.

    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-01.ibm.com/support/docview.wss?rs=3248&context=SSWJLZ&uid=swg27016067&loc=en_US&cs=UTF-8&lang=en

     

    Updates, limitations, and known problems

    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.