Difference between revisions of "File:ODWEK Implementation v95.pdf"

Contents ibm.com and related resources. . . . . v Contacting IBM . . . . . . . . . . . . . v IBM Content Manager OnDemand Web Enablement Kit overview . . . . . . . 1 IBM Content Manager OnDemand Web Enablement Kit components . . . . . . . . . . . . . 1 Managing access to Content Manager OnDemand through ODWEK. . . . . . . . . . . . 2 Use cases of ODWEK Java APIs from a business perspective . . . . . . . . . . . . . . 2 A common customer use case. . . . . . . . 3 IBM Content Manager OnDemand Web Enablement Kit functions . . . . . . . . . . . . . . 4 Additional resources. . . . . . . . . . . . 5 Planning your ODWEK solution . . . . 7 Prerequisites . . . . . . . . . . . . . . 7 About the programming interfaces . . . . . . . 7 About the viewers . . . . . . . . . . . . 9 Server and data security . . . . . . . . . . 9 Installing IBM Content Manager OnDemand Web Enablement Kit. . . . 11 Installing documentation for Java APIs . . . . . 11 Installing the Java API components . . . . . . 12 Uninstalling ODWEK . . . . . . . . . . . 12 Developing Java applications . . . . . 13 Client/server architecture. . . . . . . . . . 13 Packaging for the Java environment . . . . . . 14 Programming tips . . . . . . . . . . . 15 Setting up the development environment . . . . 16 Running an ODWEK application . . . . . . . 17 Code page conversion in ODWEK. . . . . . 18 Tracing and diagnostic information . . . . . . 19 Enabling ODWEK tracing . . . . . . . . 19 Exception handling. . . . . . . . . . . 20 Vector of hits not maintained by the Content Manager OnDemand API. . . . . . . . . 20 Content Manager OnDemand server connections . . 21 Establishing a connection. . . . . . . . . 21 Passwords. . . . . . . . . . . . . . 22 Connecting to a non-default port . . . . . . 22 Configuring Content Manager OnDemand instance parameters . . . . . . . . . . . . . . 23 Working with a Content Manager OnDemand server 24 Listing application groups in a folder. . . . . . 26 Searching a folder . . . . . . . . . . . . 29 Searching a folder using an SQL string . . . . . 36 Cancelling a search. . . . . . . . . . . . 42 Listing search criteria . . . . . . . . . . . 45 Listing folders and folder information . . . . . 51 Displaying folder criteria information. . . . . . 53 Displaying a list of documents . . . . . . . . 55 Retrieving a document . . . . . . . . . . 60 Printing a document . . . . . . . . . . . 65 Listing information about annotations . . . . . 67 Adding an annotation. . . . . . . . . . . 71 Deleting an annotation . . . . . . . . . . 74 Updating a document . . . . . . . . . . . 77 Changing a password . . . . . . . . . . . 81 Installing and configuring viewing and transform software . . . . . . . . . 85 Installing and configuring the AFP Web Viewer . . 85 Supported colors . . . . . . . . . . . 86 Distributing user-defined files . . . . . . . 87 Mapping AFP fonts. . . . . . . . . . . 89 Displaying AFP reports . . . . . . . . . 89 Displaying overlays . . . . . . . . . . 90 Installing and configuring the Image Web Viewer . 90 Configuring multi-page image behavior. . . . 91 Installing and configuring the Java line data viewer 91 Configuring the ODWEK interface to AFP2PDF . . 92 Configuring the AFP2PDF.INI file . . . . . . 92 Viewing converted documents . . . . . . . 93 Tools for troubleshooting. . . . . . . 95 Java Dump . . . . . . . . . . . . . . 96 IBM Thread and Monitor Dump Analyzer . . . 96 Java diagnostic commands . . . . . . . . . 97 jmap. . . . . . . . . . . . . . . . 97 jstat . . . . . . . . . . . . . . . . 98 HPROF: Heap Profiler. . . . . . . . . . 98 HAT: Heap Analysis Tool. . . . . . . . . 98 Diagnostic Tool for Java Garbage Collector . . . 98 HeapAnalyzer . . . . . . . . . . . . 99 HeapRoots . . . . . . . . . . . . . 100 Appendix. Developing CGI and servlet applications (DEPRECATED). . . . . 101 Installing CGI and servlet interface . . . . . . 101 Configuring the ODWEK initialization file. . . . 101 ARSWWW.INI reference. . . . . . . . . 102 Example ARSWWW.INI file . . . . . . . 134 Configuring the web server configuration file . . 139 Example: configuring the web server configuration file for z/OS . . . . . . . . 139 Example: web server configuration file for i . . 151 Customizing the sample applications . . . . . 153 Customizing the LOGON.HTM sample application . . . . . . . . . . . . . 153 Customizing the CREDIT.HTM sample application . . . . . . . . . . . . . 154 Customizing the TEMPLATE.HTM file. . . . 155 Deploying the Java servlet for Content Manager OnDemand Web Enablement Kit. . . . . . . 155 Copying files . . . . . . . . . . . . 155 © Copyright IBM Corp. 1996, 2014 iii Deploying servlets. . . . . . . . . . . 156 Deploying CGI for IBM Content Manager OnDemand . . . . . . . . . . . . . . 157 Verifying the installation . . . . . . . . . 158 Verifying the CGI program. . . . . . . . 158 Verifying the servlet . . . . . . . . . . 158 Servlet and CGI API Reference . . . . . . . 159 Add Annotation function . . . . . . . . 159 Change Password function. . . . . . . . 161 Document Hit List function . . . . . . . 162 Logoff function. . . . . . . . . . . . 166 Logon function. . . . . . . . . . . . 167 Print Document (Server) function. . . . . . 168 Retrieve Document . . . . . . . . . . 171 Search Criteria function . . . . . . . . . 174 Update Document function. . . . . . . . 176 View Annotations function. . . . . . . . 177 Troubleshooting CGI or servlet installation . . . 178 The Logon screen did not appear. . . . . . 178 Error 404, file not found. . . . . . . . . 179 Error 500, Server Error . . . . . . . . . 179 Notices . . . . . . . . . . . . . . 181 Trademarks . . . . . . . . . . . . . . 183 Privacy policy considerations . . . . . . . . 184 Index . . . . . . . . . . . . . . . 185