emc documentum formsbuilder · emc®documentum® formsbuilder version6.5 installationguide...

30
EMC ® Documentum ® Forms Builder Version 6.5 Installation Guide P/N 300007259 A01 EMC Corporation Corporate Headquarters: Hopkinton, MA 01748‑9103 1‑508‑435‑1000 www.EMC.com

Upload: dophuc

Post on 13-May-2018

229 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

EMC® Documentum®

Forms BuilderVersion 6.5

Installation GuideP/N 300­007­259 A01

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748‑91031‑508‑435‑1000www.EMC.com

Page 2: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Copyright © 1994 ‑ 2008 EMC Corporation. All rights reserved.

Published July 2008

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up‑to‑date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

All other trademarks used herein are the property of their respective owners.

Page 3: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Table of Contents

Preface ........................................................................................................................... 5

Chapter 1 Preparing for Installation ........................................................................ 9About Documentum Forms Builder .............................................................. 9Supporting software requirements............................................................... 10Content Server and Documentum repositories.......................................... 10Connection brokers and the dfc.properties file.......................................... 11Documentum Foundation Classes ........................................................... 11WDK application.................................................................................... 12Documentum Composer ......................................................................... 12Java Runtime Engine .............................................................................. 12OpenOffice.org....................................................................................... 12

Chapter 2 Installing Documentum Forms Builder .................................................. 15Installing the Forms Builder software........................................................... 15Installing the Forms Builder DAR ................................................................ 17Using Documentum Process Engine ........................................................ 17Using Documentum Composer ............................................................... 17

Installing the bar code OpenOffice extension package ................................... 18

Chapter 3 Upgrading Forms Builder ...................................................................... 21Overview of the Forms Builder upgrade process........................................... 21Upgrading Forms Builder 5.3 to release 6.5................................................... 22Upgrading from Forms Builder 6.0 to release 6.5........................................... 23Deleting old icons................................................................................... 23Migrating DocApps ................................................................................ 23

Tasks to complete after upgrading Forms Builder ......................................... 24

Chapter 4 Postinstallation Tasks ........................................................................... 25Giving users access to Documentum Forms.................................................. 25

Chapter 5 Uninstalling Forms Builder .................................................................... 27Removing the Forms Builder software ......................................................... 27

EMC Documentum Forms Builder Version 6.5 Installation Guide 3

Page 4: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Table of Contents

4 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 5: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Preface

Purpose of this guideThis guide contains instructions for installing Documentum Forms Builder, the formtemplate creation and editing tool that is installed on a Windows platform. This guidealso explains the Forms Builder Documentum Archive (DAR) file, which sets up theobject types and roles to create and use forms, and is installed on the DocumentumContent Server. In addition, this guide provides information about upgrading the FormsBuilder software from an earlier release to release 6.5.

Forms Runtime is installed as part of a standard installation of Web Development Kit(WDK) applications and is, therefore, not covered in this guide. Forms is supported byWDK, Webtop, TaskSpace, Records Manager Administrator, and Digital Asset Manager.

If you are installing Documentum Forms Builder as part of Process Builder, you do notneed to use this guide because Forms Builder is installed by the Process Builder installer.

Intended audienceThis guide is intended for administrators who install Forms Builder. The installationprocess requires installing a Documentum Forms Builder DAR file and copying filesonto the Content Server machine, so the user must have EMC Documentum superuser oradministrator privileges. Once a EMC Documentum repository has been configured, anynumber of people can install Forms Builder on their computers.

OrganizationThis guide contains the following chapters:

• Chapter 1, Preparing for Installation

This chapter describes the tasks to be completed before installing Forms Builder.• Chapter 2, Installing Documentum Forms Builder

This chapter describes how to install the Forms Builder software and the FormsDAR file.

• Chapter 3, Upgrading Forms Builder

This chapter describes how to upgrade the Forms Builder software from version 5.3to version 6.5. It also provides some necessary information when moving fromForms Builder version 6.0 to 6.5, although there is no upgrade process necessary.

EMC Documentum Forms Builder Version 6.5 Installation Guide 5

Page 6: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Preface

• Chapter 4, Postinstallation Tasks

This chapter describes any tasks that must be completed after Forms Builder isinstalled.

• Chapter 5, Uninstalling Forms Builder

This chapter describes how to uninstall Forms Builder from the computer.An index is also included.

Typographic conventionsThe following text conventions are used in this guide.

Convention Meaning

Italic Italic type indicates book title, or emphasis in text.

Example: More information on installation is available in theForms Builder Installation Guide.

Courier Courier type indicates commands within a paragraph, codein examples, syntax examples, system output, filenames andpathnames (if shown on separate line), or text that you enter.

Example:

public void destroy() throws AdaptorException;

Courier Italic Courier italic type indicates variables in command strings oruser input variables for which you supply particular values.

Example: All filenames have the format <template_name>.xfm

bold Boldface type indicates graphical user interface elementsassociated with an action, key names, or terms defined in textor the glossary.

Example: From the Filemenu, select Adaptors.

Support informationEMC Documentums technical support services and policies are available at the EMCPowerlink website (http://Powerlink.EMC.com). To download the Customer Guide toEMC Software Support Services from Powerlink, select Support > Request Support >Software Customer Guide and Offerings.

To order printed documentation or access support information in Powerlink, selectSupport > Request Support > Software Customer Guide and Offerings.

6 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 7: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Preface

Note: You must register online at Powerlink before using it.

Related documentationThe following guides pertain to forms or to closely related subjects:• Documentum Composer Quick Start Guide

This guide explains how to get started using Composer and explains the differencesbetween the UI‑based Composer and the non‑UI based (headless) Composer.

• Documentum Composer User Guide

This guide explains how to use Composer to develop, build, and install Documentumartifacts.

• Documentum Process Engine Installation Guide

This guide explains how to install Process Engine, which also installs the FormsBuilder DAR file.

• Documentum Content Server Administration Guide

This guide explains how to configure the connection broker information in ContentServer.

• Documentum Content Server Installation Guide

This guide explains how to install Content Server on a Windows host.• Documentum Content Server Release Notes

The release notes contain information on the supported operating system anddatabase combinations for Content Server.

• Documentum Foundation Classes Development Guide

A programmers guide to using DFC. This manual explains how to develop anddeploy service‑based business objects (SBOs) and modules.

• Documentum Foundation Classes Installation Guide

This guide explains how to install or uninstall DFC on the computer.• Documentum Forms Builder Development Guide

This guide explains how to create and deploy custom adaptors in forms.• Documentum Forms Builder User Guide

This guide explains how to build forms without additional programming.• Documentum Forms Builder Release Notes

The release notes describes the specific hardware and software versions that arerequired for the installation for Forms Builder

• Documentum Web Development Kit and Webtop Deployment Guide

This guide explains how to install a WDK application.

EMC Documentum Forms Builder Version 6.5 Installation Guide 7

Page 8: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Preface

You can go to the Documentation area of the EMC Powerlink website(http://Powerlink.EMC.com) to download product documentation, white papers,or participate in the technical publications customer survey. To locate productdocumentation, select Support > Documentation and White Papers Library, and thenselect your product.

Revision historyThe following changes have been made to this guide.

Revision Date Description

July 2008 Initial publication

8 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 9: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Chapter 1Preparing for Installation

This chapter describes the Documentum Forms Builder installations you can perform and issues toconsider before installing the software.

This chapter contains the following topics:• About Documentum Forms Builder, page 9• Supporting software requirements, page 10

About Documentum Forms BuilderDocumentum Forms Builder allows forms to be designed and used in a web client, withthe resulting form data saved in an EMC Documentum repository.

Forms Builder has three components:• Forms Builder, which is installed on a Windows platform.

Forms Builder allows form designers to create and edit forms by selecting andconfiguring UI controls and viewing the resulting form in a Preview pane.

• Forms Builder DAR file, which is installed automatically with Documentum ProcessEngine (but can also be installed using Documentum Composer).

This DAR file installs the proper object types and roles (permission types) on aContent Server to enable the creation and use of forms.

• Forms Runtime, which is installed with WDK applications.

Forms Runtime allows form templates to be displayed in a web client, and submittedform data is saved to a EMC Documentum repository. Forms Runtime includesChiba, an open source Java implementation of the W3C XForms standard, whichdelivers Xforms functionality to browsers.

This installation guide includes instructions for the first Forms Builder component. Thesecond component, Forms Builder DAR file, is installed with Documentum Process

EMC Documentum Forms Builder Version 6.5 Installation Guide 9

Page 10: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Preparing for Installation

Engine or by using Documentum Composer. The third component, Forms Runtime, isinstalled as part of a standard installation of a WDK application.

Supporting software requirementsForms Builder is a client application that runs on the user’s local Microsoft Windowscomputer and connects to Content Server using Documentum Foundation Classes(DFC). It is a Java application, and therefore, requires a Java Runtime Engine (JRE). Thespecific hardware and software versions that are required for the installation platform isdescribed in the Documentum Forms Builder Release Notes.

Forms Builder depends on additional supporting software, which must be installed inorder for the application to work properly. The supporting software includes ContentServer and its associated database, a WDK application installed on an application server,and a browser client for the WDK application.

Note: If you install Forms Builder on a computer with other EMCDocumentum productsinstalled on it, most of the required supporting software will be in place. TheDocumentumForms Builder Release Notes contains information about the supported software versions.

This section contains the following topics:• Content Server and Documentum repositories, page 10• Connection brokers and the dfc.properties file, page 11• Documentum Foundation Classes, page 11• WDK application, page 12• Documentum Composer, page 12• Java Runtime Engine, page 12• OpenOffice.org, page 12

Content Server and Documentum repositories

Before installing Documentum Forms, install at least one Content Server and configure atleast one EMC Documentum repository. Content Server provides content managementservices, including check in and check out, versioning, and archiving. All templates andform instances created with Forms Builder and WDK‑based client applications are savedin a EMC Documentum repository. Forms Builder and Content Server need not be (andtypically are not) on the same host machine.

More information on the supported operating system and database combinations forContent Server is available in the Documentum Content Server Release Notes. Completeinformation on installing Content Server is available in the Documentum Content

10 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 11: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Preparing for Installation

Server Installation Guide. If you are upgrading an existing Content Server and EMCDocumentum repository, review the sections on planning for an upgrade, preparing foran upgrade, and upgrading Content Server in the Documentum Content Server InstallationGuide.

Connection brokers and the dfc.properties file

Connection brokers provide EMC Documentum repository connection information toclient applications. EMC Documentum repositories project their connection informationto particular connection brokers, and client applications look to a specified connectionbroker for the available EMC Documentum repositories. Before you install FormsBuilder, obtain the names of the connection brokers to which the appropriate repositoriesproject and the port numbers on which the connection brokers listen.

The name of the connection broker is defined on the client computer in the dfc.propertiesfile, installed as part of DFC. All Documentum applications installed on a Windowsmachine share the same dfc.properties file. On a Windows machine, this file is locatedin the C:\Documentum\Config folder. If a dfc.properties file does not already existon the machine where you install Forms Builder, the installer asks for the name ofthe connection broker and the port number on which it listens and then creates thedfc.properties file. The default connection broker port is 1489.

To change the connection broker information after installation, edit the dfc.properties fileon the machine where Forms Builder is installed. More information on the dfc.propertiesfile and connection brokers is available in the Documentum Content Server AdministrationGuide.

Documentum Foundation Classes

Installing Forms Builder also installs Documentum Foundation Classes (DFC) on thecomputer. DFC is an object‑oriented application programming interface (API) andframework for accessing, customizing, and extending Documentum functionality,implemented as a set of Java interfaces and implementation classes, upon which theDocumentum clients are built. More information on DFC is available in the DocumentumFoundation Classes Development Guide and Documentum Foundation Classes InstallationGuide.

During the Forms Builder installation you are asked whether you want to installdeveloper documentation. This refers to the DFC JavaDocs. For normal use of forms,installing the developer documentation is not necessary.

EMC Documentum Forms Builder Version 6.5 Installation Guide 11

Page 12: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Preparing for Installation

If you have another Windows application installed on the Windows host, such asDocumentum Desktop or Documentum Application Builder, the version of DFC thatForms Builder installs is backwards compatible, and these applications are unaffected.

WDK application

Form data can be gathered using Web Development Kit (WDK), Webtop, or DigitalAsset Manager. These products are known as WDK applications since they are all builton WDK. The 6.0 (or later) version of any one of these WDK applications should beinstalled on an application server. The Forms Runtime component is installed along withthe WDK application. More information on installing a WDK application is availablein theWeb Development Kit and Webtop Deployment Guide.

Documentum Composer

Installing Forms Builder also requires installing a DAR file in each EMC Documentumrepository in which you will use the application. The Forms Builder DAR file is installedautomatically when you install Documentum Process Engine. If you are not installingProcess Engine, then you must install the DAR through Documentum Composer.Composer is a development tool for developing, building, and installing Documentumartifacts which are organized into projects. It replaces using Documentum ApplicationBuilder and Documentum Application Installer for managing and installing DocApps(which are now DARs). More information on installing Composer and using Composerto install DAR files is available in the Documentum Composer User Guide and DocumentumComposer Quick Start Guide.

Java Runtime Engine

Forms Builder is a Java‑based application and requires a Java Runtime Engine (JRE)on the computer. The installation program installs the required JRE along withthe application. By default, JRE is installed in the following location: C:\ProgramFiles\Documentum\java.

OpenOffice.org

Forms Builder version 6.5 introduces a new high fidelity form template, whichincorporates functionality from OpenOffice.org. OpenOffice.org is a cross‑platform

12 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 13: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Preparing for Installation

office application suite available for a number of different computer operating systems.It supports the ISO standard OpenDocument Format (ODF) for data interchange as itsdefault file format, as well as Microsoft Office ’97‑2003 formats, among many others.The OpenOffice.org Writer software is required to open high fidelity form instances ona user’s desktop or using Documentum Webtop. If the high fidelity form instance alsoincludes bar code controls, then the bar code OpenOffice extension is also requiredto view the form instance in Documentum Webtop. For information on installing thebar code OpenOffice extension, refer to Installing the bar code OpenOffice extensionpackage, page 18. For information on downloading and installing OpenOffice.org Writer,refer to http://www.openoffice.org.

EMC Documentum Forms Builder Version 6.5 Installation Guide 13

Page 14: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Preparing for Installation

14 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 15: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Chapter 2Installing Documentum Forms Builder

If your system meets the hardware and software requirements listed in Documentum Forms BuilderRelease Notes, and the supporting software described in Chapter 1 is installed, you are ready to installthe Forms Builder software.

Note: If you are upgrading the Forms Builder software to a new version, refer to Chapter 3,Upgrading Forms Builder.

This chapter contains the following topics:• Installing the Forms Builder software, page 15• Installing the Forms Builder DAR, page 17• Installing the bar code OpenOffice extension package, page 18

Installing the Forms Builder softwareInstall the Forms Builder software on the local machine for each user creating ormodifying templates.

The installation program also installs a JRE and DFC, which Forms Builder uses tocommunicate with Documentum Content Server. If the machine has no other EMCDocumentum software installed on it, the installation program asks you to choose ahome directory for EMC Documentum software and to identify a connection broker thatwill enable the machine to locate Content Server hosts.

To install Forms Builder:

1. Download the Forms Builder installer, Forms_Builder_<version>_windows.exe.You should have received instructions through email regarding how to downloadproducts from the EMC Documentum download site at http://Powerlink.EMC.com.

Note: The Powerlink website provides access to https://EMC.subscribenet.com/control/dctm/index where a complete listing of products is available for download.

EMC Documentum Forms Builder Version 6.5 Installation Guide 15

Page 16: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Installing Documentum Forms Builder

2. Run the downloaded executable file to expand the compressed archive to atemporary directory.

3. Navigate to the temporary directory and run the installation program. Theinstallation program is dfbWinSetup.exe.A welcome screen appears, listing the products that will be installed.

4. Read the welcome screen, and then click Next.The EMC Documentum software license agreement appears.

5. Read the license agreement.

6. To continue with the installation, click I accept the terms of the license agreementand click Next.The next screen gives you the option to install the developer documentation.

Note: If you do not accept the license agreement terms, the Next button is grayedout. You cannot continue with the installation.

7. To install the DFC developer documentation, select Developer Documentation.

8. Click Next.

9. If the machine has DFC installed on it, the installation program uses the existingvalues and does not display a screen asking for configuration information.If the machine has no other EMC Documentum software installed on it, enter basicconfiguration information for DFC. (This information is stored in the dfc.propertiesfile on the local machine where the Forms Builder software is installed.)

a. Accept the default DFC program root directory (C:\ProgramFiles\Documentum) or enter a different directory and click Next.

b. Accept the default user directory (C:\Documentum) or enter a differentdirectory and click Next.

10. If prompted, enter a connection broker hostname and port number or accept thedefault and click Next.

11. Confirm the final installation settings and click Next.The installation program starts copying files to the appropriate locations. When theinstallation is complete, a message screen appears indicating a successful installation.

12. Click Finish.The installation program displays a reminder that you must perform additionalinstallation steps to prepare a EMC Documentum repository for use with FormsBuilder. You can now install a DAR, as described in Installing the Forms BuilderDAR, page 17.

16 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 17: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Installing Documentum Forms Builder

Installing the Forms Builder DARTo work properly, Forms Builder requires certain files and objects in any EMCDocumentum repository to which it connects. You install these files and objects usinga Documentum DAR, which is an archived collection of Documentum Content Serverobjects. The files and objects required by Documentum Forms are located in the FormsBuilder DAR. You should install the DAR in the global repository, and once in each EMCDocumentum repository in which any user will run Forms Builder.

There are two methods for installing the Forms Builder DAR, as described in thefollowing sections:• Using Documentum Process Engine, page 17• Using Documentum Composer, page 17

Using Documentum Process Engine

In earlier releases of Documentum, the software that comprises the Process Engine wasinstalled as part of the Documentum Content Server installation. In addition, users hadto install the Business Process Manager (BPM) and Forms Builder DocApps separately,before installing the Process Builder.

In release 6.5, the Documentum Process Engine is installed separately on the serverwhere the Content Server is hosted. Before installing the Process Engine, ensure that theconnection broker and all repositories for which the Process Engine must be installedare up and running.

Process Engine 6.5 can be installed on Content Server 6.5 only. Therefore, Content Servermust be upgraded to 6.5 before Process Engine 6.5 is installed.

When you run the Process Engine installer on the Content Server machine, the installerperforms the following tasks:• Install the Process Engine on all repositories running on the Content Server• Install version 6.5 BPM and Forms Builder DARs on all repositories running on

the Content Server.Detailed instructions for installing Process Engine are provided in the DocumentumProcess Engine Installation Guide.

Using Documentum Composer

If you are not installing Process Engine, you must install the Forms Builder DAR usingthe Documentum Composer non‑UI command line version, also known as headless

EMC Documentum Forms Builder Version 6.5 Installation Guide 17

Page 18: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Installing Documentum Forms Builder

Composer. Headless Composer includes a set of Ant tasks (Apache Ant is a Java‑basedbuild tool) for each of the common Composer functions, such as import, build, andinstall. These Ant tasks let you integrate building Documentum projects and installingDAR files into standard Ant build scripts. Because these Ant tasks leverage Composerand Eclipse infrastructure, any build scripts including these tasks must be executedthrough the Eclipse AntRunner. For more information on Ant, see http://ant.apache.org.

The Forms Builder DAR can be installed from any machine with the latest version ofheadless Composer on the local machine. (Documentum Forms Builder Release Notescontains specific version requirements.) If the headless Composer is not installed on thelocal machine, download and install it before attempting to install the Forms BuilderDAR. Detailed instructions for installing and using headless Composer are availablein the Documentum Composer User Guide.

You must be a superuser or EMC Documentum administrator to install a DAR usingDocumentum headless Composer.

To install the Forms Builder DAR:

1. Download the Forms Builder DAR from the following location:http://Powerlink.EMC.com

Note: The Powerlink website provides access to https://EMC. subscribenet.com/control/dctm/index where a complete listing of products is available for download.

2. Install the Forms Builder DAR using headless Composer according to theinstructions provided in the Documentum Composer User Guide.

3. Repeat step 2 for each EMC Documentum repository in which you plan to use FormsBuilder.

Note: After you complete the installation of the Forms Builder DAR and the FormsBuilder software, you must specify the global repository details in the dfc.properties file,if not already set.

Installing the bar code OpenOffice extensionpackage

New in Forms Builder version 6.5 is the high fidelity form template, which usesOpenOffice to facilitate a variety of text and control options on the template, includingadding bar code controls. To view a high fidelity form instance that contains abar code using Documentum Webtop, you must install the bar code OpenOfficeextension package. For more information on OpenOffice and OpenOffice Writer, go tohttp://www.openoffice.org.

18 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 19: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Installing Documentum Forms Builder

Note: If the high fidelity form instance is edited or viewed using Documentum TaskSpacewith the high fidelity form viewer, this extension is not needed. This extension is also notneeded to view the form instance using OpenOffice Writer on a local machine.

To install the bar code OpenOffice extension

1. Download the bar code OpenOffice extension package for the appropriate version ofOpenOffice from the following location:http://Powerlink.EMC.com. For OpenOffice versions 2.0 to 2.1, the extension packagefilename is barcode2.0.uno.pkg. For OpenOffice versions 2.2 or later, the filenameis dm_barcode_2.2.oxt.

Note: The Powerlink website provides access to https://EMC. subscribenet.com/control/dctm/index where a complete listing of products is available for download.

2. Start OpenOffice Writer and from the Tools menu select Extension Manager. TheExtension Manager dialog displays.

3. Click Add, then browse to and select the bar code extension package. On theExtension Manager dialog, you should now see the extension package listed underMy Extensions.

EMC Documentum Forms Builder Version 6.5 Installation Guide 19

Page 20: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Installing Documentum Forms Builder

4. Click Close.

20 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 21: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Chapter 3Upgrading Forms Builder

You can choose to upgrade the Forms Builder software from an earlier release (5.3 or later) to thecurrent release (release 6.5). While it is not necessary to perform an upgrade process from release 6.0to 6.5, there are some specific instructions to consider.

This chapter contains the following topics:• Overview of the Forms Builder upgrade process, page 21• Upgrading Forms Builder 5.3 to release 6.5, page 22• Tasks to complete after upgrading Forms Builder, page 24• Upgrading from Forms Builder 6.0 to release 6.5, page 23

Overview of the Forms Builder upgradeprocess

The Forms Builder release 6.5 software contains a migration tool that you can use toupgrade a version of the software earlier than release 6. However, the migration tooldoes not migrate individual templates from the 5.3 object model to the release 6 objectmodel. This is done by the Forms Builder software. It is not necessary to perform anupgrade process from release 6.0 to 6.5.

The migration tool migrates all templates in the repository that have adaptors associatedwith it. It establishes a relationship between the template and the adaptor configuration.

The migration tool works in the following order:

1. In the 5.3 (or earlier) release, all template adaptors were grouped in theadaptor_config.xml configuration file in the /System/Forms folder in the repository.When migrating adaptor configuration information, the tool checks whether thesubject attribute of the adaptor configuration file is marked. If it is marked, then thetool does not migrate the adaptor configuration information. This means the contentof the configuration file has already been mapped to the corresponding release 6

EMC Documentum Forms Builder Version 6.5 Installation Guide 21

Page 22: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Upgrading Forms Builder

dmc_xfm_adaptor_config object attributes. If the subject attribute is not marked, thetool continues with the migration process, as described in step 2.

2. The migration tool maps all XML elements and attributes from the adaptorconfiguration file to the corresponding release 6 dmc_xfm_adaptor_config objectattributes.

Upgrading Forms Builder 5.3 to release 6.5This section guides you through the process of upgrading the Forms Builder 5.3 softwareto release 6.5.

Before upgrading the Forms Builder software, do the following:• Ensure your system meets the software and hardware requirements, as described in

Supporting software requirements, page 10 and in the Forms Builder Release Notes.• Uninstall the older version of the Forms Builder software, as described in Chapter 5,

Uninstalling Forms Builder. (If you uninstall all Documentum products from yourlocal machine, the dfc.properties file will be removed. During the installation of theForms Builder software, you must provide the DFC configuration information.)

To upgrade Forms Builder:

1. Install the Forms Builder software, as described in Installing the Forms Buildersoftware, page 15.

2. Install the Forms DAR, as described in Installing the Forms Builder DAR, page 17.

3. Run the migration tool.

a. Open a Command Prompt window.

b. Navigate to the location where the Forms Builder software is installed. Thesoftware is typically installed at C:\Program Files\Documentum\dfb.

c. To start the migration tool, run the following command:"C:\Program Files\Documentum\java\1.5.0_<version>\jre\bin\java.

exe" ­Dsun.java2d.noddraw=true ­cp lib\classpath.jar;..\dctm.

jar;"C:\Documentum\config"; com.documentum.xforms.utils.

MigrateTemplatesToD6 ­docbase <repositoryName> ­username

<userName> ­password <password> ­domain <domain>

Note: If you do not use a domain, then do not include the ­domain option inthe above command.

22 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 23: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Upgrading Forms Builder

Upgrading from Forms Builder 6.0 to release6.5

There is no upgrade process, but there is one suggested task and some informationyou should know when upgrading from Forms Builder 6.0 to 6.5, as described in thefollowing sections:• Deleting old icons, page 23• Migrating DocApps, page 23

Deleting old icons

Forms Builder 6.5 contains a new set of icons for list views, so to ensure that the old iconsare removed, the following procedure is recommended (but not required):

To delete old icons:

1. Uninstall Forms Builder 6.0 (for complete uninstall instructions, refer to Chapter5, Uninstalling Forms Builder.

2. Navigate to C:\Program Files\Documentum\dfb\engine\render\custom\imagesand verify that the path is either removed or empty.

Note: If you have custom icons, do not delete or empty the path. You can delete theold standard icons, but you should keep the custom icons.

3. Install Forms Builder 6.5 according to the instructions in Chapter 2, InstallingDocumentum Forms Builder.

Migrating DocApps

After upgrading from Forms Builder 6.0 to release 6.5, existing form templates aresupported in 6.5. However, if users wish to transfer forms to another repository and theyhave an existing DocApp, they will need to migrate the DocApp to a DAR file usingDocumentum Composer. Complete instructions for using Documentum Composer withexisting DocApps are provided in the Documentum Composer User Guide.

EMC Documentum Forms Builder Version 6.5 Installation Guide 23

Page 24: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Upgrading Forms Builder

Tasks to complete after upgrading FormsBuilder

After you have upgraded the Forms Builder software, you must update the globalrepository connection database information. To do this, edit the following lines in thedfc.properties file on the machine where the Forms Builder software resides.dfc.bof.registry.repository=<repositoryName>dfc.bof.registry.username=<userName>dfc.bof.registry.password=<password>......dfc.docbroker.host[0]=<IP_address_of_repository>dfc.docbroker.port[0]=<port_number>

More information on the dfc.properties file and connection brokers is available in theDocumentum Content Server Administration Guide.

24 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 25: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Chapter 4Postinstallation Tasks

This chapter describes any tasks that you may need to perform after installing Forms Builder andbefore it can be used.

This chapter contains the following topics:• Giving users access to Documentum Forms, page 25

Giving users access to Documentum FormsBefore using Documentum Forms, users must be assigned to one of two forms roles.• form_designer

The form_designer role is required for users who use Forms Builder to create,edit, validate, install, and obsolete templates. The form_designer role has WRITEpermission on all templates stored in /System/Forms.

The form_designer role includes all the privileges of the form_user role.• form_user

The form_user role is required for users who create forms from templates. Theform_user role has READ permission on all forms stored in /System/Forms.

You add users to the form_designer or form_user role using DocumentumAdministrator.

To add users to the form_designer role:

1. Start Documentum Administrator and log in as a user with administrator privileges.

2. Navigate toAdministration >UserManagement >Roles to access the Roles list page.

3. Double‑click the form_designer role.The list page with members of the role is displayed.

4. Click File > Add Member(s).The Choose a user/group page appears.

EMC Documentum Forms Builder Version 6.5 Installation Guide 25

Page 26: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Postinstallation Tasks

5. To jump to a particular user, group, or role, type the name in the text box andclick Go.

6. To filter the page, select one of the following from the list box at the top of the page:• Show Users, Groups, And Roles• Show Users• Show Groups• Show Roles• Show Private Groups and Roles

7. Select the names of the users, groups, or roles you want to add to the role.

8. Click the right arrow.The selected members are moved to the list box on the right of the page.

9. Click OK.Repeat the above procedure to add users to the form_user role, selecting form_user asthe role in step 3.

26 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 27: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Chapter 5Uninstalling Forms Builder

Forms Builder is installed as a standard Microsoft Windows application. To remove the applicationfrom a computer, use the Add/Remove Programs option from the Windows Control Panel.

Note: The following procedure removes the Forms Builder software from a local machine. It does notuninstall the supporting objects from any EMC Documentum repositories to which you applied theForms DocApp.

Removing the Forms Builder softwareThe following steps describe how to remove the Forms Builder software from the localmachine.

To uninstall the Forms Builder software:

1. Close the Forms Builder application, if it is running.

2. From the Start menu, select Settings > Control Panel.The Control Panel appears.

3. Double‑click Add/Remove Programs.

4. Select Documentum Forms Builder from the list of currently installed programs,and click Change/Remove.The uninstallation program starts. A screen appears showing a list of the softwareto be uninstalled.

5. Click Next to continue.A screen appears showing the file system location where the uninstallation programfound the Forms Builder software.

6. Click Next to remove the application.

7. When the process is complete, click Finish to close the uninstallation program.

EMC Documentum Forms Builder Version 6.5 Installation Guide 27

Page 28: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Uninstalling Forms Builder

8. Close the Control Panel.

28 EMC Documentum Forms Builder Version 6.5 Installation Guide

Page 29: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Index

Bbar code OpenOffice extension

installing, 18

CComposer, 12connection broker, 11Content Server, 10

DDAR, 12

installing, 17dfc.properties, 11, 24Documentum Forms

Forms Builder, 9Forms runtime, 9

Documentum Foundation Classes(DFC), 11

FForms Builder

installing, 15postinstallations tasks, 25preinstallation tasks, 9supported software, 10uninstalling, 27upgrading, 21

Iinstalling

Composer, 12connection broker, 11Content Server, 10DAR, 17DFC, 11Documentum repositories, 10Forms Builder, 15JRE, 12

OpenOffice.org, 12WDK application, 12

installing bar code OpenOfficeextension, 18

JJRE, 12

OOpenOffice extension for bar codes

installing, 18OpenOffice.org, 12

Ppostinstallation tasks, 25postupgradation tasks, 24preinstallation tasks, 9

Rroles

adding users, 25form_designer, 25form_user, 25

Ssupported software

Composer, 12connection broker, 11Content Server, 10DFC, 11JRE, 12OpenOffice.org, 12WDK application, 12

Uuninstalling, Forms Builder, 27

EMC Documentum Forms Builder Version 6.5 Installation Guide 29

Page 30: EMC Documentum FormsBuilder · EMC®Documentum® FormsBuilder Version6.5 InstallationGuide P/N300007259A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748‑9103 1‑508‑435‑1000

Index

upgradingForms Builder, 21 to 22Forms Builder 6.0 to 6.5, 23overview, 21

WWDK application, 12

30 EMC Documentum Forms Builder Version 6.5 Installation Guide