Readme

IBM FileNet Image Services Resource Adapter [ISRA] 3.4.0
© Copyright IBM Corporation 2008. All Rights Reserved.

March 2008

Introduction to 3.4.0

New Features in 3.4.0

Layout of Product Distribution
Supported Platforms
Installation and Deployment
Issues Resolved in this Release

Known Software Problems and Restrictions
General Notes
ISRA Support
Contact Customer Support
Notices and Trademarks

Readme Revision log

Date Description
March 2008
  • This readme is for ISRA 3.4.0 release.
  • Any fix pack changes will be reported in the fix pack readme separately.

Introduction to 3.4.0

ISRA is a Resource Adapter for IBM FileNet Image Services (IS). This Resource Adapter is compliant with the J2EE Connector Architecture v 1.0. ISRA is a system-level software driver, which can be used by a Java application component (client) to interact with the IS. ISRA provides an alternative to IDM Web Services for accessing IS in a web application. In addition, it provides a Java based Web solution independent of Microsoft technologies or products.

ISRA is packaged in two editions as follows:

New Features in 3.4.0

ISRA version 3.4.0 provides additional functionalities and features in this release:

Layout of Product Distribution

setup_ISRA340.jar

Contains jar file for silent Installation

media.inf

Contains the Setup information

/Docs

ISRA documentation

ISRA 3.4.0 Release Notes.html

Release Notes for ISRA 3.4.0

/<platform> Contains setup_ISRA340.bin/exe for specific platforms (Windows 2003, Solaris 9/10, AIX 5.2 SP2/5.3 SP3, HPUX 11i v1, RedHat Linux AS 3.0/4.0)
/GenericUnix Contains setup_ISRA340.bin for Generic Unix platform

Supported Platforms

Installation and Deployment

ISRA 3.4 can be installed on Microsoft Windows 2003 (Standard, Professional and DataCenter), Sun Solaris 9/10, HPUX 11i v1, IBM AIX 5.2 SP2/AIX 5.3 SP3 and RedHat Linux AS 3.0/4.0 Servers. To install ISRA on AIX, HPUX, Solaris or RedHat Linux platform, execute setup_ISRA340.bin from the respective folder on the product media. For example, to install ISRA on Sun Solaris 9, execute setup_ISRA340.bin from the /Solaris folder, and for Microsoft Windows 2003, execute setup_ISRA34.exe from /Windows folder on the product media.

To deploy ISRA on the target Application Server, follow the steps explained in ISRA deployment guides for the respective Application Servers. To verify the successful deployment, deploy and access the ISRA Sample Application. The Sample Application deployment and configuration is also explained in the ISRA deployment guides. ISRA Programmer's Guide and Deployment Guides for all supported Application Servers are located in the /Docs folder of the product media.

After installation, the installer creates the following files/directories in the installed directory:

Folder/Files
Sub Folder/Files Explanation
/Docs    
ISRA_InstallationGuide_340.pdf ISRA Common Installation Guide
  ISRA_Oracle_DeployGuide_340.pdf ISRA Deployment Guide for Oracle 10g Application Server.
  ISRA_WLS8_DeployGuide_340.pdf  ISRA Deployment Guide for BEA WebLogic 8.1.
  ISRA_WLS9_DeployGuide_340.pdf  ISRA Deployment Guide for BEA WebLogic 9.0/9.1
  ISRA_WAS6_DeployGuide_340.pdf ISRA Deployment Guide for IBM WebSphere Application Server 6.0.
  ISRA_JBoss_DeployGuide_340.pdf  ISRA Deployment Guide for JBoss Server.
  ISRA_SAP NetWeaver_DeployGuide_340.pdf  ISRA Deployment Guide for SAP Net Weaver Server.
  ISRA_SunJava_System_AS_DeployGuide_340.pdf ISRA Deployment Guide for Sun Java System Application Server.
  ProgrammersGuide_340.pdf The Programmer's Guide for ISRA 3.4.0
  ISRA 3.4 Release Notes.html Release Notes for ISRA 3.4.0
  README.html ReadMe for ISRA 3.4.0
/Jar     
  ISRA.jar The jar file contains the ISRA implementation classes.
  ISRA.rar The ISRA resource adapter archive file; this is the J2EE Connector Architecture RAR file for ISRA. The RAR file contains ISRA JAR file with deployment descriptor.
/Sample    
  ISRASample.ear  A sample Web application using ISRA.
  FNImageViewer.ear The application module contains FNImageViewer that can be configured with the ISRA Sample Application. 
  /source This subdirectory contains the source code for the ISRA Sample Application. The Sample Application demonstrates the interactions supported by ISRA
/FNImageViewer     
  FNImageViewer.jar The FNImageViewer files that can be used in application environment. This viewer supports viewing and annotation of image formats, such as TIFF, JPEG, and BMP. 
  /docs This sub folder contains FNImageViewer documentation.
/SystemManager    
  listener.jar  
  log4j-1.2.8.jar  
  WinPerfMon.dll  
  /docs This sub folder contains IBM FileNet P8 System Manager documentation. 
/_uninstall    
  uninstall.dat, uninstall.jar The jar file contains the uninstaller for uninstalling ISRA 3.4.0
  uninstall_ISRA340.bin The setup program for uninstalling ISRA 3.4.0. For Windows operating system, the file name is uninstall_ISRA34.exe.
/Util    
  whichISRA.sh/whichISRA.bat A command-line utility for Unix/Windows platforms that accepts the complete path of ISRA.jar file, and returns the ISRA version information.
  whichSA.sh/whichSA.bat A command-line utility for Unix/Windows platforms that accepts the complete path of ISRASample.ear file, and returns the ISRA Sample version information.
  ISRA_Utilities_Help.html Help on how to use version stamping utilities.
  /lib This sub folder contains executable jar files whichISRA.jar and whichSA.jar. These jar files are executed by whichISRA and whichSA utilities, respectively.
/_jvm    
  /bin This sub folder contains the binaries required for Java Runtime Environment.
  /lib This sub folder contains the library files required for Java Runtime Environment.
  README.txt ReadMe for Java Runtime Environment.
/license    
  License files (*.txt) Contains license files for various languages.
     

Note: Adobe Acrobat Reader should be installed in your machine for reading the PDF Guides.

Issues Resolved in this Release

The following issue has been resolved with Release 3.4.0:

ecmdb APAR Files Affected Lib Description
00745723 35590537
Originally deployed ISRA.rar (ISRA 3.4.0), ISRA.jar
IS
Unable to view annotations that was created by a deleted IS user: After upgrading from ISRA 3.3 FP2 to FP5 (to fix a mem-leak issue on their WAS server), annotations that were created by a deleted IS user cannot be viewed by other users. The following error appeared: "Annotation Exception: Annotations failed to load".

Known Software Problems and Restrictions

BEA WebLogic Application Server

On WebLogic 8.1 Application Server, a blank page is displayed during login in ISRA Sample Application. To fix this problem, edit the file <WebLogic Installation Directory>\user_projects\mydomain\startWebLogic.cmd (or startWebLogic.sh for UNIX platforms) to include ISRA.jar in CLASSPATH environment variable, and restart the server. Alternatively, you can set ISRA.jar in the CLASSPATH on the server.

SAP NetWeaver Application Server

While deploying FNImageViewer on SAP NetWeaver Application Server 6.4, an error is thrown as "At least one <welcome-file> tag must exist in the <welcome-file-list> tag. This problem will be fixed in SAP NetWeaver WAS 6.4 SP19. Until this service pack is released, please refer ISRA Deployment Guide for SAP NetWeaver Application Server for a workaround to resolve this problem.

IBM WebSphere Application Server

  1. IBM WebSphere 5.1.1.x/6.0.2/6.1 Application Servers destroy the CCI connection stored in HTTP Session object on exit of doPost()/doGet() methods of Servlets or JSPs. To fix this problem in IBM WebSphere 5 apply the IBM WebSphere 5 Fix Pack 2. Please refer http://www.ibm.com/Search?y=11&lang=en&cc=us&q=PQ73966&Search.x=28&Search.y=11 for details on how to apply the fix pack.
    For IBM WebSphere 6.0.2 and 6.1, please refer http://www-1.ibm.com/support/docview.wss?rs=180&uid=swg1PK25725 to fix this problem.
  2. IBM WebSphere Application Server does not provide the crimson implementation of DocumentBuilderFactory class. The Sample Application uses crimson implementation of DocumentBuilderFactory class to implement the Remote printing functionality. Please refer to the IBM WebSphere Deployment guide, which gives detailed steps on how to use the crimson.jar with the Sample Application. For reference, the PMR number for the case opened with IBM is PMR 83866,756,000.
  3. IBM WebSphere will not destroy the last connection with IBM FileNet IS. IBM WebSphere creates parked connections because of which one user always remains logged on to IS. To fix this problem in IBM WebSphere 5 apply the IBM WebSphere 5 Fix Pack PK00210. Please refer
    http://www-1.ibm.com/support/docview.wss?rs=180&context=SSEQTP&q1=PQ86338&uid=swg27004936&loc=en_US&cs=utf-8&lang=en for details on how to apply the fix pack.
  4. IBM WebSphere Application Server passes the subject as null for container managed sign on, hence ISRA throws an "Invalid Arguments Passed" error with container managed sign on. IBM provided the following links related to this issue: For setting up the context so that the lookup is not cached:
    http://publib.boulder.ibm.com/infocenter/wasinfo/v5r1//index.jsp?topic=/com.ibm.websphere.base.doc/info/aes/ae/rnam_example_behavior.html For JNDI caching in WebSphere:
    http://publib.boulder.ibm.com/infocenter/wasinfo/v5r1//index.jsp?topic=/com.ibm.websphere.base.doc/info/aes/ae/cnam_naming_caching.html
  5. In case of failover scenarios, there is a possibility that the user may have to perform the operation again to complete the request. For example, in case of AddDoc interaction in the Sample Application, ISRA will throw the "Invalid InputStream object" error if the primary server goes down.
  6. If a client application packages any external jars in the WEB-INF/lib of the application and the Web Module class loader is set to Parent Last, then a ClassCastException occurs. To fix this problem in IBM WebSphere 6.x, apply the IBM WebSphere fixpacks 6.0.2.15 and 6.1.0.2. Please refer http://www-1.ibm.com/support/docview.wss?uid=swg1PK26233 to apply this patch. 

General Notes

Supportability on Development Platforms

IBM FileNet has not qualified ISRA and the ISRA Sample Application to run under development platforms such as WSAD, BEA Workshop, or any other development platforms. This is primarily because IBM FileNet Engineering may not be able to keep up with the dependencies on specific development platform configuration.

However, ISRA and ISRA Sample should be able to run under any development platform that provides managed environment and runtime support for JCA 1.0. Since, IBM FileNet has not qualified these development platforms with ISRA and ISRA Sample, it is customer's responsibility to determine the proper setup and/or configuration that enable ISRA and Sample Application to work under the specific development platform. If there are any problems during configuration, deployment, development or runtime relating to ISRA under these development platforms, it is the customer's responsibility to verify if the same problem also occurs under the qualified Application Server environment.

Globalization

ISRA supports all character sets supported by Image Services, which are single byte character sets, as well as some multi-byte character sets. Unicode character sets, such as AL16UTF16, AL32UTF8, or UTF8 are not supported at this time. For a detailed overview of the supported character sets, please refer to the Image Services System Administrators manual.

For "Points to be noted for Globalization", please refer the Appendix for Globalization in ISRA 3.4.0 Programmers Guide.

ISRA Supports

Note: ISRA is currently supported for production deployment only in the Managed Environment. If you experience any difficulties with the product media or ISRA, please contact your IBM FileNet Customer Support personnel for assistance.

Contact Customer Support

For information about contacting customer support:

  1. Navigate to the Information Management support page ( www.ibm.com/software/data/support ).
  2. Select the appropriate IBM FileNet product from the "Select a category" list.
  3. From the Product Support page, click Flash 8 Oct. 2007: How to get support for IBM FileNet products.

Notices and Trademarks