get started document um 41
TRANSCRIPT
-
8/6/2019 Get Started Document Um 41
1/104
Getting Started With
Documentum 4i
for the eBusiness Edition
Version 4.1
July 2000
DOC3-GSD4IEBE-JL00
$(!
-
8/6/2019 Get Started Document Um 41
2/104
Copyright 1999, 2000
by Documentum, Inc.6801 Koll Center ParkwayPleasanton, CA 94566
All Rights Reserved. Documentum, Documentum 4i, Documentum e-Content Server, Documentum Desktop Client, Documentum IntranetClient, Documentum WebPublisher, Documentum RightSite,
Documentum Administrator, Documentum Developer Studio,Documentum WebCache, Documentum ContentCaster, DocumetumftpIntegrator, AutoRender Pro, Documentum Content PersonalizationServices, Documentum Site Delivery Services, Documentum ContentAuthentication Services, Documentum DocControl Manager,Documentum Corrective Action Manager, DocInput, DocumentumDocViewer, Documentum DocPage Server, Documentum WorkSpace,Documentum SmartSpace, Documentum ViewSpace, and Documentum
SiteSpace are trademarks of Documentum, Inc. in the United States and othercountries. All other company and product names are used for identificationpurposes only and may be trademarks of their respective owners.
-
8/6/2019 Get Started Document Um 41
3/104
Getting Started with Documentum 4i iii
Preface
1 Introducing Documentum 4iWhats New in the eBusiness Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Product Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2eBusiness Edition Product Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Documentum Server Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6e-Content Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7Documentum Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9Documentum RightSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10Content Personalization Services . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Documentum Web Publishing Products . . . . . . . . . . . . . . . . . . . . . . . . . 1-12WebPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13WebCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
ContentCaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15ftpIntegrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Documentum Developer Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16Web Development Kit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16Documentum Developer Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Documentum Client Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19Intranet Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19
Documentum Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-20Other Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21
Workflow Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22Documentum Foundation Classes . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22Docbasic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22
2 Documentum ArchitectureDocbase Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Client, Server, and Database Relationships. . . . . . . . . . . . . . . . . . . . . . . . . 2-2
3 Installing Documentum 4iPlanning Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Allocating System Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2Preinstallation Testing and Configuration . . . . . . . . . . . . . . . . . . . . . . 3-2
Planning the Network and Computer Hardware . . . . . . . . . . . . . . . 3-3Planning and Testing the TCP/IP Network . . . . . . . . . . . . . . . . . . 3-4
Planning the Server Operating System Installation . . . . . . . . . . . . . . 3-4
C O N T E N T S
-
8/6/2019 Get Started Document Um 41
4/104
iv Getting Started with Documentum 4i
Operating System Privileges and Accounts . . . . . . . . . . . . . . . 3-5
Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5Planning the RDBMS Installation . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Required RDBMS Privileges . . . . . . . . . . . . . . . . . . . . . . . . 3-6RDBMS Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6RDBMS Server Locations . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Planning the Client Operating System Installation . . . . . . . . . . . . . . 3-7Product Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
Installation Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
4 e-Content Server Preinstallation ChecklistsWindows NT Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Installing or Upgrading on Windows NT . . . . . . . . . . . . . . . . . . . . . . . . . 4-3UNIX Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Installing or Upgrading on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
5 Content Personalization Services Preinstallation Checklists
Content Personalization Services Checklist . . . . . . . . . . . . . . . . . . . . . . . . 5-2Installing Content Personalization Services . . . . . . . . . . . . . . . . . . . . . . . . 5-3
6 Desktop Client Preinstallation ChecklistsDesktop Client Checklist for Windows 95, 98, or 2000 . . . . . . . . . . . . . . . . . . 6-2Desktop Client Checklist for Windows NT . . . . . . . . . . . . . . . . . . . . . . . . 6-4Installing the Desktop Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
7 RightSite and Spider Preinstallation ChecklistsRightSite Checklist for Windows NT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2RightSite Checklist for UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Documentum Spider Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Installing or Upgrading RightSite on Windows NT . . . . . . . . . . . . . . . . . . . 7-5Installing or Upgrading RightSite on UNIX . . . . . . . . . . . . . . . . . . . . . . . . 7-7Installing or Upgrading Documentum Spider. . . . . . . . . . . . . . . . . . . . . . . 7-9
8 Web Publishing Preinstallation ChecklistsWebPublisher Checklists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2Installing WebPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4WebCache Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5Installing or Upgrading WebCache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6ContentCaster Checklists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8Installing ContentCaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9ftpIntegrator Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-10
-
8/6/2019 Get Started Document Um 41
5/104
Getting Started with Documentum 4i v
9 Web Development Kit Preinstallation ChecklistsWeb Development Kit Checklist. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2Installing the Web Development Kit for IIS . . . . . . . . . . . . . . . . . . . . . . . . 9-3Installing the Web Development Kit for iPlanet . . . . . . . . . . . . . . . . . . . . . . 9-4
10 Developer Studio Preinstallation ChecklistsDeveloper Studio Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Index
-
8/6/2019 Get Started Document Um 41
6/104
vi Getting Started with Documentum 4i
-
8/6/2019 Get Started Document Um 41
7/104
Getting Started with Documentum 4i vii
P R E F A C E
Purpose of the Manual
This manual provides an overview of the Documentum 4i eBusiness Editionand introduces its components.
The manual includes information on the correct order in which to installDocumentum products, as well as preinstallation checklists for the majorserver, client, Web publishing, and application development products. Thesechecklists remind you about required preinstallation activities and list specificinformation you must obtain about your system to install the productssuccessfully.
Intended Audience
This manual is primarily intended for anyone who installs Documentum 4i orany of its component products, whether or not you have previous experiencewith Documentum.
Organization of the Manual
This manual contains 9 chapters and an Index. The table below lists theinformation that you can expect to find in each.
Chapter Contents
Chapter 1, IntroducingDocumentum 4i
A survey of the products, tools, other components, anddocumentation for the Documentum 4i eBusinessEdition
Chapter 2, DocumentumArchitecture
An overview of Documentums system architecture
-
8/6/2019 Get Started Document Um 41
8/104
viii Getting Started with Documentum 4i
Conventions
This manual uses the following conventions:
Chapter 3, InstallingDocumentum 4i
Information about setting up a Documentum 4ieBusiness Edition installation and the order in which toinstall the products
Chapter 4, e-Content ServerPreinstallation Checklists
Documentum e-Content Server preinstallationchecklists
Chapter 5, ContentPersonalization ServicesPreinstallation Checklists
Documentum Content Personalization Servicespreinstallation checklists
Chapter 6, Desktop ClientPreinstallation Checklists
Documentum Desktop Client preinstallationchecklists
Chapter 7, RightSite andSpider PreinstallationChecklists
Documentum RightSite and Spider preinstallationchecklists
Chapter 8, Web PublishingPreinstallation Checklists
Documentum WebCache, DocumentumWebPublisher, Documentum ContentCaster andDocumentum ftpIntegrator preinstallation checklists
Chapter 9, WebDevelopment KitPreinstallation Checklists
Documentum Web Development Kit preinstallationchecklists
Chapter 10, DeveloperStudio PreinstallationChecklists
Documentum Developer Studio preinstallationchecklists
Chapter Contents
Convention Description
Represents a pop-up or pull-down menu.
-
8/6/2019 Get Started Document Um 41
9/104
Getting Started with Documentum 4i ix
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 clickableblue hypertextlinks. Table of contents page numbers are also clickable links, but they appearin black.
To follow a link:
1. Move the pointer over a linked area.
The pointer changes to a pointing finger when positioned over a link. Thefinger pointer displays a W when moved over a Weblink.
2. Click to follow the link.
Note: A Web browser must be chosen in your Weblink preferences to follow aWeblink. See Setting Weblink preferences in your Adobe Acrobat Help formore information.
italics Represents a variable name for which you must provide avalue or a defined term.
typewriter Represents code samples, user input, and computer output.
[] brackets Used in method command syntax specifications to indicate an
optional argument.{} braces Used in method command syntax specifications to indicate an
optional argument that can be repeated more than once.
Convention Description
-
8/6/2019 Get Started Document Um 41
10/104
x Getting Started with Documentum 4i
Bug Lists and Documentation Online
Customers with a Software Support Agreement can read our productdocumentation and, after commercial release of a product, view lists of fixedbugs on Documentums Technical Support web pages, Support On-Line. Toenter Support On-Line, you must request access and obtain a user name andpassword.
Applying for Access
To apply for access to the Technical Support Web site:
1. In your Web browser, openhttp://www.documentum.com/
2. Click the Technical Support link.
3. Click the Request Access link.
4. Complete the form and click Submit Request.
Documentum will respond to your request within two business days.
Fixed Bugs List
A list of customer-reported bugs that have been fixed will be available twoweeks after this release, at the Technical Support area of the DocumentumWeb site. For information about obtaining access to the Technical Support Website, refer to Applying for Access. You must have Adobe Acrobat Reader orAcrobat Exchange installed to view the lists of fixed bugs.
To view the list of fixed bugs:
1. In your web browser, openhttp://www.documentum.com/
2. Click the Technical Support link.
3. Log on to the Technical Support site.
4. In the Troubleshooting section, click View Bugs.
5.Click Fixed Bugs and Feature Requests Lists.
http://www.documentum.com/http://www.documentum.com/support/index.htmhttp://www.documentum.com/support/index.htmhttp://www.documentum.com/ -
8/6/2019 Get Started Document Um 41
11/104
Getting Started with Documentum 4i xi
6. Click the name of the bug list.
Product Documentation
Customers with a Software Support Agreement can read our productdocumentation at the Documentum Web site. You must have a user name andpassword, and Adobe Acrobat Exchange or Acrobat Reader installed, in orderto view the documentation. To obtain a user name and password, refer to
Applying for Access.
To view a document:
1. In your Web browser, openhttp://www.documentum.com/
2. Click the Technical Support link.
3. Log on to the Technical Support site.
4. In the Resources section, click Documentation.
5. Click the name of the document.
Purchasing Bound Paper Manuals
Our product documentation is available for purchase as bound papermanuals. To place an order, call the Documentation Order Line at (925) 600-6666. You can pay with a purchase order, check, or credit card.
http://www.documentum.com/support/index.htmhttp://www.documentum.com/support/index.htm -
8/6/2019 Get Started Document Um 41
12/104
xii Getting Started with Documentum 4i
-
8/6/2019 Get Started Document Um 41
13/104
Getting Started with Documentum 4i 1-1
1Introducing Documentum 4i 1
Documentum 4i is the leading Internet-scale content management solution
for powering e-business applications. The new Documentum 4i eBusinessEdition gives businesses the same unmatched control over content providedby previous releases and extends content management to the World WideWeb.
Within the enterprise, users create content and store it in the Docbase,taking advantage of Documentums powerful version control, audit trail,security, workflow, and document lifecycle features, which enable complex
management of business policies and procedures.On the Web, Documentum 4i eBusiness Edition provides businesses with afull Web-oriented content life cycle: content creation, personalization,management, and delivery. eBusiness Edition includes Web publishing,advanced content personalization services, and site delivery services.
This chapter covers the following topics:
s Whats New in the eBusiness Edition on page 1-2
s eBusiness Edition Product Suite on page 1-3
s Documentum Server Products on page 1-6
s Documentum Web Publishing Products on page 1-12
s Documentum Developer Tools on page 1-16
s Documentum Client Products on page 1-18
s Documentum Utilities on page 1-20
Before you install Documentum 4i, be sure to read Chapter 3, InstallingDocumentum 4i and the release notes and installation manuals for eachproduct you are installing. Installing Documentum products on unsupportedmachine configurations or in the incorrect order may result in seriousproblems.
-
8/6/2019 Get Started Document Um 41
14/104
Introducing Documentum 4iWhats New in the eBusiness Edition
1-2 Getting Started with Documentum 4i
Whats New in the eBusiness Edition
This shipment of Documentum 4i contains many new or updatedDocumentum products. New capabilities have been added to Documentume-Content Server and the client products. New products such asDocumentum WebCache, Documentum WebPublisher, DocumentumWeb Development Kit, Documentum Content Personalization Services,and Documentum ContentCaster allow seamless deployment of contentfrom a Docbase to the Web.
Documentum 4i eBusiness Edition includes the following new products andfeatures:
s WebPublisher allows easy creation and management of Web content.
s WebCache automates the process of publishing content from a Docbase toa Web site.
s ContentCaster allows Web site content to automatically deployed to a Webserver farm.
s Content Personalization Services allows documents to be targeted toindividuals based on content and preferences.
s Web Development Kit (WDK) enables developers to build robust, scalableapplications for Web-based access to Docbases.
Product Documentation
Documentum provides extensive documentation for the products thatconstitute Documentum 4i eBusiness Edition, including information about thenew products and features. The documentation includes PDF files, printedmanuals, and online Help.
The product manuals are available in Portable Document Format (PDF) on theproduct CDs and the Documentum Web and FTP sites. Each PDF on the CD islocated in the directory that contains the most closely associated product. Insome cases, the PDF manuals are also accessible directly from the interface ofthe associated client application. For information about accessing the PDFmanuals on the Documentum Web site, refer to Bug Lists andDocumentation Online on page ix of the Preface. For information aboutacquiring printed manuals, refer to Purchasing Bound Paper Manuals on
page xi. The price list for printed manuals is included in the product box.
-
8/6/2019 Get Started Document Um 41
15/104
Introducing Documentum 4ieBusiness Edition Product Suite
Getting Started with Documentum 4i 1-3
For customers who are customizing the Documentum Desktop Client and
also wish to customize its online Help, the Desktop Client Help source filesare available on the installation CD that contains Documentum DeveloperStudio.
eBusiness Edition Product Suite
A typical Documentum 4i eBusiness Edition installation includes:
s e-Content Server and a Docbase
The server allows clients to access the Docbase and manage documentsand other objects stored in the Docbase.
s Documentum RightSite
RightSite allows browser-based access to a Docbase.
s Documentum Administrator
Documentum Administrator allows system administrators to manageservers and Docbases, and to create users and groups in a Docbase.
s Clients
Documentum 4i includes Desktop Client and Intranet Client, which aregeneral-purpose clients, and WebPublisher, which allows easy
management and publishing of Web content.
s Developer tools
Documentum 4i includes Documentum Developer Studio and WebDevelopment Kit, which allow developers to customize Documentum.
s Other applications
Documentum 4i also includes products such as WebCache, which is used
in Web publishing, and AutoRender Pro, which automates the creationof PDF files in a Docbase. Refer to eBusiness Edition Product Suite onpage 1-3 for a brief description of additional products.
Figure 1-1 illustrates a typical Documentum installation.
-
8/6/2019 Get Started Document Um 41
16/104
Introducing Documentum 4ieBusiness Edition Product Suite
1-4 Getting Started with Documentum 4i
Figure 1-1 A Typical Documentum Installation
The eBusiness Edition product suite is described briefly in Table 1-1.
Table 1-1 eBusiness Edition Products
Product or Component Description
Server Products
-
8/6/2019 Get Started Document Um 41
17/104
Introducing Documentum 4ieBusiness Edition Product Suite
Getting Started with Documentum 4i 1-5
Documentum e-ContentServer
Allows users to access and manage documents and otherobjects stored in a Docbase.
DocumentumAdministrator
Gives browser-based access to all server administrationfunctions.
Documentum RightSite Allows users to access a Docbase using a Web browser.
Documentum ContentPersonalizationServices
Permits automatic population of attributes, documentclassification based on content, and targeting ofdocuments based on personal preferences.
Web Publishing Products
DocumentumWebPublisher
Manages the creation, review, and life cycle of Web pagecontent, and the compilation of web page content into
HTML pages for publishing to an external Web site.
DocumentumWebCache
Publishes documents from a Docbase to a Web site.
DocumentumContentCaster
Deploys a production Web site to one or more productionWeb servers or server farms.
Documentum
ftpIntegrator
ftpIntegrator provides a File Transfer Protocol (FTP)
server interface between MacromediasDreamweaver product and a WebPublisher Docbaserepository.
Developer Tools
Documentum WebDevelopment Kit
Simplifies the development of Web-based applicationsthat can access a Docbase.
Documentum Developer
Studio
Enables developers to customize Documentum and
distribute customizations throughout an organization.
DocApps and DocAppInstaller
Packaging and installer for customizations developedwith Documentum Developer Studio.
DocumentumFoundation Classes(DFC)
A set of Java classes that makes e-Content Serverfunctionality available to client programs through apublished set of interfaces.
Table 1-1 eBusiness Edition Products
Product or Component Description
-
8/6/2019 Get Started Document Um 41
18/104
Introducing Documentum 4iDocumentum Server Products
1-6 Getting Started with Documentum 4i
Documentum Server Products
The server products are the core of Documentum 4i. They provide contentmanagement services and store content files, database tables, indexes, andmetadata in a repository called a Docbase. The server supports access bynetwork clients and Web browsers. The server products are:
s e-Content Server
s RightSite
s Documentum Administrator
s Content Personalization Services
Docbasic The programming language provided by Documentumfor interacting directly with e-Content Server.
Client and Other Products and Utilities
Documentum DesktopClient
Allows desktop access to Docbases and Documentumsdocument management capabilities.
Documentum IntranetClient
Allows access to Docbases and Documentums documentmanagement capabilities from a Web browser.
Workflow Manager A client application used to develop workflow templates.
AutoRender Pro Automatically creates PDF, PDF text, and HTMLrenditions of documents.
Documentum ReportingGateway Allows applications such as Crystal Reports and Excelaccess to RDBMS tables underlying a Docbase forreporting purposes.
DocInput Image-capture software that allows users to scandocuments and store them as Docbase objects.
DocumentumDocViewer
Enables users to view and annotate TIFF and PDF(Portable Document Format) image documents fromDocumentum's client applications.
Table 1-1 eBusiness Edition Products
Product or Component Description
-
8/6/2019 Get Started Document Um 41
19/104
Introducing Documentum 4iDocumentum Server Products
Getting Started with Documentum 4i 1-7
These products allow users to access and manage documents and other
objects stored in a Docbase.
e-Content Server
Documentum e-Content Server is the single point of entry for a Docbase. Allrequests to store or retrieve metadata (attribute values) or content files in theDocbase are handled by e-Content Server. In addition to its storage and
retrieval services, e-Content Server provides users and applications thefollowing services:
s SysObject management services, including version control, renditionmanagement, and security and access control.
s Assembly and publishing services, which let users assemble multipledocuments with different formats into a larger document called a virtualdocument, which can then be published as a single document.
s Workflow management services, which let users develop process- andevent-oriented applications for document management. The modelsupports both production and ad hoc, project-oriented workflows.
s Document lifecycle services, which allow users to define the stages of adocuments life and control the movement of a document through thosestages.
s Viewing and printing services, which let users manage display-ready and
print-ready renditions of documents in conjunction with both revisableand archival formats of those same documents.
Users communicate with e-Content Server using Documentums client userinterfaces or user-written custom interfaces. Client applications communicatewith e-Content Server through the DFC (Documentum Foundation Classes),the server API methods (DMCL), or DQL (Document Query Language).
Every Docbase must have at least one active e-Content Server, but a Docbaseis not limited to one e-Content Server. For example, in a single-Docbasedistributed configuration, the Docbase typically has one server for each site inthe distributed environment.
-
8/6/2019 Get Started Document Um 41
20/104
Introducing Documentum 4iDocumentum Server Products
1-8 Getting Started with Documentum 4i
For more information about e-Content Server, refer to the documentation
described in Table 1-2 and to e-Content Server Release Notes.
Table 1-2 e-Content Server Documentation
Title Description
Installing e-Content Server Provides detailed instructions on how to install the server.Comes in various OS-specific and RDBMS-specificversions.
e-Content ServerFundamentals
Describes the basic features of the e-Content Server andhow to use them in an application environment. Explainshow to use the API to connect to a server, query a Docbase,and create and manipulate commonly used objects suchdocuments, workflows, and lifecycles.
e-Content ServerMigration Guide
Describes new server features introduced in the 4.xreleases and provides information and instructions for
those sites upgrading from server release 3.x to 4.x. (Theupgrade information is additional to the upgradeinstructions provided in the release notes or in Installinge-Content Server.)
e-Content Server APIReference Manual
Contains reference information about the e-Content ServerAPI methods. Describes the syntax and usage of eachmethod. Also contains a quick reference for the methodsand a list of methods by task category.
e-Content Server DQLReference Manual
Contains reference information about the DQL (DocumentQuery Language) language elements and statements.Describes the syntax and usage of each element andstatement. Also contains a quick reference for thestatements, a list of DQL reserved words, and a referencefor the administrative methods, which are invoked by theDQL EXECUTE statement.
e-Content Server ObjectReference Manual Contains reference information about the object typessupported by e-Content Server. The information includesa description of the characteristics of objects and attributesand a reference chapter that lists the attributes defined foreach object type. The manual also includes appendixesthat describe the structure of the object type tables in theRDBMS, language and country codes, and the viewsprovided with the server.
-
8/6/2019 Get Started Document Um 41
21/104
Introducing Documentum 4iDocumentum Server Products
Getting Started with Documentum 4i 1-9
Documentum Administrator
Documentum Administrator is a Web-based system administration tool. Itallows you to monitor, configure, and manage Docbases and federationsthroughout your installation from one computer running a Web browser. Forexample, using Documentum Administrator you can:
s Monitor Docbase system and resource usage
s Configure a Docbase or federation
s Create Web publishing configurations and manage publishing operationss Create, modify, and delete Docbase users and groups
s Create and modify object types
s Create and maintain ACLs
s Manage document archiving
e-Content ServerAdministrators Guide
Describes how to perform Docbase administrative taskssuch as creating users and groups, managing contentstorage areas, and updating full-text indexes. Providesguidelines for making configuration decisions andinstructions for changing configurations of Docbases,servers, DocBrokers, clients, and sessions. Also includes
information about Docbase security and monitoring, and areference chapter describing the suite of administrationtools provided with e-Content Server.
Documentum DistributedConfiguration Guide
Describes the server features that are used to constructsingle- and multi-Docbase distributed configurations,such as federations. Explains how to install and set up thefeatures used to implement distributed configurations andhow to maintain and manage distributed configurations.
e-Content ServerCombined Index
Combines the indexes from e-Content Server Fundamentals,the e-Content Server reference manuals, e-Content ServerMigration Guide, e-Content Server Administrators Guide, andDocumentum Distributed Configuration Guide.
Table 1-2 e-Content Server Documentation
Title Description
I t d i D t 4i
-
8/6/2019 Get Started Document Um 41
22/104
Introducing Documentum 4iDocumentum Server Products
1-10 Getting Started with Documentum 4i
For more information about Documentum Administrator, refer to the
documentation described in Table 1-3and to Documentum AdministratorRelease Notes.
Documentum RightSite
RightSite integrates e-Content Server with the Web. RightSite is installed onthe same machine as the HTTP server.
With RightSite installed, users can use a Web browser to view documents in aDocbase. RightSite presents the documents as Web pages in the browser orlaunches the documents native application to view the document (the choice
depends on the documents format and the client machines configuration).
Installing Intranet Client on the HTTP server host with RightSite providesusers with access to document management capabilities that are built intoRightSite. Without Intranet Client, users are limited to viewing documents.
For example, if Documentums Intranet Client is present, users can also:
s Navigate the cabinet and folder hierarchy of any Docbase
s View document attributes and document renditions
s View and publish virtual documents
s Search for documents by attribute values or content
s Participate in workflows
s Register for event notifications
s Link documents to their personal cabinets
Table 1-3 Documentum Administrator Documentation
Title Description
DocumentumAdministrator Help
Contains instructions for performing serveradministration tasks.
e-Content ServerAdministrators Guide
Contains instructions for performing serveradministration tasks.
DocumentumDistributedConfiguration Guide
Contains information on setting up a distributedconfiguration and performing administrative tasksfor federated Docbases.
Introducing Documentum 4i
-
8/6/2019 Get Started Document Um 41
23/104
Introducing Documentum 4iDocumentum Server Products
Getting Started with Documentum 4i 1-11
Additionally, if the users have a defined client capability level of Contributor
or Coordinator, they can check documents in to and out of the Docbase, andimport new documents into the Docbase. They can also use Virtual DocumentManager to create virtual documents and Workflow Manager to createworkflow templates. (Client capability is defined in the user s user object inthe Docbase.)
These capabilities are built into RightSite, not Intranet Client. If you prefer,you can write a user interface using Docbasic to make these capabilitiesavailable to your users through an interface other than Intranet Client.
For more information about RightSite, refer to the documentation described inTable 1-4and to RightSite release notes.
Content Personalization Services
Content Personalization Services (CPS) is a server product that enhancesDocumentum 4i by automating the categorization and attribute tagging ofdocuments in Docbases. Using Semantic Modeling Server, CPS creates anduses conceptual models of documents. CPS then uses information from theseconceptual models either to populate Docbase attribute fields (SmartTagging)or to classify documents automatically (SmartCategorization).
Table 1-4 RightSite Documentation
Title Description
Documentum RightSiteReference Manual
Provides an overview of RightSite architecture. Explainshow RightSite interacts with its clients. Contains extensivereference information for WebQL and RightSite methods.
RightSite AdministratorHelp
Provides information about how to configure andadminister RightSite and the Intranet Client.
Introducing Documentum 4i
-
8/6/2019 Get Started Document Um 41
24/104
Introducing Documentum 4iDocumentum Web Publishing Products
1-12 Getting Started with Documentum 4i
For more information about Content Personalization Services, refer to the
documentation described in Table 1-5and to Content Personalization ServicesRelease Notes.
Documentum Web Publishing Products
The Documentum 4i eBusiness Edition includes products that allowenterprises to publish content from a Docbase to a Web site:
s WebPublisher
s WebCache
s ContentCaster
s ftpIntegrator
Table 1-5 Content Personalization Services Documentation
Title Description
Resource Integration Guide Describes how to set up document submission andproperty extraction within CPS, and outlines the
configuration of the personalization features available inCPS.
CPS Administration Guide Provides a complete overview of the administrative tasksnecessary to set up CPS and presents a full tutorial on howto configure CPS for SmartTagging andSmartCategorization.
CPS Installation Guide Describes the necessary steps to install CPS.
The Domain MapDevelopers Guide
Provides the methodology for developing a CPS domainmap and provides hands-on experience in creatingdomain maps.
Domain Map Editor Help Tutorial on the Domain Map Editor, the GUI-based toolused in domain map development.
CPS Administration ToolHelp
Guides users through the administration tasks necessaryto set up SmartTagging and SmartCategorization.
CPS Glossary Defines the key terms used in Content PersonalizationServices.
Introducing Documentum 4i
-
8/6/2019 Get Started Document Um 41
25/104
Introducing Documentum 4iDocumentum Web Publishing Products
Getting Started with Documentum 4i 1-13
WebCache is required for using WebPublisher, but WebCache can also be used
as a stand-alone product.
WebPublisher
WebPublisher is a software application that provides a way to managecreating, reviewing, staging, and delivering contentincluding codeon aWeb site. WebPublisher automates processes for content authoring, content
management, Web site management, and content delivery.WebPublisher features:
s A framework for managing files that go on a Web site
s A Web-based interface for creating, administering, and managing Web-targeted content
s A Web-based editing environment for contributing content to Web sites
s Integrated WebCache allowing scalable, rapid delivery of content througha Web application server
s A sample Web site, templates, lifecycles, and so forth
WebPublisher allows you to specify:
s Which content files to publish to a Web site
s Which version to publish
s When to publish Web pages to a Web site
s When to withdraw Web pages from a Web site
For more information about WebPublisher, refer to the documentationdescribed in Table 1-6 and to WebPublisher Release Notes.
Table 1-6 WebPublisher Documentation
Title Description
WebPublisher InstallationGuide
Provides step-by-step instructions for installingWebPublisher.
WebPublisher ContentAuthors Guide and OnlineHelp
Provides an overview and step-by-step instructions forperforming content author tasks using WebPublisher.
Introducing Documentum 4i
-
8/6/2019 Get Started Document Um 41
26/104
gDocumentum Web Publishing Products
1-14 Getting Started with Documentum 4i
WebCache
Documentum WebCache allows documents to be published from a Docbase toa Web site. Documents are published that meet criteria specified in a Webpublishing configuration. HTML documents can be customized duringpublishing by inserting document attributes as META tags.
Web publishing configurations are created using DocumentumAdministrator. Single documents can be published using a server APImethod. Publishing is scheduled using a job.
For more information about Documentum WebCache, refer to thedocumentation described in Table 1-7and to the WebCache Release Notes.
WebPublisher ContentManagers Guide andOnline Help
Provides an overview and step-by-step instructions forperforming a content managers tasks usingWebPublisher.
WebPublisher WebDevelopers Guide andOnline Help
Provides an overview and step-by-step instructions forperforming Web developer tasks using WebPublisher.
WebPublisherAdministrators Guide andOnline Help
Provides an overview and step-by-step instructions forconfiguring and administering WebPublisher.
WebPublisher DocAppCustomization Guide
Provides step-by-step instructions for creating a customDocApp for a WebPublisher configuration.
Table 1-6 WebPublisher Documentation
Title Description
Table 1-7 WebCache Documentation
Title Description
Installing and UsingDocumentum WebCache
Provides an introduction to the product, installationinstructions, information on what can be published, andinstructions for publishing.
DocumentumAdministrator Help
Provides online Help for creating and editing Webpublishing configurations.
Introducing Documentum 4i
-
8/6/2019 Get Started Document Um 41
27/104
gDocumentum Web Publishing Products
Getting Started with Documentum 4i 1-15
ContentCaster
ContentCaster works in conjunction with WebCache to automatically deployactive Web site content from a cached Web site to one or more local or remoteproduction Web servers. Together, ContentCaster and WebCache compriseDocumentum Site Delivery Services.
WebCache invokes ContentCaster to deploy content any time WebCachemakes changes to the active cached Web site. ContentCaster can deploy
incremental changes to an existing active Web site, or it can deploy an entireWeb site.
ContentCaster includes a user interface to configure deployments, and itcontains Transmitter and Tuner modules to handle the transmission andreceipt of data. ContentCaster transmits the cached Web site directly to one ormore production Web servers. Alternatively, it transmits the cached Web siteto a traditional proxy server (for firewall protection) or a ContentCaster proxy,
which caches the transmitted Web site. This improves transmissionperformance to remote production Web servers.
For more information about ContentCaster, refer to the documentationdescribed in Table 1-8 and to ContentCaster Release Notes.
ftpIntegrator
Documentum ftpIntegrator provides a File Transfer Protocol (FTP) serverinterface between Macromedias Dreamweaver product and a WebPublisherDocbase repository. ftpIntegrator enables Web developers to develop Web sitefiles in the Dreamweaver environment and store these objects in a secureWebPublisher Docbase repository for use by WebPublisher.
Table 1-8 ContentCaster Documentation
Title Description
DocumentumContentCaster InstallationGuide
Provides instructions on how to install ContentCaster.
DocumentumContentCaster
Administrators Guide
Provides instructions on how to use the deploymentmanager interface to setup and configure a deployment.
Introducing Documentum 4i
-
8/6/2019 Get Started Document Um 41
28/104
Documentum Developer Tools
1-16 Getting Started with Documentum 4i
ftpIntegrator can be used to import a complete Web site into WebPublisher for
Web site management and deployment. ftpIntegrator imports Dreamweaverobjects as WebPublisher object types and assigns a format type to theimported objects that is recognized by the Documentum e-Content Server.
For more information about ftpIntegrator, refer to the documentationdescribed in Table 1-9.
Documentum Developer Tools
The Documentum 4i eBusiness Edition is highly customizable and can beadapted to the business needs of any organization. Documentum provides anumber of tools to assist developers in designing and implementingcustomizations, including:
s Web Development Kit
s Documentum Developer Studio
Web Development Kit
The Documentum Web Development Kit (WDK) enables developers to buildrobust, scalable applications for Documentum Web-based access.Applications built with the Web Development Kit have advantages overapplications built with ASP and DFC:
s Application logic is executed by Java classes on the server, with limitedscripting on the ASP or JSP page.
s Performance using server-side components is much better than withserver-side JavaScript, VBScript, or CGIs.
s The Web Development Kit supports session-based locking, which resolvestransactional issues when a user has concurrent sessions.
Table 1-9 ftpIntegrator Documentation
Title Description
Documentum ftpIntegratorInstallation Guide
Provides instructions on how to install ftpIntegrator.
Introducing Documentum 4iD t D l T l
-
8/6/2019 Get Started Document Um 41
29/104
Documentum Developer Tools
Getting Started with Documentum 4i 1-17
s Applications can be customized by extending the Web Development Kit
library and by editing simple XML configuration files.Your custom Web application can build upon the views, models, and serverpages in the Web Development Kit by adding your own custom user interface.
Documentum Developer Studio
Documentum Developer Studio and its companion product DocApp Installer
enable developers to customize the Documentum system and distributecustomizations throughout an enterprise.
Documentum Developer Studio is the principal tool for managing DocApps.It includes an object type editor, an attribute editor, a document lifecycleeditor, the Docbasic editor, and the DocApp Explorer. These tools allowdevelopers to:
s See and organize all parts of an application
s Create and modify many parts of the application
s Import elements from the Docbase into the application
s Refer symbolically to users, groups, permission sets, and Docbaselocations that have roles in the DocApp
s Designate some parts of the application as global, that is, available for useoutside the context of a specific object type
After an application is built and tested, use Documentum Developer Studio topackage it into a DocApp archive, which allows the application to be installedin another Docbase. The DocApp Installer allows the application to bedeployed to other Docbases.
Introducing Documentum 4iDocumentum Client Products
-
8/6/2019 Get Started Document Um 41
30/104
Documentum Client Products
1-18 Getting Started with Documentum 4i
For more information about Web Development Kit, Documentum Developer
Studio, and other customization tools and topics, refer to the documentationdescribed in Table 1-10 and to the release notes.
Documentum Client Products
Documentum 4i includes two client products, Documentum Desktop Clientand Documentum Intranet Client. These client products allow users toperform numerous document management tasks, including:
s Importing and exporting documents
Table 1-10 Developer Documentation
Title Description
Web Development Kit Help Provides a general overview of Web Development Kit andits use of ASP/JSP, then describes each WDK server page
in detail, including the underlying server-side and client-side code, as well as the WDK sample application.Discusses logging and tracing, error handling, debugging,and events. Includes a WDK Java library reference,configuration instructions, and a troubleshooting guide.
Customizing DocumentumClients
Discusses DocApps, document lifecycles, theDocumentum Foundation Classes (DFC), alias sets,customizing integrations, component development, and
Workflow Manager. Includes a tutorial for developing aDocApp using Developer Studio and Visual Basic.
Developer Studio Help Provides step-by-step instructions for creating andmodifying client applications, including creatingdocument lifecycles. Includes reference information aboutDocumentum ActiveX controls (widget library), DFC, andDesktop Client interfaces.
Migrating DocumentumDesktop ClientCustomizations
Provides instructions for migrating WorkSpace
3.2.x orSmartSpace 1.0.x customizations to Desktop Client.Includes a WorkSpace API reference.
Developing DocumentumDesktop ClientComponents (PDF only)
Detailed architectural background and design tips forcreating Desktop Client components using Visual Basic.
Introducing Documentum 4iDocumentum Client Products
-
8/6/2019 Get Started Document Um 41
31/104
Documentum Client Products
Getting Started with Documentum 4i 1-19
s Checking documents in to or out from a Docbase
s Versioning documentss Creating virtual documents
s Creating and participating in workflows
Desktop Client
Desktop Client is fully integrated with Windows Explorer and provides aneasy-to-use environment in which to perform document management tasks inthe Docbase. Desktop Client also supports integration with standard desktopapplications.
Intranet Client
Intranet Client enables users to access and view documents in a Docbase,contribute content, and perform a range of document management tasks froma Web browser.
For more information about Desktop Client and Intranet Client, refer to thedocumentation described in Table 1-11 and to the release notes.
Table 1-11 Client Documentation
Title Description
Intranet Client Help Provides context-sensitive help on how to performdocument management tasks using theDocumentum Intranet Client.
Introducing theDocumentum IntranetClient
Provides a conceptual overview of Intranet Client.Provides instructions for getting started withIntranet Client. Introduces document managementconcepts as well as functions and features such ascheck in and check out, versioning, virtualdocuments, and workflow.
Introducing Documentum 4iDocumentum Utilities
-
8/6/2019 Get Started Document Um 41
32/104
1-20 Getting Started with Documentum 4i
Documentum Utilities
The following utilities let you generate document renditions and Docbasereports, scan documents into a Docbase, and view and annotate imagedocuments from a Documentum client.
sAutoRender ProAutoRender Pro is a utility that generates copies of documents in PDF andHTML formats and stores them in a Docbase as renditions of the originaldocuments.
s Documentum Reporting Gateway
Reporting Gateway lets you use programs that access ODBC data sourcesto access data residing in Docbases.
Introducing theDocumentum DesktopClient
Provides a conceptual overview of Desktop Client,including integrations with familiar desktopapplications such as MS Word. Provides quickstart instructions for using Desktop Client.Introduces document management concepts aswell as functions and features such as check in and
check out, versioning, virtual documents, andworkflow.
Desktop Client Help Provides step-by-step instructions for performingdocument management tasks using the DesktopClient integration with MS Windows Explorer.
Integrations Help Provides step-by-step instructions for performingdocument management tasks using desktopapplications, such as MS Word, that integrate withthe Desktop Client.
VDM Help Provides step-by-step instructions for constructingand restructuring virtual documents.
Workflow ManagerHelp
Provides step-by-step instructions for designingworkflow templates.
Table 1-11 Client Documentation
Title Description
Introducing Documentum 4iOther Components
-
8/6/2019 Get Started Document Um 41
33/104
Getting Started with Documentum 4i 1-21
s DocInput
DocInput is image-capture software that allows you to scan documentsand store them as Docbase objects.
s Documentum DocViewer
Documentum DocViewer enables you to view and annotate TIFF and PDF(Portable Document Format) image documents from Documentums clientapplications. For example, you can view or annotate scanned documentscaptured using DocInput.
For more information about these products, refer to the DocInput andDocViewer documentation, the documentation described in Table 1-12, andthe release notes.
Other Components
Documentum 4i includes Workflow Manager, Documentum FoundationClasses (DFC), and Docbasic, components that are not sold as separateproducts.
Table 1-12 AutoRender Pro and Reporting Gateway Documentation
Title Description
AdministeringDocumentum
AutoRender Pro Pro
Provides instructions for installing, configuring,administering, and using Documentums utilityfor creating PDF renditions in response to callsfrom a client application. Also includesinformation about writing plug-ins to extendAutoRender Pro and configuring variousDocumentum products for term-hit highlighting.
Documentum
Reporting GatewayInstallation andRelease Notes
Provides instructions for installing Reporting
Gateway and using programs that access ODBCdata sources to access data residing in Docbases.
Introducing Documentum 4iOther Components
-
8/6/2019 Get Started Document Um 41
34/104
1-22 Getting Started with Documentum 4i
Workflow Manager
Workflow Manager is a client for developing workflow templates. It isaccessed through Desktop Client, Documentum Developer Studio, andIntranet Client.
Documentum Foundation Classes
The components that provide Desktop Clients functionality communicatewith the server via the Documentum Foundation Classes (DFC). DFC, a set ofJava classes, makes most e-Content Server functionality available to clientprograms through a published set of interfaces. The interfaces specify DFCconstants and methods. DFC provides a convenient way to accessDocumentum functionality with customized components.
DFC manages communications between client and server. Components using
DFC simply create and use session objects, allowing developers to focus onbusiness logic.
DFC also includes business logic above the level of the server API (DMCL).This provides a framework for applications that use e-Content Serverfacilities.
Docbasic
Docbasic is an easy-to-use language that allows developers to modifyDocumentum client products and to interact directly with e-Content Server.
Refer to the documents described in Table 1-13 for more information aboutWorkflow Manager, DFC, and Docbasic.
Table 1-13 WorkFlow Manager, DFC, and Docbasic Documentation
Title Description
Workflow ManagerHelp
Provides step-by-step instructions for designingworkflow templates.
Introducing theDocumentum DesktopClient
Provides conceptual information on WorkflowManager
Introducing Documentum 4iOther Components
-
8/6/2019 Get Started Document Um 41
35/104
Getting Started with Documentum 4i 1-23
DFC Reference Help A DFC Java library reference. Available inDeveloper Studio online Help and separately asHTML files.
Docbasic ReferenceManual
Provides reference information for theprogramming language provided byDocumentum for interacting directly with
e-Content Server. Discusses how Docbasic relatesto Documentum clients. Describes how to editDocbasic procedures.
Docbasic Help Provides the same information as the referencemanual.
Table 1-13 WorkFlow Manager, DFC, and Docbasic Documentation
Title Description
Introducing Documentum 4iOther Components
-
8/6/2019 Get Started Document Um 41
36/104
1-24 Getting Started with Documentum 4i
2
-
8/6/2019 Get Started Document Um 41
37/104
Getting Started with Documentum 4i 2-1
2Documentum Architecture 2
The Documentum system consists of client and server products that allowusers to access Docbases (content repositories) and publish content from aDocbase to the World Wide Web. This chapter discusses the following topics:
s Docbase Structure on page 2-1
s Client, Server, and Database Relationships on page 2-2
Docbase Structure
In the Documentum system, documents are composed of content files (thesource file in its native format) and metadata (attributes). A Docbase also storesindex files and structural objects that define the Docbase itself, includinglocation objects, format objects, method objects, and job objects.
Information in the Docbase is stored in two places:
s Content files are stored in a protected directory structure in the serverhosts file system.
s Document attributes, such as document owner, version, and creation date,are stored in relational database tables.
Figure 2-1 shows the elements that comprise a Docbase.
Documentum ArchitectureClient, Server, and Database Relationships
-
8/6/2019 Get Started Document Um 41
38/104
2-2 Getting Started with Documentum 4i
Figure 2-1 Docbase Structure
Client, Server, and Database Relationships
Docbases are supported by a three-tiered architecture.
At the top level, client applications allow users to create, edit, and viewdocuments and modify metadata.
At the middle level, e-Content Server handles requests from Documentumclient applications. Application logic is located on the server, and RDBMScalls are made using server API calls.
At the bottom level, the RDBMS server and the operating system handlerequests from e-Content Server and store information on the file system or inRDBMS tables.
Figure 2-2illustrates how the three tiers interact:
Together, they
comprise a Docbase.
=+
Database tables store
document attribute
information.
The native file
system stores
content files.
Documentum ArchitectureClient, Server, and Database Relationships
-
8/6/2019 Get Started Document Um 41
39/104
Getting Started with Documentum 4i 2-3
Figure 2-2 Documentum 4i Three-Tier Architecture
1
2
3
Client Applications
Documentum
Servers
RDBMS Server and
File System
e-Content Server
HTTP Server
RightSite
Server O/S:
Windows NT
Client O/S:
Windows 95, 98,
2000 or NT
Client Library and Supporting Files
File SystemRDBMS:
Oracle,
Sybase,
Microsoft SQL Server
WebPublisher
Intranet Client
TCP/IP
Desktop Client
TCP/IP
Client Library and
Supporting Files
Documentum ArchitectureClient, Server, and Database Relationships
-
8/6/2019 Get Started Document Um 41
40/104
2-4 Getting Started with Documentum 4i
3
-
8/6/2019 Get Started Document Um 41
41/104
Getting Started with Documentum 4i 3-1
3Installing Documentum 4i 3
This chapter contains information about installing Documentum 4i, includingdecisions you must make regarding system resources and the order in whichto install Documentum 4i products. It discusses the following topics:
s Planning Your Installation on page 3-1
s Installation Sequence on page 3-8
Before you install, you should also complete the preinstallation checklists inthis book and review the release notes for each product you are installing.
Planning Your Installation
To get the most out of your Documentum 4i installation, plan the systemconfiguration before installing the hardware and software.
During the planning process, list the dependencies for each system
component to ensure that all requirements are met before installation. Use theinstallation guides for each product as well as the preinstallation checklists inthis guide to make sure you have the system resources and information youneed.
For more information about planning your e-Content Server installationconfiguration, refer to the e-Content Server Administrators Guide. If you plan toinstall a distributed system, refer to the Documentum Distributed Configuration
Guide.
Installing Documentum 4iPlanning Your Installation
-
8/6/2019 Get Started Document Um 41
42/104
3-2 Getting Started with Documentum 4i
Allocating System Resources
Documentum 4i depends on the proper installation and configuration of yournetwork, RDBMS, server hosts, and server and client operating systems. Forexample:
s Desktop Client cannot connect to e-Content Server without a correctlyinstalled and configured TCP/IP LAN or WAN.
s e-Content Server cannot function without the underlying RDBMS.
s The application integrations, which allow you to access a Docbase directlyfrom popular software applications such as Microsoft Word, cannotfunction unless the applications are installed.
Test your system resources and software to confirm that they are available andfunctioning properly before installing Documentum 4i.
Here is the order in which to set up and test your installation:
s Network and computer hardwares Network software
s Server and client operating systems
s Relational database management system (RDBMS)
s Documentum server products (e-Content Server, RightSite)
s Integrated third-party applications
s Documentum client products
s Documentum developer tools (Documentum Developer Studio, WebDevelopment Kit)
s Documentum Web publishing products (WebCache, WebPublisher, andContentCaster)
Preinstallation Testing and Configuration
Before you install any Documentum products, test the installation andconfiguration of the following key components:
s Network and computer hardware
s TCP/IP network
s Server operating system
Installing Documentum 4iPlanning Your Installation
-
8/6/2019 Get Started Document Um 41
43/104
Getting Started with Documentum 4i 3-3
s RDBMS
sClient operating system
s Desktop computers and applications
Planning the Network and Computer Hardware
Your network must have sufficient capacity to support the hosts runningDocumentum server products as well as Documentum users and their
computers.
Each computer in the installation must meet the minimum requirements forrunning the Documentum products to be installed. Refer to the checklists inthis book and to the release notes for each product to determine the minimumsystem requirements for the computers.
You must decide which Documentum products to install on each computerand whether to install the RDBMS on the same computer as e-Content Server,
then ensure that enough computers are available for the system and all users.
If you are installing all of the products included with Documentum 4i, youmust use at least four computers, because AutoRender Pro, Web DevelopmentKit and Content Personalization Services must be installed on stand-alonecomputers.
Typically, each Documentum end user has a personal computer runningDesktop Client or a browser to access the Docbase.
Documentums architecture allows considerable flexibility in designing yourserver configuration. Refer to the Documentum e-Content Server AdministratorsGuide and the Documentum Distributed Configuration Guide for moreinformation on configuring your installation to meet your specific businessneeds.
For information which products can and cannot be installed on the same
computer, refer to Product Compatibility on page 3-7and to the releasenotes for each product you are installing.
Installing Documentum 4iPlanning Your Installation
-
8/6/2019 Get Started Document Um 41
44/104
3-4 Getting Started with Documentum 4i
Planning and Testing the TCP/IP Network
TCP/IP must be installed on the same computer as e-Content Server. Theclient computers must be able to communicate with the server using TCP/IP.Here are some things to check before you install Documentum on the hostmachine:
s Use ping or another simple test to make sure the client computers cancommunicate with the computer that will be the e-Content Server hostmachine.
s Confirm that your network can transfer large files from the server host to aclient machine.
For example, verify that it is possible to FTP a file from the machine thatwill run e-Content Server to a client machine that will run Desktop Client.Although Documentum does not use FTP directly, using FTP to transfer afile is a reasonable test of network access, performance, and stability.
After you install all Documentum products, you should also check out alarge file from a Docbase to a machine running Desktop Client. If the FTPtest and Desktop Client checkout experience similar errors or poorperformance, your TCP/IP software may be incorrectly configured or yournetwork may not have enough bandwidth.
For more information about how e-Content Server handles client-server sessions over a network, refer to the e-Content ServerAdministrators Guide.
Planning the Server Operating System Installation
This section discusses two main areas you need to consider when testing theserver operating system that will support e-Content Server:
s Operating system privileges and accounts
s Resources
Installing Documentum 4iPlanning Your Installation
-
8/6/2019 Get Started Document Um 41
45/104
Getting Started with Documentum 4i 3-5
Operating System Privileges and Accounts
To install and configure e-Content Server, create an installation owner account.The installation owner controls the administrator account and password.Under Windows NT, the installation owner must be a member of the localAdministrators group. The installation owner should not be the same accountas the Windows NT Administrator.
The installation owner account is known as dmadmin on UNIX andDocumentumon Windows NT. (The installation owner account names differ
because UNIX restricts the account name to no more than eight characters.)
Only the user who owns the Documentum installation owner account candirectly access the files in the file system.
Many organizations require security checks before creating new useraccounts. There may also be a backlog for fulfilling system administrationrequests, so obtain any system privileges you need in advance of installationday.
Resources
For performance reasons you may wish to install the e-Content Server,RightSite, RDBMS, and Web server software on different hosts.
Verify that you have sufficient disk space and RAM.
s You need disk space for the RDBMS installation, the e-Content Serverinstallation, RightSite, and Docbase content file storage.
s You need sufficient RAM for the RDBMS, e-Content Server, RightSite, andthe Docbases.
For specific information about hardware and software requirementsfor e-Content Server installation, refer to the preinstallationchecklists in Chapter 4, e-Content Server Preinstallation Checklists,
and to Installing Documentum e-Content Server for your operating system. Forspecific information about hardware and software requirements for RightSiteinstallation, refer to the preinstallation checklists in Chapter 7, RightSite andSpider Preinstallation Checklists, and to the RightSite Installation and ReleaseNotes for your operating system.
Installing Documentum 4iPlanning Your Installation
-
8/6/2019 Get Started Document Um 41
46/104
3-6 Getting Started with Documentum 4i
Planning the RDBMS Installation
This section discusses the main areas you need to consider when planning theRDBMS installation that will store the metadata for your Documentum 4iinstallation:
s Required RDBMS privileges
s RDBMS connectivity
s RDBMS server locations
Your organization may have security procedures that must be met beforegranting network access to the RDBMS. There may also be DBA backlogs forfulfilling requests to set up the database itself or database accounts.
Required RDBMS Privileges
To create a database user account for the Docbase, you need access to an
RDBMS administrator account and password. For example, in an Oracleinstallation, this account is the SYSTEM account.
RDBMS Connectivity
You need to understand how to connect to the RDBMS from the networkinterface, even if both e-Content Server and the RDBMS server run on thesame machine. Since e-Content Server connects to the RDBMS at startup,e-Content Server needs the same information you use to connect to theRDBMS from the network.
For example, Oracle uses the SQL*Net Version 2 connection string and theinteractive SQL utility called SQL*Plus.
Consult your database administrator or the documentation for your RDBMSfor additional information on configuring your system so that e-Content
Server connects properly with the RDBMS at startup.
RDBMS Server Locations
The RDBMS server does not have to be on the same computer as e-ContentServer. When the RDBMS is installed on a different host, Documentumservers connect using the appropriate RDBMS network drivers. For example,if you use Oracle, you need SQL*Net.
Installing Documentum 4iPlanning Your Installation
-
8/6/2019 Get Started Document Um 41
47/104
Getting Started with Documentum 4i 3-7
For more information about which RDBMS Documentum supportson your operating system, refer to Installing Documentum e-Content
Serverand Documentume-Content Server Release Notes.Planning the Client Operating System Installation
Documentum Desktop Client has different Active Desktop requirements forinstallation on different version of Windows.
s On Windows 95 or Windows NT, the Active Desktop upgrade is optional.
s On Windows 98 or Windows 2000, the Active Desktop upgrade isrequired.
Product Compatibility
Several Documentum products must be installed on stand-alone computers:
s AutoRender Pro
s Content Personalization Services
s Web Development Kit
Other products can or must be installed on the same machine:
s You can install the RDBMS on the same computer as e-Content Server, oryou can install it on a different computer.
s You can install e-Content Server on the same computer as RightSite, butDocumentum recommends installing them on different computers.
s You can install the WebCache target program on the same machine ase-Content Server, but publishing to a Web site located on the server hostmeans that you do not have the protection of a firewall between theDocbase and the Web site.
sYou must install Intranet Client, Documentum Administrator, andWebPublisher on the same machine as RightSite.
Installing Documentum 4iInstallation Sequence
-
8/6/2019 Get Started Document Um 41
48/104
3-8 Getting Started with Documentum 4i
Installation Sequence
After you install and configure the required system components, such as yourserver operating system, RDBMS, HTTP server, and TCP/IP, you can proceedto install Documentum 4i.
Before you install Documentum 4i, complete the preinstallation checklists inthis book and review the release notes for each product you are installing.
Use the following installation sequence if you are installing multipleDocumentum products on the same computer. To ensure that you do notinstall incompatible products on the same computer, refer to the precedingsection, Product Compatibility, and to the installation guides and releasenotes for each product. You can find a complete list of these documents inChapter 1, Introducing Documentum 4i.
Install Documentum 4i in the following order:
1. Install e-Content Server and configure a Docbase.
2. Install RightSite.
3. Install Documentum Administrator.
4. Install Documentum Developer Studio.
5. Install Intranet Client.
6. Install WebCache.7. Install WebPublisher.
8. Install any word processor, spreadsheet, email, viewer, and other personalproductivity applications that are integrated with Desktop Client.
9. Install Desktop Client.
10. Install Web Development Kit.
11. Install additional server products, such as Content Personalization Services.
12. Install ContentCaster.
13. Install ftpIntegrator.
14. Install additional Documentum products, such as AutoRender Pro, DocInput,and so on.
4
-
8/6/2019 Get Started Document Um 41
49/104
Getting Started with Documentum 4i 4-1
4e-Content Server PreinstallationChecklists 4
This chapter contains preinstallation checklists for installing e-Content Serveron Windows NT or UNIX systems.
To ensure that your system is properly prepared for an e-Content Serverinstallation or upgrade, complete the following two checklists:
s The checklist for operating system-specific hardware and softwarerequirements
s The checklist for required information, such as environment variables andRDBMS-specific account information
e-Content Server Preinstallation ChecklistsWindows NT Checklist
-
8/6/2019 Get Started Document Um 41
50/104
4-2 Getting Started with Documentum 4i
Windows NT Checklist
This section lists the resources and information required for installing thee-Content Server on Windows NT. Mark the checkboxes in the left-handcolumn as you verify each requirement.
Table 4-1 Minimum Server Requirements for Windows NT Systems
An Intel Pentium 330 MHz PC or better
Windows NT Server 4.0 with Service Pack 5, running NTFS
256 MB of RAM
13 MB of shared memory
Sufficient disk space for the operating system and swap space:
130 MB for the e-Content Server software
100 MB of available disk space on an NTFS file system
TCP/IP (Microsofts TCP/IP for Windows NT)
Network interface card (a 32-bit card is recommended)
Email notification software (Microsoft Exchange or Outlook 98 installedon the same host as the e-Content Server)
Verify that the network between the server machine and the clients isfunctioning correctly.
One of the following:
Oracle RDBMS version 8.1.5 or 8.1.6, with Oracle Client Librariesversion 7.3.2 or later and with configured TNS alias
Microsoft SQL Server version 7.0 with Service Pack 1, configured with
the case-sensitive option turned on, ODBC properly configured, andRegistered Server
Note: If you install SQL Server and e-Content Server in differentdomains, the installation owner must be a valid user both domains.
Depending on which RDBMS you are using, refer to Installing Documentume-Content Server for Windows NT with SQL Server or to Installing Documentume-Content Server for Windows NT with Oracle for more information aboutinstallation requirements.
e-Content Server Preinstallation ChecklistsInstalling or Upgrading on Windows NT
I t lli U di Wi d NT
-
8/6/2019 Get Started Document Um 41
51/104
Getting Started with Documentum 4i 4-3
Installing or Upgrading on Windows NT
Use this checklist to record information that you need to install or upgradee-Content Server on a Windows NT system. The checklist entries are in theorder in which you need the information. For more information aboutinstalling e-Content Server on Windows NT systems, refer to the InstallingDocumentum e-Content Server.
Table 4-2 e-Content Server Preinstallation Checklist
Prerequisite Comments Complete? (Y/N)
Preferred upgradetechnique
If you are upgrading from aprevious release, decide whetheryou prefer to upgrade in place orto use the dump and load utilitiesto migrate your installation. Refer
to Installing Documentum e-ContentServer for further informationabout your upgrade options.
Documentum installationowner user name
The user who performs thee-Content Server installationautomatically becomes theinstallation owner (also known asthe dmadmin).
Installation ownerpassword
Also known as the dmadminpassword.
Program folder This is the folder or directorywhere the e-Content Server andDocbase icons will be located.
Docbase name Must be unique in your networkor organization. No spaces or
nonalphanumeric charactersallowed; do not begin with a digit.
Docbase ID Valid Docbase IDs are shippedwith the e-Content Serversoftware. Contact DocumentumTechnical Support if you needadditional Docbase IDs.
e-Content Server Preinstallation ChecklistsInstalling or Upgrading on Windows NT
Table 4 2 C t t S P i t ll ti Ch kli t
-
8/6/2019 Get Started Document Um 41
52/104
4-4 Getting Started with Documentum 4i
User name The RDBMS account that will ownall Documentum objects. Shouldbe the same as the Docbase ownername.
User password The password for the RDBMSaccount that will own all
Documentum objects
System user name andpassword
Required if you wish to create anRDBMS accounts
Oracle TNS Name or SQLServer ODBC Data Sourcename
The connection string for yourDocbases database. Required ifyou create an Oracle account.
An estimate of yourDocbase size (small,medium, or large)
s Create small Docbases forapplication development useor deployments to smallgroups.
s Create medium Docbases forlarge groups or largeapplication-developmentenvironments.
s
Create large Docbases forenterprise-wide deployments.
Datafile size Required if you ask Setup tocreate an RDBMS account
Index datafile size Required if you ask Setup tocreate an RDBMS account
Your preferred email
package for sendingevent notifications
Install Microsoft Exchange server
for email notifications.
Name of the NT domainwhere Documentumusers will beauthenticated
If users do not specify an NTdomain at connect time, thisdomain name will be the defaultdomain. Choose the most populardomain.
Table 4-2 e-Content Server Preinstallation Checklist
Prerequisite Comments Complete? (Y/N)
e-Content Server Preinstallation ChecklistsInstalling or Upgrading on Windows NT
Table 4 2 e Content Server Preinstallation Checklist
-
8/6/2019 Get Started Document Um 41
53/104
Getting Started with Documentum 4i 4-5
DocBroker host name Required if you choose to use aremote DocBroker rather thaninstalling a local DocBroker. Thename of a remote DocBroker isusually the same as the name ofthe host computer where yourDocBroker is running.
Table 4-2 e-Content Server Preinstallation Checklist
Prerequisite Comments Complete? (Y/N)
e-Content Server Preinstallation ChecklistsUNIX Checklist
UNIX Checklist
-
8/6/2019 Get Started Document Um 41
54/104
4-6 Getting Started with Documentum 4i
UNIX Checklist
This section lists the resources and information required for installinge-Content Server on UNIX. Mark the checkboxes in the left-hand column asyou verify each requirement.
Table 4-3 Minimum Server Requirements for UNIX Systems
A SPARCstation 2 (for Solaris) or HP 9000/series 800 (for HP-UX)
Solaris 2.6, Solaris 7, or HP-UX 11.00
128 MB of RAM (256 MB for better performance)
Sufficient disk space for the operating system and swap space:
300 MB for the e-Content Server software (1 GB recommended)
100 MB for storing objects in the Docbase (may require up to 150
MB)
Network interface card (Ethernet)
TCP/IP and NFS protocols installed
Email notification software (Microsoft Exchange or Outlook 98 installedon the same host as the e-Content Server)
Verify that the network between the server machine and the clients isfunctioning correctly.
One of the following:
Oracle RDBMS version 8.1.5 or 8.1.6, with Oracle Client Librariesversion 7.3.2 or later and with configured TNS alias
Sybase 11.9.2.3
Depending on which RDBMS you are using, refer to Installing Documentume-Content Server for UNIX with Oracle or to Installing Documentum e-Content Server
for UNIX with Sybase and to the appropriate release notes for more informationabout installation requirements.
e-Content Server Preinstallation ChecklistsInstalling or Upgrading on UNIX
Installing or Upgrading on UNIX
-
8/6/2019 Get Started Document Um 41
55/104
Getting Started with Documentum 4i 4-7
Installing or Upgrading on UNIX
Use this checklist to record information that you need to install or upgradee-Content Server on a UNIX system. The checklist entries are in the order inwhich you need the information. For more information about installinge-Content Server on UNIX systems, refer to Installing e-Content Server.
Table 4-4 e-Content Server Preinstallation Checklist
Prerequisite Comments Complete? (Y/N)
Preferred upgradetechnique
If you are upgrading from aprevious release, decide whetheryou prefer to upgrade in place orto use the dump and load utilitiesto migrate your installation. Referto Installing e-Content Server forfurther information about yourupgrade options.
Documentum installationowner user name
The user who performs thee-Content Server installationautomatically becomes theinstallation owner (also known asthe dmadmin).
Installation owner
password
Also known as the dmadmin
password.
Program directory This is the directory where thee-Content Server and Docbaseicons will be located.
Docbase name Must be unique in your networkor organization. No spaces ornonalphanumeric characters
allowed; do not begin with a digit.
Docbase ID Valid Docbase IDs are shippedwith the e-Content Serversoftware. Contact DocumentumTechnical Support if you needadditional Docbase IDs.
e-Content Server Preinstallation ChecklistsInstalling or Upgrading on UNIX
Table 4-4 e-Content Server Preinstallation Checklist
-
8/6/2019 Get Started Document Um 41
56/104
4-8 Getting Started with Documentum 4i
User name The RDBMS account that will ownall Documentum objects. Shouldbe the same as the Docbase ownername.
User password The password for the RDBMSaccount that will own all
Documentum objects
System user name andpassword
Required if you wish to create anRDBMS accounts
Database connectioninformation
The connection string for yourDocbases database. Required ifyou create a database account forthe Docbase owner.
An estimate of yourDocbase size (small,medium, or large)
s Create small Docbases forapplication development useor deployments to smallgroups.
s Create medium Docbases forlarge groups or largeapplication-developmentenvironments.
s Create large Docbases forenterprise-wide deployments.
Datafile size Required if you ask Setup tocreate an RDBMS account
Index datafile size Required if you ask Setup tocreate an RDBMS account
Your preferred emailpackage for sendingevent notifications
Install Microsoft Exchange serverfor email notifications.
Prerequisite Comments Complete? (Y/N)
e-Content Server Preinstallation ChecklistsInstalling or Upgrading on UNIX
Table 4-4 e-Content Server Preinstallation Checklist
-
8/6/2019 Get Started Document Um 41
57/104
Getting Started with Documentum 4i 4-9
DocBroker host name Required if you choose to use aremote DocBroker rather thaninstalling a local DocBroker. Thename of a remote DocBroker isusually the same as the name ofthe host computer where yourDocBroker is running.
Prerequisite Comments Complete? (Y/N)
e-Content Server Preinstallation ChecklistsInstalling or Upgrading on UNIX
-
8/6/2019 Get Started Document Um 41
58/104
4-10 Getting Started with Documentum 4i
5
-
8/6/2019 Get Started Document Um 41
59/104
Getting Started with Documentum 4i 5-1
Content Personalization ServicesPreinstallation Checklists 5
This chapter contains preinstallation checklists for Content PersonalizationServices.
To ensure that your system is properly prepared for a Content PersonalizationServices installation or upgrade, complete the following two checklists:
s The checklist for hardware and software requirements
s The checklist for required information and tasks, such as creating
directories or environment variables on your system
Content Personalization Services Preinstallation ChecklistsContent Personalization Services Checklist
Content Personalization Services Checklist
-
8/6/2019 Get Started Document Um 41
60/104
5-2 Getting Started with Documentum 4i
This section lists the resources and information required for installing CPS.Mark the checkboxes in the left-hand column as you verify each requirement.
Table 5-1 Minimum Requirements
Pentium II-400 MHZ
Windows NT Server, Service Pack 5, Option Pack 4
Minimum 256 MB RAM; recommended 384 or higher
500 MB free disk space per computer that hosts a CPS service layer
Documentum e-Content Server
Oracle 8.1.5 database and client
10 BaseT/100 BaseT Ethernet
Sun VM 1.1.2
Documentum JRun
Refer to the The CPS Installation Manual (on the product installation CD)for more information about installation requirements.
Content Personalization Services Preinstallation ChecklistsInstalling Content Personalization Services
Installing Content Personalization Services
-
8/6/2019 Get Started Document Um 41
61/104
Getting Started with Documentum 4i 5-3
Use this checklist to record information you need to install or upgrade WebDevelopment Kit.
Table 5-2 CPS Preinstallation Checklist
Prerequisite Comments Complete? (Y/N)
Ensure that the person whoinstalls CPS has administratorprivileges on the machinewhere CPS is installed
Ensure that Windows NT withService Pack 5 and OptionPack 4 have been installed
Content Personalization Services Preinstallation ChecklistsInstalling Content Personalization Services
-
8/6/2019 Get Started Document Um 41
62/104
5-4 Getting Started with Documentum 4i
6
-
8/6/2019 Get Started Document Um 41
63/104
Getting Started with Documentum 4i 6-1
Desktop Client PreinstallationChecklists 6
This chapter contains preinstallation checklists for the Documentum DesktopClient.
To ensure that your system is properly prepared for a Desktop Clientinstallation or upgrade, complete the following two checklists:
s The checklist for hardware and software requirements
s The checklist for required information and tasks, such as creating
directories or environment variables on your system
Desktop Client Preinstallation ChecklistsDesktop Client Checklist for Windows 95, 98, or 2000
Desktop Client Checklist for Windows 95, 98, or
-
8/6/2019 Get Started Document Um 41
64/104
6-2 Getting Started with Documentum 4i
2000
This section lists the resources and information required for installing theDesktop Client on client machines running Windows 95, 98, or 2000. Mark thecheckboxes in the left-hand column as you verify each requirement.
Table 6-1 Minimum Requirements for Windows 95, 98, or 2000 Systems
A Pentium 90 MHz PC or better (Pentium 200 recommended)
Microsoft Windows 95 with WIN95Y2K.exe, without DesktopUpgrade, or Windows 98 or 2000 with Desktop Upgrade
128 MB of RAM (96 MB of RAM is the minimum free memory youmust have after your most commonly used applications are running)
90 MB of disk space if Internet Explorer 4.x is already installed (25 MBon your system drive, 65 MB on your install drive) or
110 MB of disk space if you Internet Explorer is not already installed(45 MB on your system drive, 65 MB on your install drive)
Sufficient free space for document checkouts.
Additional disk space as required for editing and viewing applications(such as MS Word).
Native TCP/IP protocol
Network interface card
One or more of the following for Integration Applications:
Microsoft Office 97 (SR1 and SR2) or Microsoft Office 2000 (SR1) forrunning the following three Application Integrations:
Word 97 or Word 97 (ODMA) or Word 2000
Microsoft Excel 97 or 2000
Microsoft PowerPoint 97 (ODMA) or 2000
Microsoft Outlook 98 or 2000
Microsoft Quick View 95
Desktop Client Preinstallation ChecklistsDesktop Client Checklist for Windows 95, 98, or 2000
Table 6-1 Minimum Requirements for Windows 95, 98, or 2000 Systems
-
8/6/2019 Get Started Document Um 41
65/104
Getting Started with Documentum 4i 6-3
Adobe Business Tool (Acrobat Exchange 4.0)
Inso Quick View Plus 4.0
Corel WordPerfect 8.0 (ODMA)
Lotus Word Pro 96 Edition (ODMA)
Refer to the Desktop Client Installation and Release Notes for more informationabout installation requirements.
Desktop Client Preinstallation ChecklistsDesktop Client Checklist for Windows NT
Desktop Client Checklist for Windows NT
-
8/6/2019 Get Started Document Um 41
66/104
6-4 Getting Started with Documentum 4i
This section lists the resources and information required for installing theDesktop Client on Windows NT client machines. Mark the checkboxes in theleft-hand column as you verify each requirement.
Table 6-2 Minimum Requirements for Windows NT Systems
Intel Pentium 133 MHz PC (233 MHz recommended)
Microsoft Windows NT Workstation 4.0 with SP5 or SP6a, with orwithout Desktop Upgrade
128 MB of RAM (96 MB of RAM is the minimum free memory youmust have after your most commonly used applications are running)
90 of MB disk space if Internet Explorer 4.x or 5 is already installed (25megabytes on your system drive, 65 megabytes on your install drive) or
110 of MB disk space if Internet Explorer is not already installed (45megabytes on your system drive, 65 megabytes on your install drive)
Sufficient free space for document che