############################################################################### # IBM Content Manager OnDemand for Multiplatforms # # Web Enablement Kit for # # AIX, HP-UX, Linux, Sun Solaris, Windows, Linux on System z # # README # # Release 8.4.0.2 # # April 25, 2008 # # # # 5724-J33 (C) COPYRIGHT IBM CORPORATION 2008 # # All Rights Reserved # # Licensed Materials - Property of IBM # # US Government Users Restricted Rights - Use, duplication or # # disclosure restricted by GSA ADP Schedule Contract with IBM Corp. # ############################################################################### The information about OnDemand contained in this README file was not available at the time that the OnDemand publications were printed. Please make a note of these items, which supersede the information in the OnDemand publications. For the latest information about OnDemand, see the OnDemand Web site at: http://www.software.ibm.com/data/ondemand =============================================================================== 1. Contents 2. Installation 2.1.8.4.0.0 Release (8.4.0.0) 2.1.8.4.0.1 Release (8.4.0.1) 2.1.8.4.0.2 Release (8.4.0.2) 3. Web Enablement Kit Change History 3.1 CGI/Servlet 3.1.8.4.0.0 Release (8.4.0.0) 3.1.8.4.0.1 Release (8.4.0.1) 3.1.8.4.0.2 Release (8.4.0.2) 3.2 AFP Web Viewer (Plugin/ActiveX) 3.2.8.4.0.0 Release (8.4.0.0) 3.2.8.4.0.1 Release (8.4.0.1) 3.2.8.4.0.2 Release (8.4.0.2) 3.3 Image Web Viewer (Plugin/ActiveX) 3.3.8.4.0.0 Release (8.4.0.0) 3.3.8.4.0.1 Release (8.4.0.1) 3.3.8.4.0.2 Release (8.4.0.2) 3.4 Java Line Data Applet 3.4.8.4.0.0 Release (8.4.0.0) 3.4.8.4.0.1 Release (8.4.0.1) 3.4.8.4.0.2 Release (8.4.0.2) 3.5 Java AFP2HTML Applet 3.5.8.4.0.0 Release (8.4.0.0) 3.5.8.4.0.1 Release (8.4.0.1) 3.5.8.4.0.2 Release (8.4.0.2) 3.6 Java API 3.6.8.4.0.0 Release (8.4.0.0) 3.6.8.4.0.1 Release (8.4.0.1) 3.6.8.4.0.2 Release (8.4.0.2) 4. Testing Environment 5. Reference =============================================================================== Note: Starting with version 7125, the IBM Portlets for IBM DB2 Content Manager OnDemand are available. These portlets provide the following capabilities; Logon/Logoff Change expired password Folder list with sort and pagination support Multiple predicate search Search results with sort and pagination support Server print documents Local print annotations Multiple portlets supported (Main and Viewer portlets) Document viewing support with Line Data Applet, AFP2HTML applet and the AFP plugin Configuration support through the arswww.ini file For more information on supported platforms and to download the OD portlets, visit the WebSphere Portal Catalog at http://www.ibm.com/developerworks/websphere/zones/portal/catalog Note: The Applets and Web Viewers have now been tested with Internet Explorer 7.0. No problems were found except for the following: - Due to a new security restriction in IE7, the AFP2HTML viewer applet is unable to display image resources in the document. We are working on a solution. However, in the meantime, please read the information at: http://msdn2.microsoft.com/en-us/library/ms649488.aspx Add the registry entry corresponding with FEATURE_BLOCK_LMZ_IMG and set the iexplore.exe value to 0 (zero). This will cause IE7 to "opt-out" of the security restriction. Note: The Arabic and Hebrew OnDemand 8.4 ODWEK have the following known limitation: - Messages from ODWEK (aka, client message repository) cannot be displayed in Arabic and Hebrew. The above limitations will be corrected in a future release. =============================================================================== 2. Installation 2.1.8.4.0.0 Release (8.4.0.0) Note: The Java API Shared library name has changed. The old named library, arswwwsl.[a,so,sl,dll] is still used by the servlet. The Servlet class file name has also changed as well. The new name is ArsSVTInterface.class. ** ODWEK API Users need to make sure that the old ArsWWWInterface.class is deleted, as this file is no longer used by the ODWEK Apis, but can cause conflicts if not removed. - Unix installs are now packaged with InstallShield MP. The native installs using SMIT, swinstall, pkgadd, or RPM are no longer supported - Pre-reqs - Previous install of OnDemand Web Enablement Kit V7.1.2 - Between 130-200MB of free space in /tmp (depending on platform) for InstallShield. To specify a different temporary directory you can use the "-is:tempdir " option for InstallShield - For Solaris, make sure your DISPLAY environment variable is set appropriately - To install from the command line - odwekaix -console - odwekhp -console - odweksun -console - odweklinux -console - odweklinux390 -console - odwekwin.exe -console - To uninstall from the command line on AIX - /usr/lpp/ars/www/_uninsti84/uninstallodwek -console - To uninstall from the command line on other UNIX platforms - /opt/ondemand/www/_uninst84/uninstallodwek -console - To uninstall on Windows use Add/Remove Programs - Please read the Installation Documentation in the CMODDoc.zip or see the online documentation at: http://publib.boulder.ibm.com/infocenter/cmod/v8r4m0/ package for further information Before using the latest version of the Web Enablement Kit CGI/Servlet, you must delete all of the files from the Web Enablement Kit cache and temp directories. The directories are specified by the CACHEDIR and TEMPDIR directives in the arswww.ini file. - Version 8.4.x.x now includes libraries and arswww.cgi for 64-Bit Operating Systems on Aix,Sun,HP,lunux,and Linux on System z. Windows is 32-bit only, and Linux on System z is only 64-bit. The filenames of the Servlet and API shared libraries has been changed (libname64.so, oe libname32.so) to reflect which OS architecture they were built for. This release includes the following files: README - This file. arswww.cgi - This is the Web Enablement Kit CGI program. This file should be placed into a directory within your Web server directory space which has been designated as executable and can contain CGI applications. arssck32.dll (Windows) ctreestd.dll (Windows) - No longer needed - This file should be left in the installation directory. icudt36l.dat (Windows, Linux) icudt36b.dat (AIX, SunOS, HPUX) - This file should be left in the installation Locale directory. icudt36.dll (Windows) icuin36.dll (Windows) icuuc36.dll (Windows) icule36.dll (Windows) - No longer needed iculx36.dll (Windows) - No longer needed - These libraries are used for ICU support. On Windows, these files must be placed in the same directory as the arswww.cgi file or when using the JAVA Api's, a directory that is in the command search path defined by the Path environment variable. ArsWWWServlet.jar ArsSVTInterface.class arswwwsl32.dll (Windows) libarswwwsl32.a (AIX 32-Bit) libarswwwsl32.so (SunOS,iLinux 32-Bit) libarswwwsl32.sl (HPUX 32-Bit) - Servlet support files. ArsWWWServlet.jar should be placed into the web server's servlet directory. Because the servlet uses JNI, you may have to put ArsWWWInterface.class and the shared library file into into a directory other than the web server's servlet directory. This is due to class loader issues. See the documentation for more information. ODApi.jar ars3wapi32.dll (Windows) libars3wapi32.a (AIX 32-Bit) libars3wapi64.a (AIX 64-Bit) libars3wapi32.so (SunOS,iLinux 32-Bit) libars3wapi64.so (SunOS,iLinux 64-Bit) libars3wapi64.so (zLinux 64-Bit) libars3wapi32.sl (HPUX 32-Bit) libars3wapi64.sl (HPUX 64-Bit) - Java API and support files. See the documentation and api/ODApiDoc.zip for more information on using the API's. arswww.ini - This is the configuration file for the cgi/servlet. See the documentation for information on the configuration settings. This file must be placed in the same directory as the cgi or servlet program. afp2html.ini - This is the configuration file for the AFP2WEB Transform. See the documentation for information on the configuration settings. afp2pdf.ini - This is the configuration file for the AFP2PDF Transform. See the documentation for information on the configuration settings. arsxenos.ini - This is the configuration file for the XENOS Transform. See the documentation for information on the configuration settings. api/ODApi.jar - This is the OnDemand Java API jar file api/ODApiDoc.zip - This is the OnDemand Java API Documentation locale/arscpcs.cfg - This file contains the code page to code set mappings. This file should stay in the installation directory. samples/template.htm - This is a sample of what a template html file can look like. samples/logon.htm - This is another sample html file demonstrating how to gather logon information from the end user and submit it to arswww.cgi. samples/credit.htm - This is another sample html file demonstrating the use of another script function, dochitlist. samples/frames.htm samples/fcredit.htm samples/fblank.htm samples/ftemplat.htm - These are sample html files demonstrating how to use the _frame parameter to build a frames based application. images/grytxtr4.jpg images/odcol2in.gif - These are the images referenced in the sample html files. images/odic_att.gif - image used for Showing Document Attachments - These images are used for the ODDOC type images/odic_aa.gif - image used for Add Annotation button images/odic_aad.gif - image used for Add Annotation button (disabled) images/odic_va.gif - image used for View Annotation button images/odic_vad.gif - image used for View Annotation button (disabled) images/odic_vd.gif - image used for View Document button images/odic_vdd.gif - image used for View Document button (disabled) - These images are used when enabling commands for the command icons column of the document list table. (See the documentation for more information). To use your own images, simply rename your image to one of the names above. images/* - The remainder of the images are used by the applet toolbars. They should be placed in the IMAGE_DIR directory. (See the documentation for more information). These images cannot be replaced with your own images. applets/ODLineDataViewer2.jar - IBM OnDemand Line Data Viewer applet. applets/ODAfp2Html2.jar - IBM OnDemand AFP Transform applet. - These applet files are used when enabling the java AFP2HTML viewer applet. (See the documentation for more information). applets/IEFix.js - JavaScript file to assist applet launch plugins/afpplgin.exe - IBM OnDemand AFP Web Viewer (Plugin/ActiveX) - All languages including DBCS support plugins/afpplgin.zip - IBM OnDemand AFP Web Viewer (Plugin/ActiveX) - Zip format for all languages include DBCS support plugins/imgplgin.exe - IBM OnDemand Image Web Viewer (Plugin/ActiveX) - All languages - These are self extracting files (InstallShield). These files should be downloaded to the user's Windows XP, Windows 2000, Windows 2003, Windows Vista system, and run to install the appropriate plug-in. If the user is running a browser while the installation is in progress, then the user must stop and restart the browser before the plugins can be used. 2.1.8.4.0.1 Release (8.4.0.1) - Pre-reqs - Previous install of OnDemand Web Enablement Kit V8.4 2.1.8.4.0.2 Release (8.4.0.2) - Pre-reqs - Previous install of OnDemand Web Enablement Kit V8.4 -------------end of Installation----------------------------------------------- 3. Web Enablement Kit Change History ------------------------------------------------------------------------------- 3.1 CGI/Servlet 3.1.8.4.0.0 Release (8.4.0.0) - Pre-reqs - AIX 5L for POWER 5.3 or later - HP-UX V11i V2 or later - Sun Solaris V10 or later (SPARC only) - Linux RedHat (RHEL) 4 Update 4 or later - Linux SUSE (SLES) 10 or later - Linux on System z RedHat (RHEL) 5 U0 - Linux on System z SUSE (SLES) 10 or later - Windows 2003 R2 or later - Java Runtime Environment 1.4.1 or higher Note: Support for the AFP2xxx transforms using a Shared Library has been removed. Only the Executable methods are supported in Version 8.4.x.x 3.1.8.4.0.1 Release (8.4.0.1) 3.1.8.4.0.2 Release (8.4.0.2) APARs: PK59300 - ODWEK Abends when saving large amounts of state info - Changed state caching of Printer information -------------end of CGI/Servlet------------------------------------------------ 3.2 AFP Web Viewer (Plugin/ActiveX) 3.2.8.4.0.0 Release (8.4.0.0) - Pre-reqs - Windows XP SP2 - Windows Vista (32-bit and 64-bit) - Current version is AFP Web Viewer V3.3.1.2 3.2.8.4.0.1 Release (8.4.0.1) - Upgraded the AFP Web Viewer to V3.3.1.4 3.2.8.4.0.2 Release (8.4.0.2) - Upgraded the AFP Web Viewer to V3.3.1.6 APARs: PK57252 - AFP PLUGIN intermittently throws error on Win2000 - Corrected AFP Plugin header code PK56294 - AFP PLUGIN leaking desktop heap PK58409 - AFP PLUGIN does not work with some mouse wheel scroll cmds PK60580 - ICU code page error after AFP Plugin loaded ~200 times PK61894 - AFP PLUGIN takes focus when WM_PAINT repaints non-plugin - Upgraded the AFP Web Viewer to V3.3.1.6 -------------end of AFP Plugin------------------------------------------------- 3.3 Image Web Viewer (Plugin/ActiveX) 3.3.8.4.0.0 Release (8.4.0.0) - Pre-reqs - Windows XP SP2 - Windows Vista (32-bit and 64-bit) 3.3.8.4.0.1 Release (8.4.0.1) 3.3.8.4.0.2 Release (8.4.0.2) -------------end of Image Plugin----------------------------------------------- 3.4 Java Line Data Applet 3.4.8.4.0.0 Release (8.4.0.0) - Pre-reqs - Java 1.4.1 or later Enhancements: - Applet Certificate is valid until April 2009 3.4.8.4.0.1 Release (8.4.0.1) APARs: PK43168 - JAVA LDV2: FIND ALL returns incorrect results - Corrected Large Object segment handling PK40049 - "Ctrl-L" in 2nd page displays as extra space in JAVA LDV - Changed the Applet to remove \f instead of replace it 3.4.8.4.0.2 Release (8.4.0.2) APARs: PK56825 - JAVA LDV SEARCH across multiple segments not working - Changed the LDV to search by line PK58379 - LDV fails doc retrieve if USER is in 1000's of OD GROUPS - Changed the buffer to be dynamic instead of static PK59607 - JAVA LDV PRINT PREVIEW displays blank w/SEL PAGE - Changed page selection behavior PK62171 - JAVA LDV2 FIND ALL from 2nd or later seg does not work - Changed LDV2 to search all segments -------------end of Java Line Data Applet-------------------------------------- 3.5 Java AFP2HTML Applet 3.5.8.4.0.0 Release (8.4.0.0) - Pre-reqs - Java 1.4.1 or later Enhancements: - Applet Certificate is valid until April 2009 3.5.8.4.0.1 Release (8.4.0.1) 3.5.8.4.0.2 Release (8.4.0.2) -------------end of Java AFP2HTML Applet--------------------------------------- 3.6 Java API - Pre-reqs - Java 1.4.1 or later - AIX 5L for POWER 5.3 or later - HP-UX V11i V2 or later - Sun Solaris V10 or later (SPARC only) - Linux RedHat (RHEL) 4 Update 4 or later - Linux SUSE (SLES) 10 or later - Linux on System z RedHat (RHEL) 5 U0 - Linux on System z SUSE (SLES) 10 or later - Windows 2003 R2 or later 3.6.8.4.0.0 Release (8.4.0.0) Notes: - Following Deprecated JAVA APIs and methods have been removed. If you are migrating from a previous version of ODWEK, please review the Java API Documentaton for your pre-8.4.0.0 version for specifics on what calls should be used instead. Deprecated API and Methods com.ibm.edms.od.ODFolder.addHit(String, char, int, String[]) The hitlist will always contains all of the hits from the last search. If you require a limited hitlist, you can limit your hits via the search. com.ibm.edms.od.ODFolder.addHit(String, char, String[]) The hitlist will always contains all of the hits from the last search. If you require a limited hitlist, you can limit your hits via the search. com.ibm.edms.od.ODCallback.cancel() No longer needed com.ibm.edms.od.ODFolder.getApplGroups() Use ODFolder.getApplGroupNames() com.ibm.edms.od.ODApplicationGroup.getApplications() Use ODApplicationGroup.getApplicationNames() com.ibm.edms.od.ODFolder.getAppls(String) Use ODFolder.getApplNames(java.lang.String) com.ibm.edms.od.ODCriteria.getDBFields(String) Use ODCriteria.getDBFieldNames(java.lang.String) com.ibm.edms.od.ODHitProperties.getDocName() Use ODHitProperties.getInternalDocName() com.ibm.edms.od.ODUser.getGroups() Use ODUser.getGroupNames() com.ibm.edms.od.ODServer.getLocalDir() No longer needed com.ibm.edms.od.ODHit.getNoteStatus(boolean) We cannot allow the application developer to override the OnDemand Server config here. The methods to force the return of specific note status on the OnDemand Server could greatly affect the performance of the OnDemand Server. If the note status is not available from getNoteStatus(), see your OnDemand System Administrator. com.ibm.edms.od.ODCriteria.getOperand() Use ODCriteria.getOperator() com.ibm.edms.od.ODFolder.getOrSearchCriteria() Use ODFolder.isOrSearchCriteria() com.ibm.edms.od.ODHit.getPrintersForHit() Use ODHit.getPrinterNames() com.ibm.edms.od.ODFolder.getSortEnabled() Use ODFolder.getSortLocation() com.ibm.edms.od.ODHit.getUserGroups() Use ODUser.getGroupNames() com.ibm.edms.od.ODServer.getUserInfo() Use ODServer.getUser() com.ibm.edms.od.ODCriteria.getValidOperands() Use ODCriteria.getValidOperators() com.ibm.edms.od.ODCriteria.getValidValues() Use ODCriteria.getFixedValues() com.ibm.edms.od.ODCriteria.getValues() Use ODCriteria.getSearchValues() com.ibm.edms.od.ODCallback.isDone() No longer used com.ibm.edms.od.ODHit.isHitFrom390v2Server() For use with legacy applications only. com.ibm.edms.od.ODFolder.isSortEnabled() Use ODFolder.getSortLocation() com.ibm.edms.od.ODFolder.printDocs(Vector, String) Use ODFolder.printDocuments(java.util.Vector, java.lang.String, int) com.ibm.edms.od.ODServer.retrieve(String, String, String) See ODFolder.recreateHit(String DocID) and ODHit.retrieve(String Viewer) com.ibm.edms.od.ODServer.setApplicationName(String) Use ODServer.initialize(String applicationName) com.ibm.edms.od.ODServer.setLocalDir(String) com.ibm.edms.od.ODCriteria.setOperand(int) Use ODCriteria.setOperator(int) com.ibm.edms.od.ODServer.setServer(String) Replaced with ODServer.setServerName(java.lang.String). com.ibm.edms.od.ODFolder.setSortEnabled(boolean) Use ODFolder.setSortLocation(char) com.ibm.edms.od.ODFolder.storeDoc(String, String, String, String[]) Use ODFolder.storeDocument(java.lang.String, java.lang.String, java.lang.String, java.lang.String[]) com.ibm.edms.od.ODUser.update() Use ODUser.updateUserPrintOpts() com.ibm.edms.od.ODHit.update(Hashtable) Use ODHit.updateValuesForHit(Hashtable) com.ibm.edms.od.ODHit.update(Vector, Hashtable) use ODFolder.updateValuesForHits(java.util.Vector, java.util.Hashtable) com.ibm.edms.od.ODFolder.updateDocs(Vector, Hashtable) Use ODFolder.updateValuesForHits(java.util.Vector, java.util.Hashtable) com.ibm.edms.od.ODCallback.waitForOperation() No longer used - Support for the AFP2xxx transforms using a Shared Library have been removed. Only the Executable methods are supported in 8.4.x.x. 3.6.8.4.0.1 Release (8.4.0.1) APARs: PK53263 - ODFolder.setServerPrinterData() causes a JVM crash - Corrected the order in which the Print structure is freed PK52970 - CSVUPDATE Doc fails with Hitlists having >1 APPLGRP - Redesigned the DocUpdate function for multiple AppGrps PK51480 - ODFolder.search(sql,date1,date2) can fail - Corrected default date format processing PK50860 - Memory leak when uncompress files exceed CompMemsize - Needed to free the Tempfile Name string PK49279 - ODWEK crash: ODServer.logoff after ODServer.terminate - Made sure that Invalid API usage of Logoff after terminate could not cause a core. PK47037 - ODServer.getApplicationGroup() crashes ODWEK - Corrected folder handling in the scenario where a folder may not be opened yet. PK47031 - ODServer.BuildFolder() SIGSEGV AppGrp w/fld mappings - Corrected potential problems with mapping types. PK46254 - ODHitProperties.getLoadName() returns invalid information - Corrected API to return the correct value for LoadName PK44280 - Incorrect ODWEK API usage can cause SIGSEGV - Corrected check in ODHit.update() to correctly handle the case where the ODServer is logged off/terminated. 3.6.8.4.0.2 Release (8.4.0.2) APARs: PK56039 - Mem leak can crash ODWEK logging into zOS V2 mig server - Changed common client code to free migration server information at Logoff PK60093 - MultiThread Error handling with large doc temp files - Ensured all file handling pointers are freed during error handling PK61373 - ODHit.update() ODHit.updateValuesForHit() causes crash - Updated the ICU string upper and lower functions to handle null strings PK62618 - Small memory leak in Client Server Communications - Made sure an allocated string buffer is freed PK64105 - JVMJNCK037E JNI ERROR IN DELETELOCALREF: ARGUMENT #2 - Added additional JNI exception checking -------------end of Java API--------------------------------------------------- ----------------end of Web Enablement Kit Change History----------------------- 4. OnDemand Testing Environment ------------------------------------------------------------------------------- This following is a list of the environments in which IBM tested the latest Release/PTF. JVM: Java 1.4.2 (32 and 64 bit) AIX: AIX 5L for POWER 5.3 HP-UX: HP-UX V11i V2 SunOS: Sun Solaris V10 Windows: Windows - 2003, XP SP2, Vista (32-bit and 64-bit) only for the Applets and Web Viewers Linux: RedHat - Linux RedHat (RHEL) 4 SuSE - Linux SUSE (SLES) 10 Linux on System z: RedHat - Linux RedHat (RHEL) release 5 U0 SuSE - Linux SUSE (SLES) 10 SP0 -----------------end of OnDemand Testing Environment--------------------------- 5. Reference ------------------------------------------------------------------------------- You can find information updates by searching the Web Based Technical Support web site at: http://www.ibm.com/software/data/ondemand/mp/support.html You can find the following additional documents by entering the document # or title in the search field: Document # Document title 1269183 IBM Web Interface for Content Management known issue: Configuring ODWEK V8.4 for use with IBM WEBi 1273746 Using the ODWEK API ODConfig class with AFP Transforms 1273335 I am using the ODWEK servlet with CacheUserIDs set to cache my OnDemand user ID, but I still see a logon performed in the OnDemand server 1281852 After upgrading ODWEK CGI to V8.4.0.0, I now receive an error when invoking the ODWEK CGI 1288974 How do I verify the version of the line data applet viewer? 1288404 Can the line data applet toolbar be customized? 1288538 Does ODWEK have a configurable timeout to stop an operation if it is taking too long? 1290066 Does ODWEK support the /3GB switch in Windows? 1295357 Scrolling or repeatedly opening an AFP document in the AFP Web Viewer Plug-in causes a browser crash 1297617 Using the AFP2PDF transform with ODWEK, only the first 100 pages of the document is retrieved 1300109 Does the AFP Web Viewer Plug-in support Microsoft Windows Vista? 1300112 Is there any way to specify a default zoom setting in the AFP Web Viewer Plug-in? -----------------end of Reference----------------------------------------------