IBM DB2(R) Content Manager Client for Windows Version 8.2 with Multi-server Support ReadMe Please read all the instructions in this file before you install the Client for Windows. CONTENTS 1.0 ABOUT THIS README FILE 2.0 NEW FEATURES 2.1 Federated support 2.2 Basic search improvements 2.3 Preferences dialog 2.4 Additional dialog improvements 2.5 Language support 2.6 Support for attribute groups 2.7 Service level information on the About dialog 3.0 REQUIREMENTS 3.1 Federated connections 3.2 zOS connection 3.3 Required DB2 level 3.4 Privilege settings required for installation 4.0 LIMITATIONS 4.1 Incompatibility with previous Client for Windows versions 4.2 Document routing not supported for federated connections 4.3 IP/390 support 4.4 DisableURLCode 4.5 QueryPrivilege 4.6 Mime Types 4.7 Federated-to-native connection limitation 5.0 ADDITIONAL INFORMATION 5.1 Cleanup issues when uninstalling or upgrading 5.2 Known Issues and Fixes 5.3 User Exits 5.4 NativeCompArray 5.5 ICMClientOLE.h 5.6 Keeping annotation selected for repeated use 5.7 Capturing viewer traces 5.8 TRACE logging restriction 5.9 Sample Code 6.0 NOTICES 6.1 Trademarks and Service Marks -------------------------------------------------------------------- 1.0 ABOUT THIS README FILE This file provides all release notes for Client for Windows Version 8.2 with Multi-server support. Open the README file with any ASCII text editor. -------------------------------------------------------------------- 2.0 NEW FEATURES 2.1. Federated support Client application users can now bundle searches into a single federated search, instead of searching for information on a server-by-server basis, using search templates. Your system administrator creates these search templates by creating federated entities that map their federated attributes to native attributes on content servers. A federated entity does not store data; it stores metadata about how each content server stores data. The Client for Windows with Multi-server Support provides an interface to manage federated server mapping and connections. The addition of multi-server support in Client for Windows allows you to use the federation capability of Information Integrator for Content(EIP) to access multiple DB2 Content Manager Version 8.2 and IP/390 servers simultaneously. The logon window indicates the type of available servers; federated servers are indicated with (FED) next to the server name and Content Manager Version 8.2 servers are indicated with (CM8). You can identify the user ID you are logged on with and which server you are logged on to in the main window's title bar. The Manage Server Connections dialog lets you manage the user IDs and passwords that are used to log on to native Content Manager Version 8.2 and IP/390 servers. When you upgrade to the Client for Windows with Multi-server support, you can reuse existing configuration settings from your 8.2 ini and registry files. You may need to update some minor settings, for example, column width settings. 2.2 Basic search improvements Additional search operators: "Greater than or equal to" and "Less than or equal to" operators are now available. 2.3 Preferences dialog You can now apply changes in the Preferences notebook without the need to close it. You can also specify that a single item open automatically if it is the only item returned from a search. You can also specify that a folder is checked out automatically when opened. 2.4. Additional dialog improvements Improved Import, Scan, and Create New Folder windows have a new "Save as Default" button that allows you to set and reuse default values when creating items. These dialogs also have a new "Preferences..." button that allows you to change the order of the attribute display when creating items. 2.5 Language support Additional translations of the ODMA support component have been added: Czech, Hungarian, Polish, Russian, Slovakian and Slovenian. 2.6 Support for attribute groups The System Administration Client allows you to combine frequently-used attributes into groups for reuse in item types. Putting individual attributes into an attribute group allows you to insert several attributes into the item type at the same time. The Client application now supports the use of these attribute groups. 2.7 Service level information on the About dialog The About window now provides more specific product version information to aid in software support. -------------------------------------------------------------------- 3.0 REQUIREMENTS 3.1 Federated connections If your Content Manager Version 8.2 server resides on an AIX system, ensure that FixPack 2 or higher is installed on the server. Client for Windows with Multi-server support is only supported for use with Content Manager Version 8 and IP/390 servers. 3.2 zOS connection In order to connect to Content Manager on zOS from the Client for Windows, you must first install DB2 Connect Personal Edition on the client machine. 3.3 Required DB2 level IBM's DB2 Run-Time Client is required for the DB2 Content Manager Client for Windows to function. The client's Install program checks for the DB2 Run-Time Client and will display a warning if its level is lower than DB2 Version 7.2 FixPak 8. If you previously installed the DB2 Version 7.2 Special FixPak 7 for IBM Content Manager Version 8.1, we recommend that you upgrade to FixPak 8 or above, but upgrading is optional. For further information on DB2 and other prerequisites, see the Client for Windows software requirements section in Chapter 6 of the Planning and Installing Your Content Management System document. 3.4 Privilege settings required for installation During installation, you may need to add or update some files under the Windows directory (for example, C:\WINNT). On multi-user systems, such as Windows NT and Windows 2000, the Client must be installed from a user ID, such as Administrator, that has Full Control permissions to the Windows directory and its subdirectories. -------------------------------------------------------------------- 4.0 LIMITATIONS 4.1 Incompatibility with previous Client for Windows versions This version of the Client for Windows cannot co-exist with previous 8.1 or 8.2 Clients. The installation for this re-released version detects and uninstalls the older versions of the Client. Do not subsequently install the original Version 8.1 or 8.2 Clients, as those installation programs will not detect or uninstall this Client. If it is necessary to install an older version of the Client, you must explicitly uninstall this version first. 4.2 Document routing not supported for federated connections You cannot access document routing or work management capabilities when logged on to a federated datastore. 4.3 IP/390 support IP/390 access is read-only. 4.4 DisableURLCode In order to retrieve documents from a CM/390 Resource Manager, you must disable the Client's URL-based part retrieval. To do this, make sure the following line appears in the "[Options]" section of the ICMClient.ini file, which is located in the Windows directory: DisableURLCode=yes The default value for this option is "no". 4.5 QueryPrivilege This API enables OLE clients to perform custom authentication, in addition to those being performed by the client. For example, OLE client can check if users have "itemquery" privilege on a worklist. In the DB2 Content Manager v8.2 Client, any string could be passed to the QueryPrivilege method in the Application class. In the Multi-Server Support version of the Client, this method has been changed to only accept pre-defined Content Manager Version 8 privilege strings, such as "ItemQuery" or "ClientImport", or any of the new OLEAPI_PRIV_* constants documented in the Programming Reference. All of the pre-defined privilege strings whose names begin with "Item" or "Client", except "ItemSuperAccess" and "ItemAddToDomain", will be accepted. Any other string generates an exception. 4.6 Mime Types In the Multi-server Support version of the Client, IP/390 has the following hard coded mime type (content class): image/bmp application/octet-stream image/g3fax image/gif image/jpeg image/x-dcx text/html text/plain text/xml application/dca-rft application/msword application/pdf application/rtf application/vnd.lotus-wordpro application/vnd.ms-excel application/vnd.ms-powerpoint image/tiff application/vnd.ibm.modcap Users who have stored documents on an IP/390 server with mime types not listed here, may not be able to configure an alternate viewer using the Preferences dialog. These docs will always be opened in the standard viewer. 4.7 Federated-to-native connection limitation If you connect to a federated server during logon, and then skip a native server in the Manage Server Connections window, you may experience unexpected behavior from the Client if you try to connect to the skipped native server. To establish a connection, restart the Client, log on to the federated server, and connect to the native server using the Manage Server Connections window. -------------------------------------------------------------------- 5.0 ADDITIONAL INFORMATION 5.1 Cleanup issues when uninstalling or upgrading If you uninstall the Client for Windows or ODMA, the Client's directory may not be removed. If this directory ("C:\Program Files\IBM\CM82\Client" by default) is empty except for log files, you can manually remove it. If you upgrade from Content Manager Version 8.1 or 8.2, and you install Content Manager Version 8.2 with Multi-server Support to a different directory, you can manually remove the old directory. If you installed ODMA and you uninstall it or upgrade from Content Manager Version 8.1 or 8.2 to Content Manager Version 8.2 with Multi-server Support, the directories mentioned in the paragraph above may remain in the Path environment variable. As with removing the directory itself, if the directory is empty except for log files, you can manually remove it from the Path environment variable. Before re-installing an older version of Client for Windows, you must manually remove ICMClientAttrs.ocx from the Windows system directory. Failure to remove this file will cause the following error message to be displayed when the older version of Client for Windows is launched: Not enough memory available to open the window. 5.2 Known Issues and Fixes 5.2.1 Client Application Error when first installed When the Client is first installed, it may display an application error and close. The problem is most likely to occur when migrating from older versions of the Client. This behavior will only happen once, and the fix is to restart the Client. 5.2.2 Viewer registration When the client is first installed, an error message may appear and the viewer may not work. Open it in stand-alone mode to register the viewer to fix this problem permanently. 5.2.3 Enclosing string values in single quotes For OLE users, if the data model contains view, entity, or attribute names that are the same as keywords in the Content Manager version 8 (XQPE) query grammar, be sure to enclose the string values of ItemTypeViewName and the appropriate entity and attribute names within the QuerySubString parameters with single quotes before passing them to the Application::Search() method. Enclosing entity and attribute names within single quotes is not necessary for federated query strings. 5.2.4 QuerySort does not function across federated connections. Additionally, process-aware searches do not pass DOCROUTING attributes to QuerySort, so the user exit will never contain DOCROUTING information. 5.2.5 Include decimal point values in Search conditions decimal attribute values When specifying a search condition against decimal attributes, be sure include a decimal point value to avoid getting incorrect search results. For example, enter a value of 999 as 999.00, depending on the attribute properties. The decimal point value is automatically appended to the value in the Basic Search dialog and when initially creating the query in the Advanced Search dialog. However, it is important to explicitly include the decimal point value when specifying decimal values in the Advanced Search user-prompted parameter form, and when editing the query in the Advanced Search dialogs. 5.2.6 Refresh Item Lists after updating versioned items Updating the attributes of open document in a versioned item type can result in two known problems: editing the representative attribute will not update the open document's title bar, and several action menu items will be disabled. The list of menu items includes: "Attributes", "Notelog", "Versions list", and "History log". To fix this problem, close the document and refresh the item list by pressing the F5 key. 5.2.7 All System Time Stamps are in GMT System time stamps, such as "Last Modified TimeStamp" and "Created TimeStamp", will always be in GMT. This problem is scheduled to be corrected in a future fixpack. 5.3 User Exits Following is the list of user exits supported on the federated connection: Resource Manager Storage (ChangeSMS) : Available only for reindexing an item Save(SaveRecord) : Available for import, scan, adding to a new folder, changing attributes, changing an attribute to change the item type Sort(QuerySort) : Available for selecting folder TOC Attribute Values : Available for import, scan, adding to a new folder, changing attributes, changing an attribute to change the item type User Options : Available for item(s) selected in the search table of contents whose native server is a Content Manager version 8 server Note: Search(Alternate Search) is not supported over federated connections. 5.4 NativeCompArray In the Programmer's Reference documentation, the Item class method NativeCompArray should read: "Parameters: ComponentName as VT_BSTR", instead of "Parameters: ComponentName as VT_VARIANT". 5.5 ICMClientOLE.h The following constant is not defined in the documentation: #define OLEAPI_RC_METHOD_NOTSUPPORTED 12043 An exception will be returned with this code if an unsupported method (for the server type) is called. 5.6 Keeping annotation selected for repeated use To keep an annotation selected for repeated use, change the value of the "Keep annotations selected" key in the registry, located at HKEY_CURRENT_USER -> Software -> MS Technology Inc -> Modcaviewer -> Preferences from "disable" to "enable". 5.7. Capturing viewer traces To capture viewer traces, change the value of "Trace logging enable" key in the registry, located at HKEY_CURRENT_USER -> Software -> MS Technology Inc -> Modcaviewer -> Preferences from "off" to "on". This will create a trace file labeled MSTechLog.txt in the root (c:\) directory. 5.8 TRACE logging restriction Occasionally, the client may appear to hang and use 100% of your CPU. This problem is scheduled to be corrected in a future fixpack. Trace logging seems to cause this to occur more frequently. The only time you should have TRACE logging enabled is when you are working with IBM support to diagnose a problem. Any other time, you should have logging set to ERROR only. 5.9 Sample Code Refer to the SAMPLES directory for specific code samples. -------------------------------------------------------------------- 6.0 NOTICES This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation J46A/G4 555 Bailey Avenue San Jose, CA 95141-1003 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. You may copy, modify, and distribute these sample programs in any form without payment to IBM for the purposes of developing, using, marketing, or distributing application programs conforming to IBM's application programming interfaces. 6.1 Trademarks and service marks The following terms are trademarks of the International Business Machines Corporation in the United States, other countries, or both: IBM DisplayWrite PowerPC 400 e-business PTX Advanced Peer-to-Peer Networking HotMedia QBIC AIX Hummingbird RS/6000 AIXwindows ImagePlus SecureWay APPN IMS SP AS/400 Micro Channel VideoCharger C Set ++ MQSeries Visual Warehouse CICS MVS/ESA VisualAge DATABASE 2 NetView VisualInfo DataJoiner OS/2 WebSphere DB2 OS/390 DB2 Universal Database PAL Approach, Domino, Lotus, Lotus 1-2-3, Lotus Notes and SmartSuite are trademarks or registered trademarks of the Lotus Development Corporation in the United States, other countries, or both. Intel and Pentium are trademarks or registered trademarks of Intel Corporation in the United States, other countries, or both. Microsoft, Windows, and Windows NT are registered trademarks of Microsoft Corporation in the United States, other countries, or both. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, and service names may be trademarks or service marks of others.