DB2 Content Manager Enterprise Edition DB2 Content Manager for z/os

DB2 Content Manager Enterprise Edition DB2 Content Manager for z/os Version 8.4.2 Installing, Configuring, and Managing the eclient SC27-1350-09

DB2 Content Manager Enterprise Edition DB2 Content Manager for z/os Version 8.4.2 Installing, Configuring, and Managing the eclient SC27-1350-09

Note Before using this information and the product it supports, read the information in Notices on page 97. This edition applies to version 8, release 4, modification 2 of IBM DB2 Content Manager (product number 5724-B19) and version 8, release 4 modification 2 of IBM DB2 Content Manager for z/os (product number 5697-H60) to all subsequent releases and modifications until otherwise indicated in new editions. Copyright International Business Machines Corporation 2001, 2009. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents ibm.com and related resources..... v How to send your comments......... v Contacting IBM............. vi Getting started with your eclient installation............. 1 eclient overview........... 3 Requirements for the eclient...... 5 Hardware and software requirements for the eclient 5 Network................ 5 Skill................. 5 Information to collect........... 5 Planning and installing the eclient... 9 Planning for the eclient.......... 9 Planning user IDs........... 9 Planning for performance......... 10 Installing the DB2 Content Manager Standard eclient................ 11 Installing and configuring the eclient...... 11 eclient installation on Windows...... 12 Installing the eclient on AIX, Solaris, or Linux. 12 Installing the eclient on a cluster...... 13 Verifying the eclient installation and configuration............. 14 Configuring and deploying the eclient.... 14 Manually setting WebSphere variables.... 15 eclient upgrade............. 16 eclient configuration for use with WebSphere Application Server.... 17 Configuring WebSphere Application Server connection pooling for use with the eclient.... 17 Verifying that the eclient uses connection pooling............... 19 Configuring the eclient for single sign-on (SSO).. 19 Enabling single sign-on in the DB2 Content Manager library server......... 20 Updating privilege sets for use with single sign-on............... 20 Configuring WebSphere Application Server for SSO................ 21 Verifying the SSO configuration...... 21 Selecting eclient languages......... 22 Starting, stopping, and connecting to the eclient............. 25 Starting the eclient server......... 25 Stopping the eclient server......... 26 Connecting to the eclient in a Web browser... 26 Customizing your eclient application 29 eclient JavaServer Pages (JSP)........ 29 Customizing eclient graphics........ 33 Customizing eclient help.......... 34 Customizing the viewer applet........ 35 Managing the eclient........ 37 Modification of eclient files......... 37 Modifying eclient files on unmanaged nodes.. 37 Modification of eclient files on managed nodes or a cluster............. 38 Setting and changing your configuration parameters 39 Setting the caching directory........ 40 Setting the maximum number of search results displayed on a page.......... 40 Setting the maximum number of search results returned from the content server...... 40 Setting the maximum file size allowed during import............... 40 Setting the search timeout value...... 40 Setting the callback threshold....... 41 Setting the search mode......... 41 Enable saved searches.......... 41 Configuration of link relationships...... 41 Showing the start on process menu..... 42 Configuring the property daemon...... 42 Set the configuration file location...... 42 Setting the connection type........ 43 Setting the location of the DB2 Content Manager Version 8 server initialization file...... 43 Set the e-mail properties......... 43 Enable advanced workflow........ 44 Enabling document routing........ 44 Enable federated folders......... 44 Setting the service connection type..... 45 Enable content files to start........ 45 Viewer applet configuration........ 45 Enabling the Line Data Viewer Java applet... 47 Configuring notelog encoding....... 47 Content Manager OnDemand Folder Support.. 48 Advanced Function Presentation viewer large object support............ 48 Defining how the eclient handles content types.. 48 Content types............ 49 Configuring parameters for a customized client.. 50 Define server connections.......... 51 Defining an Content Manager OnDemand server connection.............. 52 Defining an ImagePlus for OS/390 server connection.............. 52 Defining a DB2 Content Manager for iseries (VI400) server connection......... 53 Removing the eclient........ 57 Removing the eclient files......... 57 Copyright IBM Corp. 2001, 2009 iii

eclient configuration removal........ 57 Removing the eclient........... 58 z/os eclient removal........... 58 Performance tuning the eclient application............. 59 Analyzing eclient performance using eclient log files................. 60 Analyzing HTTP Server performance..... 60 Analyzing eclient server performance.... 61 Locating the eclient log files....... 62 Troubleshooting the eclient..... 63 Tracing the eclient............ 63 Troubleshooting configuration problems..... 64 Troubleshooting scenarios for eclient...... 64 eclient auto deploy fails during a Linux installation............. 66 Corrupted international characters...... 66 Cannot start document......... 67 Warning message in the final install panel... 67 Cannot display Visio documents...... 68 Browser timeout during an Content Manager OnDemand search........... 68 Cannot view Content Manager OnDemand Advanced Function Presentation files..... 68 Java Virtual Machine (JVM) crashes..... 69 Cannot reload a page.......... 71 Cannot use the viewer applet....... 71 In a clustered environment, sometimes the viewer applet cannot open Microsoft Office documents.............. 72 Updating cmbcm81.jar and cmbicm81.jar API libraries do not affect eclient....... 72 eclient installation fails from a Java crash... 73 Problem with eclient installation on Windows machines running Terminal Services..... 73 eclient viewer applet fails to display..... 74 eclient PDF document retrieval does not work or is very slow............. 74 Establishing a connection to DB2...... 75 Change password fails with Client for Windows or eclient.............. 75 eclient document display is poor...... 76 Cannot change an operating system password for DB2 Content Manager for iseries (VI400) if the password is expired.......... 77 eclient import operation takes a long time to complete.............. 77 Restriction on parametric search with double quotations marks........... 78 Cannot create a successful eclient application in WebSphere Application Server by using an incompatible OEM code page....... 78 IBM Java plug-in does not recognize the signed applet............... 78 eclient supports only Simplified Chinese (zh_cn) and Traditional Chinese (zh_tw)... 79 AIX shows the Japanese Yen symbol as a backslash.............. 79 Stream media to the eclient........ 80 Accepting and continuing a work item to the next node.............. 80 Opening an eclient document from a remote browser.............. 80 eclient search exceeds the number of results that a server can handle........... 81 eclient response time is very long due to insufficient memory.......... 81 Cannot display all search results...... 82 Cannot log on to the eclient........ 82 Preferences window is not available if the toolbar is disabled.............. 83 Cannot open JPG files in the viewer applet... 83 eclient export function does not work.... 84 eclient federated search template displayed only the first of multiple values........ 84 Direct retrieval to eclient requires file names with only US-ASCII characters....... 84 eclient foreign keys require an item type to hold the values.............. 85 Re-configuring ICMCONCT if it fails to log into the eclient.............. 86 The z/os eclient is unable to view double byte characters.............. 86 Safari browser problem in Macintosh environment with the eclient viewer applet.. 87 Unsupported VI/400 functions in eclient... 87 Deploying eclient on WebSphere Application Server on z/os............ 87 Finding the eclient for the z/os application on the WebSphere Application Server administrative console............... 88 Configuration wizard creates multiple eclient applications............. 88 Prevent Firefox 2 automatic image resizing and view images at actual size........ 88 Behavior issue when browser s automatic prompting for file downloads is set to disable.. 89 The eclient is FDCC compliant with one exception.............. 89 eclient 8.4 fixpack installation on managed node might require a solution......... 90 Integrating the AFP2PDF transform in the eclient 91 Cannot open TIFF document files...... 92 Removing items from a locked folder has inconsistent behavior between releases.... 92 Updating annotations........... 93 Appendix. Accessibility information.. 95 Notices.............. 97 Trademarks.............. 99 Index............... 101 iv Installing, Configuring, and Managing the eclient

ibm.com and related resources Product support and documentation are available from ibm.com. Support and assistance Product support is available on the Web. Click Support from the product Web site at: DB2 Content Manager http://www.ibm.com/software/data/cm/cmgr/mp/editionenterprise.html DB2 Content Manager for z/os http://www.ibm.com/software/data/cm/cmgr/390/ Information center You can view the product documentation in an Eclipse-based information center that you can install when you install the product. By default, the information center runs in a Web server mode that other Web browsers can access. You can also run it locally on your workstation. See the information center at http://publib.boulder.ibm.com/infocenter/cmgmt/v8r4m0/index.jsp. PDF publications You can view the PDF files online using the Adobe Acrobat Reader for your operating system. If you do not have the Acrobat Reader installed, you can download it from the Adobe Web site at http://www.adobe.com. See the following PDF publications Web sites: Product DB2 Content Manager DB2 Content Manager for z/os Web site http://www.ibm.com/support/docview.wss?rs=86 &uid=swg27015910 http://www.ibm.com/support/docview.wss?rs=119 &uid=swg27015911 Related reference How to send your comments Contacting IBM on page vi How to send your comments Your feedback is important in helping to provide the most accurate and highest quality information. Send your comments by using the online reader comment form at https://www14.software.ibm.com/webapp/iwm/web/signup.do?lang=en_us &source=swg-rcf. Copyright IBM Corp. 2001, 2009 v

Contacting IBM Consumability survey You are invited to tell IBM how to improve the consumability of software products. If you want to help IBM make DB2 Content Manager easier to use, take the Consumability Survey at http://www.ibm.com/software/data/info/ consumability-survey/. To contact IBM customer service in the United States or Canada, call 1-800-IBM-SERV (1-800-426-7378). To learn about available service options, call one of the following numbers: v In the United States: 1-888-426-4343 v In Canada: 1-800-465-9600 For more information about how to contact IBM, see the Contact IBM Web site at http://www.ibm.com/contact/us/. vi Installing, Configuring, and Managing the eclient

Getting started with your eclient installation After you plan your eclient installation, wizards can guide you though installing and configuring the eclient. The following table summarizes and links to the high-level tasks for installing, configuring, and managing the eclient. Installation or configuration task What you can do When to perform Install hardware and software requirements Plan for the eclient Install and configure the eclient Configure the eclient for use with the WebSphere Application Server Customize your eclient application Manage the eclient Remove the eclient Install all the operating system prerequisites. Analyze your business needs to determine your eclient configuration options. The installation wizard and configuration wizard will guide you through the eclient installation. Enable connection pooling and single sign-on. Customize your eclient JavaServer Pages (JSP), graphics, help files, and viewer applet to meet the needs of your organization. Modify configuration parameters, define how the eclient handles content types, and define server connections. Start the uninstallation wizard to remove the eclient. Perform before you begin the product installation. Perform before you begin the product configuration. Perform once to install and configure the product. Perform once after you install the product. Perform as needed after you install the product. Perform as needed after you install the product. Perform once to remove the eclient. Copyright IBM Corp. 2001, 2009 1

2 Installing, Configuring, and Managing the eclient

eclient overview The eclient is a Web application that enables users to search for and retrieve documents from content servers. The eclient supports the following content servers: v DB2 Content Manager Version 8 v OS/390 for OS/390 Version 3.1 v DB2 Content Manager for iseries Version 5.1, Version 5.3 (formerly known as IBM VisualInfo for AS/400 ) v Content Manager OnDemand for z/os v Content Manager OnDemand i Linux only: The eclient for Linux supports the following content servers: v DB2 Content Manager Version 8 v DB2 Content Manager for z/os Version 8.3 and later v Content Manager OnDemand for z/os v Content Manager OnDemand i Linux on only System z and z/os: The eclient for Linux on System z and the eclient for z/os supports the following content servers: v DB2 Content Manager Version 8.3 and later With the eclient, you can connect to a IBM DB2 Information Integrator for Content federated server, and perform searches across a variety of data sources simultaneously. You can also use the eclient to connect directly to content servers. The eclient supports IBM DB2 Information Integrator for Content Version 8.4.2 workflow, and DB2 Content Manager Version 8.4.2 document routing. The eclient Web application consists of JavaServer Pages (JSP), servlets, and a viewer applet that run on the WebSphere Application Server. The eclient also includes cascading style sheets, property files, and so forth. You can customize the eclient to meet the needs of your organization. The document is written primarily for users who want to install and configure eclient, who use IBM WebSphere Application Server, WebSphere Application Server Network Deployment, or IBM WBI Server Foundation, or who have knowledge of Java 2 Platform, Enterprise Edition (J2EE) application servers, and who are familiar with IBM DB2 Information Integrator for Content. Restriction: For Linux on System z, the eclient is not supported on WebSphere Application Server Network Deployment. Copyright IBM Corp. 2001, 2009 3

4 Installing, Configuring, and Managing the eclient

Requirements for the eclient The information that you should collect before you install the eclient depends on the type of content server to which you plan to connect. Related concepts Hardware and software requirements for the eclient Network Skill Information to collect Hardware and software requirements for the eclient Network Skill Information to collect The official statements of support for the eclient are provided online. See the supported hardware and software Web page for the complete, up-to-date information about what is supported. If there is a conflict between the information provided in the information center and the information on the supported hardware and software page, the information on the Web site takes precedence. Prerequisites information in the information center is provided only as a convenience. Related reference Supported hardware and software The eclient servers require that you use TCP/IP as the communication protocol. Usually, your operating system automatically installs the necessary TCP/IP software. If you do not have TCP/IP on your system, see your operating system information for instructions about how to install the software. There are skill requirements for the eclient. This document assumes that you know how to install and configure the following products: v Your DB2 Content Manager portfolio product v Databases, primarily DB2 Universal Database or Oracle v IBM WebSphere Application Server v IBM HTTP Server Connecting to a content server means having to supply some specific information. Before you install the eclient, collect the following information: v WebSphere Application Server information Node name Copyright IBM Corp. 2001, 2009 5

v v v v v v Server name Cluster name (if you plan to deploy the eclient on a cluster) eclient server name eclient Web application name eclient Web context root Application server security state (enabled or disabled). Restriction: If application server security is enabled, you must know the application server administration ID and password. The location type of the workflow server. The options are local, remote, or dynamic. If the location type is remote or dynamic, the location of the workflow server must be determined. The eclient may access a content server (for example, CM8) that is on a Oracle database. Requirement: You must know the installation directory of Oracle to continue with the installation of the eclient. To connect to the DB2 Content Manager Standard Edition server, you need the following information: v Server type v Directory location of the cmbicmsrvs.ini file. The cmbicmsrvs.ini contains the DB2 Content Manager Standard Edition server connection information. If the file is stored on a remote location, such as an LDAP server, or HTTP server, you must know the path to the file on the remote server. The following table shows you the information to collect about the content server to which you are connecting. Table 1. Information to collect If you plan to connect to: DB2 Content Manager Version 8 server Content Manager for iseries (not supported on Linux on System z and z/os) Federated server (not supported on i5/os )(not supported on Linux on System z and z/os) You must provide this information: v v v v v v v v Server type Directory location of the cmbicmsrvs.ini file. The cmbicmsvrs.ini contains the DB2 Content Manager Version 8 server connection information. If the file is stored on a remote location, such as an LDAP server, or HTTP server, you must know the path to the file on the remote server. Server name Host name Port number Server type Directory location of the cmbds.ini file (cmbds.ini contains federated server connection information.) The location of the connectors. The options are local, remote, and dynamic. Important: If the files do not exist, or the locations are not set, users cannot log on to the eclient. 6 Installing, Configuring, and Managing the eclient

Table 1. Information to collect (continued) If you plan to connect to: You must provide this information: Content Manager v Host name. You must enter a fully qualified host name. OnDemand server (not v Port number. The default port number is 1445. supported on Linux on System z and z/os) v Alias name. The alias name is displayed to eclient users. ImagePlus for OS/390 server (not supported on Linux, Linux on System z, and z/os) Alias name An alternate name for the server; this name appears in the list of servers your users see. Use a name that is familiar to your users. The alias name can contain blanks or special characters, but it cannot contain a colon. Application ID The identifier for the Folder Application Facility application. FAF IP address The IP address for the Folder Application Facility. FAF Port The TCP/IP port for the Folder Application Facility. FAF Protocol The communication protocol of the Folder Application Facility Host. FAF Symbolic ID The four-character identifier for the Folder Application Facility that owns and catalogs the documents associated with this datastore. This parameter is required for locking, adding, updating, or deleting annotations, and for locking folders and documents. ODM IP address The IP address of the Object Distribution Manager. ODM Port The port number for the Object Distribution Manager. ODM Terminal ID The terminal identifier for the Object Distribution Manager; if not specified the user ID is used. ODM Collection class The collection class where all form overlays are stored. If not specified, forms are searched for in the collection class where the last document was retrieved. ODM Protocol The communications protocol of the object distribution manager host. ODM Storage Location Control The document storage location. You can set this to DASD to retrieve documents from only DASD, OPTICAL to retrieve documents from only DASD or OPTICAL, or SHELF to retrieve documents from DASD, OPTICAL, or SHELF. Requirements for the eclient 7

8 Installing, Configuring, and Managing the eclient

Planning and installing the eclient Planning for the eclient When you plan your eclient system, include performance planning to ensure that you have the right amount of disk space, system memory, and the correct software prerequisite level. During the eclient installation, the copy and paste operation is not supported so you must type any passwords directly into the Password fields. Related tasks Planning for the eclient Installing the DB2 Content Manager Standard eclient on page 11 Installing and configuring the eclient on page 11 eclient upgrade on page 16 Installing and configuring the z/os eclient Planning for the eclient involves analyzing your business needs to determine your eclient configuration options. Planning for the eclient covers your eclient installation, configuration, and deployment. Related tasks Planning user IDs Planning for performance on page 10 Planning user IDs A privilege is the right to access a specific object in a specific way. Each user ID has privileges that control the actions that users can perform on content server documents and folders. When your users log on to the eclient, they connect to a content server (for instance, DB2 Content Manager Version 8). The user ID that your eclient users enter when they log on to the eclient is created by the content server administrator. Privileges include rights, such as being able to log on to a system, or create a user as well as reading, writing, or deleting an item, a worklist, or an annotation. Privileges represent individual user actions on content server objects. Restriction: The eclient enforces no privilege checking to restrict the e-mailing of a document. If the user can view the document, then the user can e-mail it too. Tip: For Windows and Linux eclient, if you administer the federated database and the eclient, the information in this paragraph does not apply to you. When users connect to a federated database and run a search template, the eclient attempts to connect to multiple content servers by using the user ID that was entered to log on to the federated database. Depending on the federated database configuration, your users might need to enter user IDs for each content server that is accessed by a search template. Find out the following information: Copyright IBM Corp. 2001, 2009 9

v v Did the federated database system administrator enable user mapping? If yes, then the user ID that was entered to log on to the federated database is used to access and search for data on all content servers that are programmed in the search template. If user mapping is disabled, find out the user IDs and passwords for each content server that is programmed in the search template. Your users are prompted to enter user IDs and passwords to log on to each content server that is programmed in the search template. Planning for performance Your eclient configuration choices involve performance trade-offs. When you plan your eclient system, include performance planning to ensure that you have the right amount of disk space, system memory, and the correct software prerequisite level. The following list provides some topics to consider when planning for eclient performance. v What is the amount of available server disk space and RAM? v What is the projected workload for both typical users and peak hours? v What is the number of eclient users? v v v v What is the number of operations per hour per user for tasks such as searching, viewing, importing, updating, document routing, and so forth? What is the average document size and number of pages? What other workloads will be running on the system along with the eclient? Do you plan to use features that have significant performance impact, such as image conversion, versioning, advanced data modeling, replication, text search, and so forth? The following table provides information about configuration choices and the potential impact on eclient performance. The information is provided to help you analyze the positive and negative results that might result from a system configured around key performance issues. For example, if you configure your eclient to use versioning, you must provide more disk space for your library server, so that the library server can store the data for each version. Table 2. eclient configuration choices and performance trade-offs Configuration choices Performance trade-offs Direct retrieve, or federated access? v Federated access is slower than a direct connection to the library server. When you connect to a library server, you can search for data on that single server. The federated database searches for information on multiple servers v Federated access supports search across heterogeneous content servers Connection pooling? v Connection pooling makes more efficient use of library server resources v Scales to larger number of eclient users v Connection pooling allows more control of middle-tier impact on library server resources. 10 Installing, Configuring, and Managing the eclient

Table 2. eclient configuration choices and performance trade-offs (continued) Configuration choices Performance trade-offs Versioning? v Versioning increases the library server database size v Accessing current versions is faster than accessing earlier versions Installing the DB2 Content Manager Standard eclient In Version 8.3, the Standard eclient can only be installed as part of the DB2 Content Manager Standard server. For instructions on how to install DB2 Content Manager Standard, review the steps in the Standard Edition information center. Related information Info Center Installing and configuring the eclient You can set up the eclient by performing installation and configuration tasks. During the eclient installation, you must type any passwords directly in the Password fields. You cannot copy a password from another area and paste it in these fields. The copy and paste operation is not supported. Depending on where you plan to deploy the eclient, install the eclient on the appropriate computer as described in the following table. Deployment target Unmanaged node Managed node Cluster Computer on which to install the eclient eclient and II4C on the same computer. If the node is on a remote computer, then II4C must be installed on that computer. II4C must be installed on each computer where cluster members exist. Important: eclient Version 8.4.2 will not create a separate application server for the eclient application like the eclient Version 8.3 does. It is the responsibility of the installer to create a separate application server if the installer does not want to deploy the eclient application on server1. The eclient application and the Web Services application cannot work properly when they are deployed on the same WebSphere Application Server. Related tasks eclient installation on Windows on page 12 Installing the eclient on AIX, Solaris, or Linux on page 12 Installing the eclient on a cluster on page 13 Verifying the eclient installation and configuration on page 14 Configuring and deploying the eclient on page 14 Manually setting WebSphere variables on page 15 Planning and installing the eclient 11

eclient installation on Windows You can run the installation program to install the eclient on Windows. To install the eclient on Windows: 1. Insert the eclient installation CD into the CD drive. The Launchpad starts automatically. If the Launchpad does not start automatically, change to the eclient directory and run the setup_win.bat script. 2. From the Launchpad, click Install to start the eclient installation program. 3. Follow the instructions in the installation windows to install the eclient. The default installation directory for the eclient is C:\Program Files\IBM\db2cmv8\ CMeClient. 4. To verify the installation, check the return code on the last screen of the installation program. If the return code is a value other than zero, check the IBMCMROOT/log/ecinstall.log file. The log file provides details about the installation step in which the error occurred, and also includes return codes. During the eclient installation, by default the environment variable IBMCMROOT points to /QIBM/ProdData/db2cmv8 for i5/os. You can map to the /QIBM/ProdData/db2cmv8 directory through the 5250 terminal using wrklnk, or through a mapped drive (as in nfs-mount). After the installation is complete, select the Launch the configuration wizard check box to configure and deploy the eclient. Installing the eclient on AIX, Solaris, or Linux You can run the installation program to install the eclient on AIX, Solaris, or Linux. To install the eclient on AIX, Solaris, or Linux: 1. Insert the eclient installation CD into the CD drive. 2. Log in as the root user or run the su-root command. Do not run the su root command (that is, without a hyphen). 3. If you are installing eclient by using an X window session, enter the following command to export the display: export DISPLAY=hostname:0.0 hostname is the host name or IP address where you want to be able to view the install panels. 4. From the eclient directory, enter one of the following commands to start the Launchpad (depending on your operating system): v setup_aix v setup_sun v setup_lnx 5. From the Launchpad, click Install to start the eclient installation program. 6. Follow the instructions in the installation windows to install the eclient. By default, the eclient is installed in the /opt/ibm/db2cmv8 directory. The data server list file is installed in the working directory of the user ID that was assigned to the DB2 Content Manager administrator. For example, on AIX and Linux, if the administrator user ID is ibmcmadm, then the working directory would be /home/ibmcmadm, and the data server list would be installed in /home/ibmcmadm/cmgmt/connectors/cmbicmsrvs.ini. On Solaris, the working 12 Installing, Configuring, and Managing the eclient

directory for icmadmin would be /export/home/ibmcmadm, and the data server list file would be installed in /export/home/ibmcmadm/cmgmt/connectors/ cmbicmsrvs.ini. 7. The following entries are necessary when the eclient is deployed on a platform other than Windows. v The LDR_CNTRL environment variable is set to MAXDATA=0x30000000. v The LD_LIBRARY_PATH environment variable is set to ${IBM_CM_WORKDIR}/ lib. v The LIBPATH environment variable is set to ${IBM_CM_WORKDIR}/lib:/usr/ lib:/usr/lpp/fmc/lib:/lib. 8. To verify the installation, check the return code on the last screen of the installation program. If the return code is a value other than zero, check the IBMCMROOT/log/ecinstall.log file. The log file provides details about the installation step in which the error occurred, and also includes return codes. After the installation is complete, select the Launch the configuration wizard check box to configure and deploy the eclient. Installing the eclient on a cluster Before you install the eclient on a cluster, you must first decide where you want to start the installation. You can start the installation from: The machine where the deployment manager is running. In this scenario the cluster environment is managed by the deployment manager. The machine that is a managed node of the deployment manager. In this scenario the deployment manager manages the cluster system. The machine that is a member of the cluster managed by the deployment manager. In this scenario the deployment manager manages the member of the cluster. Important: Wherever you choose to start the installation, you must remember that future fix packs must be installed the same way. To install the eclient on a cluster: 1. Start the eclient configuration. Option From the installation wizard From the command line Description Select the Launch the configuration wizard check box from the final window of the installation wizard. Change to the IBMCMROOT/bin directory and run the config_ec script. Requirement: If you run the configuration wizard on AIX, Solaris, or Linux, log in as the root user or run the su-root command. Do not run the su root command (that is, without a hyphen). 2. Click Add configuration. Planning and installing the eclient 13

3. Enter the eclient Web application name and Web application path. 4. Select the check box to specify the IBM_CM_PRODDIR and IBM_CM_WORKDIR WebSphere variables. 5. Identify the value of the variables: v IBM_CM_PRODDIR v IBM_CM_WORKDIR The eclient displays the default value for each variable depending on the operating system. For example, if you start the configuration from a Windows system, the default value for both variables is C:/Program Files/IBM/db2cmv8. If you start the configuration from an AIX system, the default value for IBM_CM_PRODDIR is /opt/ibm/db2cmv8 and the default value for IBM_CM_WORKDIR is /home/ibmcmadm. If there is a difference between each cluster member, you must modify the value for both WebSphere variables manually. Note: The IBM_CM_PRODDIR and IBM_CM_WORKDIR variables are also used scenarios other than a cluster. If their default values are different than the values on an end user s computer, the end user must set the values of these two variables to match those on their computer. 6. Select Cluster as the eclient application deployment target. 7. Select the cluster that you want to deploy the eclient application on. 8. Configure the user settings for the eclient runtime property. You can use the default settings, or you can customize all user properties. After finishing the eclient configuration, you can modify the runtime properties from the IDM.properties file. 9. Complete the remaining steps in the wizard. Verifying the eclient installation and configuration If the eclient failed to deploy successfully, there are some troubleshooting methods you can try. v Consult the IBMCMROOT/log/ecinstall.log file. You can also create the system environment variable IBM_CM_LOGLEVEL=7, and then re-install the eclient for more detailed error messages. v Consult the /QIBM/ProdData/db2cmv8/log/ecinstall.log. You can also create the system environment variable IBM_CM_LOGLEVEL=7 for more detailed error messages. The eclient trace log appears in /QIBM/ProdData/db2cmv8/log/eclient/eClientTrace.log. To add server types in the server list, edit the IDM.properties file. The IDM.properties file also provides an option that the server type is displayed in parentheses in the server list, for example, (ICM). Configuring and deploying the eclient You can run the configuration wizard to configure and deploy the eclient. To configure the eclient: 14 Installing, Configuring, and Managing the eclient

1. Start the configuration wizard according to the following table. Starting the configuration wizard From the installation wizard From the command line Command Select the Launch the configuration wizard check box from the final window of the installation wizard. Change to the IBMCMROOT/bin directory and run the config_ec script. Requirement: If you run the configuration wizard on AIX, Solaris, or Linux, log in as the root user or run the su-root command. Do not run the su root command (that is, without a hyphen). 2. Click Add configuration. 3. Follow the instructions in the windows to configure and deploy the eclient. See the configuration wizard s online help for complete descriptions of the information that you need to enter in each window. If you are upgrading from eclient Version 8.3, the eclient Version 8.4 configuration wizard imports the configuration settings from the earlier version. If you receive any errors from the configuration wizard, check the IBMCMROOT/log/ecconfig.log file. The log file provides details about the configuration step in which the error occurred. If you did not define values for the DB2 Content Manager installation directory and working directory WebSphere variables when you ran the eclient configuration wizard to deploy the eclient on a remote server, you must manually set the variables in WebSphere Application Server before you run the eclient. Important: When you run the configuration wizard multiple times in succession, the eclient saves each configuration under a different eclient application name. This results in the creation of multiple eclient applications. After you run the configuration wizard to configure and deploy the DB2 Content Manager eclient, do not run the configuration wizard again to modify the configuration. If you previously ran the configuration wizard to configure the eclient, you must run the configuration wizard to remove the eclient configuration before you again run the configuration wizard to re-configure the eclient application. Manually setting WebSphere variables If you did not define WebSphere variables for the DB2 Content Manager installation directory and working directory when you ran the eclient configuration wizard to deploy the eclient on a remote server, you must manually set the variables in WebSphere Application Server before you run the eclient. If you deployed the eclient on a cluster and the values for the WebSphere variables are not the same for all cluster members, you must manually set the variables for each cluster member. To set the WebSphere variables: 1. In the WebSphere Application Server administrative console, click Environment Manage WebSphere Variables. 2. Specify the scope of the variables. Planning and installing the eclient 15

eclient upgrade 3. Set the values of the following WebSphere variables: IBM_CM_PRODDIR Specify the path to the DB2 Content Manager installation directory. By default, the installation directory is C:\Program Files\IBM\db2cmv8 on Windows and /opt/ibm/db2cmv8 on AIX, Solaris, or Linux. IBM_CM_WORKDIR Specify the path to the DB2 Content Managerworking directory. The working directory stores DB2 Content Manager files that are created or updated during run time. On Windows, the default working directory is thedb2 Content Manager installation directory. On AIX, Solaris, and Linux, the home directory of the DB2 Content Manager administrative user is used as the working directory. The default value for the administrative user is ibmcmadm. The default value of the working directory is /home/ibmcmadm on AIX and Linux, and /export/home/ibmcmadm on Solaris. Related tasks Configuring WebSphere variables You can upgrade the eclient from Version 8.3 to Version 8.4.2. 1. Upgrade to WebSphere Application Server Version 6.1 or later. Ensure that Enforce Java 2 Security is disabled in the Security window of the WebSphere Application Server administrative console. 2. Upgrade to DB2 Information Integrator for Content Version 8.4.2. If you upgrade the eclient to remote servers (that is, to managed nodes), ensure that DB2 Information Integrator for Content Version 8.4.2 is installed on each remote server. 3. Install the version 8.4.2 eclient over the version 8.3 eclient. 16 Installing, Configuring, and Managing the eclient

eclient configuration for use with WebSphere Application Server The eclient can be configured for any of the WebSphere Application Server products. Related tasks Configuring WebSphere Application Server connection pooling for use with the eclient Configuring the eclient for single sign-on (SSO) on page 19 Selecting eclient languages on page 22 Configuring WebSphere Application Server connection pooling for use with the eclient WebSphere Application Server connection pooling enables a data store to scale to an indefinite number of users. Connection pooling also improves eclient performance by reducing logon time and memory usage. You must manually configure connection pooling. The federated connector and DB2 Content Manager Version 8 connectors both use the WebSphere Application Server JDBC connection pooling. If the two connectors share the same database, they share the same WebSphere Application Server database connection pool. If you choose different database when installing the two connectors, the connectors use different WebSphere Application Server database connection pools. Without connection pooling, each database handles its own database connection, which can limit the scalability of an application. When you implement connection pooling, each database can share a database connection from the WebSphere Application Server JDBC connection pool. This benefits performance by reducing the quantity of resources that are required for a set of databases. You can use either a direct or indirect Java Naming and Directory Interface (JNDI) name to look up the data source. Indirect lookup is recommended for the following reasons: v v Indirect lookup enables more control over connection management properties such as authentication and sharing scope that are specified in a resource reference, and allows you to select which J2C connection factory to use. Direct lookup has been deprecated in WebSphere Application Server. Requirement: If you upgraded from eclient Version 8.3 and have Version 4 data sources, recreate them as Version 5 data sources. Delete the existing Version 4 data sources to avoid naming conflicts. To configure WebSphere Application Server connection pooling: 1. Modify the cmbpool.ini file to enable WebSphere Application Server connection pooling. By default, this file is located in the /home/ibmcmadm/cmgmt/connectors Copyright IBM Corp. 2001, 2009 17

directory for AIX, Linux, or Solaris, or in the IBMCMROOT\cmgmt\connectors directory for Windows, or in the IBMCMROOT/cmgmt/connectors directory for z/os. v To use indirect lookup, modify the cmbpool.ini file with the following values: JavaPool=DKPoolWAS JDBCPrefix=java:comp/env/jdbc DBRepType=DB2 (or ORACLE) If you set JavaPool=DKPoolWAS but do not set a value for JDBCPrefix, direct lookup is used by default. 2. Add the following statement as the second entry to the cmbicmsrvs.ini file: v ICMJNDIREF=CM_LSDatasource_01 3. Set up a JNDI resource reference for your library server: a. In the WebSphere Application Server administrative console, click Applications Enterprise Applications eclient Resource references, and select a row in the table of resource references. b. In the JNDI Name column, select a JNDI name for the data source that is the mapping target of the resource reference. 4. Edit the properties of your data source: a. In the WebSphere Application Server administrative console, click Resources JDBC Data sources, and select your data source just specified. b. Enter the Scope, Provider, Name, and JNDI name. Activate the radio button Select a data store helper class and then select DB2 Universal data store helper. c. Under Related Items, click JAAS - J2C authentication data and select the authentication data entry that you selected in step 3. d. Enter the User ID and Password used to connect to the database. e. Click OK and Save to save changes to the master configuration. 5. Return back to the Data sources page. a. For Component-managed authentication alias select the authentication data entry that you selected in step 3. b. For DB2 universal source properties specify the following data source information for your system: Database name Specify the name of the DB2 Content Manager database or the DB2 Information Integrator for Content federated database. Driver type Specify the JDBC connectivity type that is used by the data source. Server name Specify the IP address or host name of the computer on which your DB2 Content Manager library server is installed. Port number Specify the TCP/IP port number where the DB2 Content Manager library server resides. DATASTORE_NAME is set according to your database name for the library server. c. Port number: Specify the TCP/IP port number where the DB2 Content Manager library server resides. DATASTORE_NAME is set according to your database name for the library server. 18 Installing, Configuring, and Managing the eclient

d. Click OK and Save to save changes to the master configuration. e. Click Test connection to verify that the data source you configured is working. 6. Restart server1 to make all of the eclient configuration take effect. 7. Configure the WebSphere Application Server connection pool settings, such as connection timeout, maximum connections, minimum connections, reap time, unused timeout, aged timeout, and purge policy. Configure these parameters according to your performance requirements and system resources. Related tasks Verifying that the eclient uses connection pooling Related information WebSphere Application Server connection pool settings Verifying that the eclient uses connection pooling You can check the dklog.log trace file to verify that the eclient uses WebSphere Application Server connection pooling. Connection pooling must be manually configured. To verify that the eclient uses connection pooling: 1. In the cmblogconfig.properties log configuration file, change the line DKLogPriority = ERROR to DKLogPriority = TRACE. By default, this file is located in the /home/ibmcmadm/cmgmt/connectors directory for AIX, Linux, or Solaris, or in the IBMCMROOT\cmgmt\connectors directory for Windows. 2. Start the eclient server and log in to the eclient application. 3. Verify that the following text appears in the ${user.name}.dklog.log trace file. By default, this file is located in the /home/ibmcmadm/log/connectors directory for AIX, Linux, or Solaris, or in the IBMCMROOT\log\connectors directory for Windows. JavaPool = DKPoolWAS + DKPoolManagerJDBC::getConnection() + DKPoolManagerJDBC::_getConnectionWAS() + DKPoolWAS::getConnection()... + DKPoolManagerJDBC::returnConnection() + DKPoolManagerJDBC::_returnConnectionWAS() + DKPoolWAS::returnConnection() If the text appears in the trace file, the eclient uses the connection pool. If the text does not appear in the file, verify that you performed all the steps to configure connection pooling. For more information about troubleshooting connection pooling problems, see the WebSphere Application Server information center. 4. In the cmblogconfig.properties log configuration file, change the line DKLogPriority = TRACE back to DKLogPriority = ERROR. Related information WebSphere Application Server information center Configuring the eclient for single sign-on (SSO) To set up single sign-on (SSO) for the eclient, you need to configure SSO for both the DB2 Content Manager and the WebSphere Application Server. eclient configuration for use with WebSphere Application Server 19

After you restart the WebSphere Application Server and the eclient application, you can log into the eclient with the same credentials as your WebSphere Application Server user ID. Related tasks Enabling single sign-on in the DB2 Content Manager library server Updating privilege sets for use with single sign-on Configuring WebSphere Application Server for SSO on page 21 Verifying the SSO configuration on page 21 Enabling single sign-on in the DB2 Content Manager library server With single sign-on, users can log on once to either a Web site or desktop system and not have to log on to different applications from the same Web site or desktop system. If you have not already, enable single sign-on in the DB2 Content Manager library server. 1. Start the DB2 Content Manager system administration client and log on as ICMADMIN. 2. In the navigation pane, click Library server parameters Configurations. 3. Right-click Library Server Configuration in the right pane and select Properties. 4. Set Max user action to Allow logon without warning and select the Allow trusted logon check box. 5. Click OK to save the changes. 6. Select Tools Manage Database Connection ID Change Database Shared Connection ID from the Administration Client menu. 7. Enter the connection user password. (The default connection user is icmconct). 8. Clear the Password is required for all users logging on to CM check box. 9. Click OK to save the change. Updating privilege sets for use with single sign-on Enabling single sign-on requires you to update your privilege sets. To update your privilege sets for use with single sign-on perform the following steps: 1. Start the DB2 Content Manager system administration client and log on as ICMADMIN. 2. In the navigation pane click Authorization Privilege Sets. A list of privilege sets is displayed in the Contents of: Privilege Sets window on the right. Perform the following actions for the privileges ClientUserEdit, ClientUserAllPrivs, AccountantPrivSet, UWAssistPrivSet. a. Right-click the privilege set and select Copy Advanced. b. Type the privilege set name followed by SSO, UWAssistPrivSetSSO for example, into the Name field. Note that the original name is listed in the title of this window. c. Select AllowTrustedLogon (...) in the Privileges field. d. Click OK to save the new privilege set. 20 Installing, Configuring, and Managing the eclient

3. In the navigation pane, click Authentication Users. The list of DB2 Content Manager users that are currently defined is displayed in the Contents of Users window on the right. 4. For each user that you want SSO for, double-click the name to open the properties window and replace the value in the Maximum Privilege set field with its Single Sign-On counterpart that you just created. For example, replace UWAssistPrivSet with UWAssistPrivSetSSO for the users UnderwriterAssistant1 and UnderwriterAssistant2. Configuring WebSphere Application Server for SSO You must configure the appropriate security settings to set up the WebSphere Application Server to use single sign-on (SSO). To configure the WebSphere Application Server for SSO: 1. In the WebSphere Application Server administrative console, click Security Secure administration, applications, and infrastructure. 2. Configure security settings by using the Security Configuration Wizard: a. On the Secure administration, applications, and infrastructure settings page, click Security Configuration Wizard. b. In step 1 of the wizard, select the Enable application security check box, clear the Use Java 2 security to restrict application access to local resources check box, and click Next. c. In step 2 of the wizard, click Local operating system. d. In step 3 of the wizard, type a user name in the Primary administrative user name field and click Next. Ensure that you specify the name of a DB2 Content Manager user who is assigned to an SSO privilege set and is defined in your local operating system. e. In step 4 of the wizard, click Finish. 3. Click Save to save the configuration. 4. On the Secure administration, applications, and infrastructure settings page, click Web security Single Sign-on (SSO). 5. On the Single sign-on settings page, select the Enabled check box and ensure that the Requires SSL check box is not selected. 6. Click OK. 7. Click Save to save the configuration 8. Restart the application servers to make the changes effective. Related information Implementing single sign-on to minimize Web user authentications Verifying the SSO configuration If the DB2 Content Manager server has been SSO enabled it appears under the server dropdown list. To verify that SSO for eclient is configured properly: 1. Launch the eclient in a Web browser and log into the WebSphere Application Server. 2. At the eclient logon window, SSO should automatically disable the user ID and password fields and use your WebSphere Application Server credentials instead. 3. Click Logon to log into the eclient. eclient configuration for use with WebSphere Application Server 21