Web Enablement Kit Implementation Guide
Total Page:16
File Type:pdf, Size:1020Kb
DB2 ® IBM DB2 Content Manager OnDemand for Multiplatforms Version 8 Release 3 Web Enablement Kit Implementation Guide SC18-9231-00 DB2 ® IBM DB2 Content Manager OnDemand for Multiplatforms Version 8 Release 3 Web Enablement Kit Implementation Guide SC18-9231-00 Note Before using this information and the product it supports, read the information in “Notices” on page 187. First Edition (October 2004) This edition replaces IBM DB2 Content Manager OnDemand for Multiplatforms Version 7.1 Web Enablement Kit Implementation Guide (SC27-1000-03) This edition applies to IBM DB2 Content Manager OnDemand for Multiplatforms Version 8 Release 3 (product number 5724-J33) and to all subsequent releases and modifications until otherwise indicated in new editions. This product includes software developed by the Apache Software Foundation (http://www.apache.org/). © Copyright International Business Machines Corporation 1996, 2004. All rights reserved. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents About this publication . vii Installing on Solaris . .19 How this publication is organized. vii Your next step . .19 Who should use this publication . viii Installing on Windows servers . .20 What you should already know . viii Your next step . .20 Where to find more information . .ix Information center . .ix Chapter 5. Deploying the CGI program 21 PDF publications. .ix Before you begin . .21 Accessibility information for OnDemand . .x Copying CGI program files . .21 Support available on the Web . .x Your next step . .21 Education and training . .x How to send your comments . .x Chapter 6. Deploying the Java servlet 23 || What’s new in Version 8.3 . .x Before you begin . .23 Copying files . .23 Summary of changes . xiii Your next step . .24 Deploying the servlet using WebSphere tools . .24 Chapter 1. Product overview . .1 Assembling the application . .24 About the programming interfaces . .2 Installing the application . .26 About the viewers . .4 Your next step . .27 Using ODWEK . .5 Product functions. .5 Chapter 7. Specifying the ARSWWW.INI Add Annotation . .6 file . .29 Change Password. .6 [@SRV@_DEFAULT] . .29 Document Hit List . .6 PORT . .29 Logoff . .6 PROTOCOL . .30 Logon . .6 [@SRV@_server] . .30 Retrieve Document . .6 HOST . .30 Search Criteria. .6 PORT . .30 Server Print Document . .6 PROTOCOL . .31 Update Document . .7 [CONFIGURATION] . .31 View Annotations. .7 APPLETCACHEDIR . .31 Server and data security . .7 APPLETDIR . .31 CACHEDIR . .32 Chapter 2. Implementation overview . .9 CACHEDOCS . .32 Possible HTTP server and Web application server CACHEMAXTHRESHOLD . .33 scenarios . .9 CACHEMINTHRESHOLD . .33 Implementation steps . .9 CACHESIZE . .33 Your next step . .11 CACHEUSERIDS . .34 CODEPAGE . .34 Chapter 3. Installation requirements . .13 DOCSIZE . .35 Server installation requirements . .13 IMAGEDIR . .35 || Client installation requirements. .14 LANGUAGE . .36 Disk space requirements . .14 ShowSearchString . .37 Transform requirements . .15 TEMPDIR . .37 Your next step . .15 TEMPLATEDIR . .38 [SECURITY] . .38 Chapter 4. Installing ODWEK . .17 REPORTSERVERTIMEOUT . .38 | UPDATETIMESTAMP . .39 Before you begin . .17 SERVERACCESS . .39 Your next step . .17 [AFP2HTML] . .40 Installing on AIX . .17 CONFIGFILE . .40 Your next step . .17 INSTALLDIR . .40 Installing on HP-UX . .18 USEEXECUTABLE . .41 Your next step . .18 [AFP2PDF] . .41 Installing on Linux . .18 CONFIGFILE . .42 Your next step . .19 INSTALLDIR . .42 © Copyright IBM Corp. 1996, 2004 iii USEEXECUTABLE . .42 Distributing user-defined files . .70 [MIMETYPES] . .43 Mapping AFP fonts. .73 AFP . .44 | Displaying AFP reports . .74 BMP. .45 | Displaying overlays . .75 GIF . .45 Image Web Viewer . .75 EMAIL . .45 Java line data viewer . .76 JFIF . .46 Your next step . .80 LINE . .46 PCX . .46 Chapter 10. Verifying the installation 81 PDF . .46 Verifying the CGI program . .81 TIFF . .47 Verifying the servlet . .82 [ATTACHMENT IMAGES] . .47 Troubleshooting . .83 BMP. .48 You next step. .84 GIF . .48 TXT . .48 Appendix A. CGI API reference . .85 [NO HTML] . .48 Add Annotation . .86 BEGIN . .49 Change Password . .89 END. .49 Document Hit List . .91 SEPARATOR . .49 Logoff . .95 [DEFAULT BROWSER] . .50 Logon . .97 ADDEXTENSION . .50 Print Document (Server) . .99 ADDFIELDSTODOCID . .50 Retrieve Document . 103 ADDNOTES . .51 Search Criteria . 106 AFPVIEWING . .51 Update Document . 108 AUTODOCRETRIEVAL . .52 View Annotations . .110 EMAILVIEWING . .52 ENCRYPTCOOKIES . .53 ENCRYPTURL . .53 Appendix B. Java servlet reference 113 FOLDERDESC . .53 LINEVIEWING . .54 Appendix C. Java API reference . .115 MAXHITS . .54 NOLINKS . .55 Appendix D. Java API programming ODApplet.jre.path.IE . .55 guide . .117 ODApplet.jre.path.NN. .55 Client/server architecture . .117 ODApplet.jre.version . .55 Packaging for the Java environment . .117 ODApplet.version . .55 Programming tips . .118 SERVERPRINT . .55 Setting up the system environment . .118 SERVERPRINTERS . .56 Setting environment variables . .118 SHOWDOCLOCATION . .56 Tracing and diagnostic information . 120 VIEWNOTES . .57 Tracing . 120 [browser] . .57 Exception handling . 120 [DEBUG] . .58 Constants . 120 LOG. .58 Running an ODWEK application . 121 LOGDIR . .59 Connecting to an OnDemand server. 121 Example ARSWWW.INI file . .60 Establishing a connection . 121 Your next step . .61 Setting and getting passwords. 122 Working with an OnDemand server . 122 Chapter 8. Configuring the sample | Connecting to a non-default port using the Java applications . .63 | APIs . 124 LOGON.HTM . .63 Listing application groups in a folder . 124 CREDIT.HTM . .64 Searching a folder . 126 TEMPLATE.HTM . .65 Searching a folder using an SQL string . 130 Your next step . .65 Cancelling a search . 132 Listing search criteria. 134 Chapter 9. Installing and configuring Listing folders and folder information . 138 viewing software . .67 Displaying a list of documents . 139 Overview . .67 Retrieving a document . 141 Requirements. .68 Printing a document . 144 Installation . .69 Listing information about notes . 146 AFP Web Viewer . .69 Adding a note . 148 iv Web Enablement Kit Implementation Guide Updating a document . 150 Viewing converted pages with Internet Explorer 172 Changing a password . 152 Appendix G. AFP to PDF transform 175 Appendix E. Xenos transforms . 155 Specifying the AFP2PDF.INI file . 175 Converting data streams. 155 Viewing converted documents. 176 AFP documents to HTML . 156 AFP data to PDF . 156 Appendix H. No HTML output . 177 AFP documents to XML . 156 Delimited ASCII output . 177 Line data to AFP . 156 Logon . 177 Line data to HTML . 156 Notes . 178 Line data to PDF . 157 Search Criteria . 178 Line data to XML . 157 Notes . 178 Metacode to AFP . 157 Document Hit List. 179 Metacode documents to HTML . 157 Notes . 179 Metacode to PDF . 158 View Annotations . 180 Metacode documents to XML . 158 Error Message . 180 Viewing and printing with the Web Enablement Kit 158 Notes . 180 Configuring the ARSWWW.INI file . 159 [XENOS] . 159 Appendix I. National language support 181 Specifying the AFP transform option . 161 Specifying the line data transform option . 161 Specifying the Metacode transform option. 162 Appendix J. Problem determination Configuring the ARSXENOS.INI file. 162 tools . 183 Specifying the ARSXENOS.INI file . 163 Viewing converted documents. 164 | Appendix K. Clustering ODWEK on Example of a parameter file . 164 | WAS 4.0. 185 Example of a script file . 166 Changes to the Retrieve Document API. 167 Notices . ..