Documentum Web Development Kit Tutorial

Documentum Web Development Kit Tutorial Version 4.2 April 2001 DOC3-WDKTUT-0401 Copyright © 2000, 2001 Documentum, Inc. 6801 Koll Center Parkway Pleasanton, CA 94566 All Rights Reserved. ®Documentum , Documentum 4i™, Docbase™, Documentum eContent ®Server™, Documentum Server , Documentum Desktop Client™, Documentum Intranet Client™, Documentum WebPublisher™, Documentum ®ftpIntegrator™, Documentum RightSite , Documentum Administrator™, Documentum Developer Studio™, Documentum Web Development Kit™, Documentum Web Gear™, Documentum WebCache™, Documentum ContentCaster™, AutoRender Pro™, Documentum iTeam™, Documentum Reporting Gateway™, Documentum Content Personalization Services™, Documentum Site Delivery Services™, Documentum Content Authentication Services™, Documentum Dynamic Content Assembler™, Documentum DocControl Manager™, Documentum Corrective Action Manager™, ® Documentum eConnector™ for BEA WebLogic (BEA and WebLogic are registered trademarks of BEA Systems), Documentum eConnector™ for JDBC, Documentum eConnector™ for CAD, Documentum eConnector™ for SAP™ ®(SAP is a trademark of SAP AG), Documentum eConnector™ for Lotus Notes (Lotus Notes is a registered trademark of Lotus Development Corporation), DocInput™, Documentum DocViewer™, GMPharma™, Virtual Document ® ®Manager™, Docbasic , Documentum WorkSpace , Documentum ® ® SmartSpace , and Documentum ViewSpace are trademarks or registered trademarks of Documentum, Inc. in the United States and throughout the world. All other company and product names are used for identification purposes only and may be trademarks of their respective owners.CONTENTS Preface 1 What is the Web Development Kit? What WDK Is and What it Can Do . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 Compliance With Java Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Dependencies on Other Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Fitting the Pieces Together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 2 JavaServer Pages in the WDK Anatomy of a Typical WDK Server Page . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 HTML Generated by JSP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Handling Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 3 Developing an Application Prepare Your Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 Plan the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 Create the Application Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 Locate the Tutorial Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5 Create a Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5 Add the Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7 Add Event Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10 Enable Actions on Docbase Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12 Extra Investigation: Use Cascading Style Sheets to Customize the Look of Your Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13 4 Customizing WDK Components Modify a Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Remove the menu items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Extra investigation: Add a menu item. . . . . . . . . . . . . . . . . . . . . . . . . 4-3 Add a Column to a View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 Add the column to the view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4 5 Displaying Properties of a Custom Object Type Display Custom Properties of a Custom Object Type . . . . . . . . . . . . . . . . . . . 5-1 Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Display the custom properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Documentum Web Development Kit Tutorial iiiExtra Investigation: Searching for Properties of a Custom Object Type . . . . . . . . 5-3 A Solution Code wdkSkeletonPage.jsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2 wdkTutorial0_finished.jsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3 wdkTutorial1_finished.jsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4 toolbarTutorial_finished.jsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5 wdkTutorial2_finished.jsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7 wdkTutorial3_finished.jsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-9 folderContents.jsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11 iv Documentum Web Development Kit TutorialPREFACE Purpose of the Manual This manual provides an introduction to the basic features of the Documentum Web Development Kit (WDK) using both conceptual information and hands-on examples. For detailed WDK information, including installation instructions, information on developing and configuring web applications with the WDK, and reference material, see: Installation and Release Notes Online Help API Documentation (Javadoc) All of these documents are available in the docs directory that resides in the WDK installation directory. Intended Audience This manual is designed for web developers and designers who will use the WDK to add Documentum functionality to web applications. It assumes that you are familiar with JavaServer Pages, web applications, JavaScript, and HTML. Numerous books that cover these topics are available commercially, and you can also consult the following documents at http://java.sun.com: Java Servlet Specification, version 2.2 JavaServer Pages Specification, version 1.1 Organization of the Manual The following table describes the contents of the chapters and appendixes of this book. Documentum Web Development Kit Tutorial v➤ Chapter Contents Chapter 1, What is the Web Describes the contents of the WDK and how it works Development Kit? with your HTTP server and application server. Chapter 2, JavaServer Pages Describes how JavaServer Pages are used to drive in the WDK WDK-based web applications. Chapter 3, Developing an Contains step-by-step examples of how to build a Application simple web application based on the WDK. Chapter 4, Customizing WDK Contains step-by-step examples of how to customize Components a menu and a view. Chapter 5, Displaying Contains step-by-step examples of how to display the Properties of a Custom Object properties of a custom object type in the properties Type page of WDK. Appendix A, Solution Code Lists the solutions for each tutorial exercise. Conventions This manual uses the following conventions: Convention Description Represents a pop-up or pull-down menu. Indicates the introduction to a procedure. italics Represents a variable name for which you must provide a value, or a defined term. typewriter Represents code samples, user input, and computer output. [] square brackets Indicates an optional argument. {} braces (curly Indicates an optional argument that can be repeated more than brackets) once. vi Documentum Web Development Kit Tutorial➤ ➤ ➤ Using Links in PDF Files If you are reading this document as a Portable Display Format (PDF) file, cross-references and page numbers in the index are clickable blue hypertext links. Table of contents page numbers are also clickable links, but they appear in black. Each server book contains many clickable cross-references to the other server books. Cross-references to manuals other than the one you are reading only work if the PDF files are all in the same directory and have the same file names that they have on the server release CD. To follow a link: 1. Move the pointer over a linked area. The pointer changes to a pointing finger when positioned over a link. The finger pointer displays a W when moved over a Weblink. 2. Click to follow the link. Note: To follow Web links, your Weblink preferences must specify a Web browser. See Setting Weblink preferences in your Adobe Acrobat Help for more information. Bug Lists and Documentation Online Customers with a software support agreement