emc documentum processbuilder · emc®documentum® processbuilder version6 installationguide...

EMC® Documentum®

Process BuilderVersion 6

Installation GuideP/N 300–005–224

EMC CorporationCorporate Headquarters:

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

Copyright © 2004 - 2007 EMC Corporation. All rights reserved.

Published August 2007

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.

Table of Contents

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

Chapter 1 Preparing for Installation ....................................................................... 7Supporting software requirements............................................................... 7Content Server and Documentum repositories.......................................... 7Documentum Process Engine .................................................................. 8Documentum Foundation Classes (installed with Process Builder) ............ 8Connection brokers and the dfc.properties file.......................................... 8Java Runtime Engine (installed with Process Builder)................................ 9Documentum Application Installer .......................................................... 9

Chapter 2 Installing the Forms Builder and Process Builder DocApps ................. 11Installing the Forms Builder DocApp ........................................................... 11Installing the Process Builder DocApp ......................................................... 12

Chapter 3 Installing Process Builder ..................................................................... 15

Chapter 4 Post-Installation Tasks .......................................................................... 19Giving users access to Process Builder ......................................................... 19Giving users access to Forms Builder ........................................................... 20Configuring the Workflow Publish Events job .............................................. 20Configuring custom email templates............................................................ 20

Chapter 5 Uninstalling Process Builder ................................................................. 23

EMC Documentum Process Builder Version 6 Installation Guide 3

Table of Contents

4 EMC Documentum Process Builder Version 6 Installation Guide

Preface

Purpose of this guideThis book contains instructions for installing Documentum Process Builder, a softwareapplication for creating business process templates. Process templates formalize thesteps required to complete a business process, such as an approval process or aninsurance claims process, automate the flow of work between the steps, and enableusers to repeatedly perform the process. Process Builder extends the functionality ofDocumentum Workflow Manager. While you can use either tool to create processtemplates, Process Builder offers enhanced options. For information about using ProcessBuilder, see the Documentum Process Builder Development Guide.

Intended audienceThis book is intended for administrators who are installing Process Builder. Theinstallation process requires installing Documentum DocApps and copying files ontothe 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 Process Builder on their computers.

Revision historyThis section contains a description of this document’s revision history.

Revision Date Description

August 2007 Release 6.0

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 > About EMC CustomerService > Software Customer Guide.

To order printed documentation or access support information in Powerlink, selectSupport > About EMC Customer Service > Software Support Offerings.


http://powerlink.emc.com

Preface

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

Related documentationThis manual forms part of a documentation suite designed to support those who install,configure, and use Process Builder. In addition to this manual, the documentation set forProcess Builder includes:

• Process Builder Development Guide• Process Builder User Guide• Process Builder Release Notes• Process Builder Localization GuideYou can go to the Documentation area of the EMC Powerlink website(http://powerlink.EMC.com) to download product documentation. To locate productdocumentation, select Support > Documentation and White Papers Library, and thenselect your product.



Chapter 1Preparing for Installation

Process Builder is a client application that can be installed on any computer. Each user who needs tocreate or modify process templates can install the application on his or her local machine.

To work properly, Process Builder requires certain files and objects in any EMC Documentumrepository to which it connects. Therefore, in addition to installing the Process Builder application onusers’ machines, you must load a Documentum DocApp into each EMC Documentum repository andcopy files to each Content Server host machine.

Supporting software requirementsProcess Builder depends on additional supporting software, which must be installed inorder for the application to work properly.

Note: If you install Process Builder on a computer that has other EMC Documentumproducts installed on it, most of the required supporting software will be in place. Forinformation on the supported versions, see the Documentum Process Builder Release Notes.

Content Server and Documentum repositories

Before you install Process Builder, 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 processes andactivities created with Process Builder are saved in a EMC Documentum repository.Process Builder and Content Server need not be (and typically are not) on the samehost machine.

For complete information on installing Content Server, refer to the Documentum ContentServer Installation Guide.


Preparing for Installation

Documentum Process Engine

Documentum Process Engine consists of the system components involved in runningautomated business processes. While Content Server includes basic workflowfunctionality, the Process Engine enables the additional automation features necessary toimplement production-ready mission-critical business processes, such as work queueprocessing, XML data handling, activity timer/deadline management, and audit traildata aggregation for reporting.

The software that comprises the Process Engine is installed as part of Content Server. Thelicense key that activates the Process Engine is installed and configured automaticallyupon installation of the BPM DocApp.

Documentum Foundation Classes (installed withProcess Builder)

Installing Process Builder also installs Documentum Foundation Classes (DFC) on thecomputer. DFC is an object-oriented application programming interface (API) andframework for accessing, customizing, and extending EMC Documentum functionality,implemented as a set of Java interfaces and implementation classes. For moreinformation on DFC, refer to the Documentum Foundation Classes Development Guide andDocumentum Foundation Classes Installation Guide.

Connection brokers and the dfc.properties le

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 Documentum repositories. Before you install Process Builder,obtain the names of the connection brokers to which the appropriate repositories projectand the port numbers on which the connection brokers listen.

The name of the connection broker is recorded on the client computer in thedfc.properties file, installed as part of DFC. All Documentum applications installed ona Windows machine share the same dfc.properties file. On all supported Windowsoperating systems, this file is located in C:\Documentum\config. If a dfc.properties filedoes not already exist on the machine where you install Process Builder, the installerasks for the name of the connection broker and the port number on which it listens andthen creates the dfc.properties file. The default connection broker port is 1489.



If you need to change the connection broker information after installation, edit thedfc.properties file on the machine where Process Builder is installed. For moreinformation on the dfc.properties file and connection brokers, refer to the DocumentumContent Server Administration Guide.

Java Runtime Engine (installed with Process Builder)

Process Builder is a Java-based application and requires a Java Runtime Engine (JRE)on the computer. The installation program installs the required JRE along with theapplication.

Documentum Application Installer

Installing Process Builder also requires installing DocApps in each EMC Documentumrepository in which you will use the application. Documentum Application Installeris required for installing DocApps. Documentum Application Installer is part ofDocumentum Application Builder; if you install Documentum Application Builder,Documentum Application Installer is included, but you can also install it separately.

To install a DocApp with Documentum Application Installer, you must log in to the EMCDocumentum repository as a user with superuser or administration privileges.


Chapter 2Installing the Forms Builder andProcess Builder DocApps

Installing the Forms DocApp and BPM DocApp automatically enables and configures all of the jobsand properties necessary to use Process Builder, Forms Builder, and the work queue functionalityavailable in Webtop and TaskSpace.

Both DocApps can be located on EMC’s Powerlink website.

Installing the Forms Builder DocAppTo 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 DocApp, which is an archived collection of Content Server objects.The files and objects required by Documentum Forms are located in the Forms BuilderDocApp. Install the DocApp once in each EMC Documentum repository in which anyuser will run Forms Builder.

Install the DocApp from anymachine with the latest version of DocumentumApplicationInstaller on the local machine. (Documentum Forms Builder Release Notes contains specificversion requirements.) If Documentum Application Installer is not installed on the localmachine, download and install it before running the procedure below.

You must be a superuser or EMC Documentum administrator to install a DocApp usingDocumentum Application Installer (DAI).

To install the Forms Builder DocApp:1. Download the Forms Builder DocApp 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.



https://emc.subscribenet.com/control/dctm/index

Installing the Forms Builder and Process Builder DocApps

2. Unzip the downloaded file Forms_Builder_<version>_DocApp.zip.The files comprising the DocApp are extracted into a subdirectory named Forms.

3. From the Startmenu, select Programs > Documentum > Application Installer.The login screen for Documentum Application Installer appears.

4. Select the EMC Documentum repository into which you want to install the DocAppand log in as a superuser or administrator.Documentum Application Installer starts.

5. Click Browse from the DocApp folder selection section and navigate to the Formsdirectory containing the DocApp files (from step 2 above).

6. In the Installer Log section, type a log filename in the File name box; this step isoptional. The default log filename is AppInstallerLog.html.Click Browse to select a directory other than the default to save the log file. You canrefer to the log file for any errors that occur during the installation of DocApp.

7. Click OK.A dialog box appears, detailing the DocApp name, target repository, and theinstallation status.

8. Click Start Installation.The installation process takes a few minutes to complete. This is indicated in thedialog box that appears.

9. Click OK.If users are currently connected to the EMC Documentum repository into which youare installing the DocApp, a dialog box asks whether you want to continue with theinstallation. Click Yes. Users are not affected by the installation, but they will not seethe changes made by the DocApp until they reconnect.

10. Repeat steps 3 through 9 for each EMC Documentum repository in which you planto use Forms Builder.

11. Click Quit Installer.

Installing the Process Builder DocAppTo work properly, Process Builder requires certain files and objects in any EMCDocumentum repository to which it connects. You install these files and objects using aDocumentum DocApp, which is an archived collection of Content Server objects. Youmust install the Process Builder DocApp before using Process Builder.

Install the DocApp once in each EMC Documentum repository in which any user willrun Process Builder.



You can install the DocApp from any machine that has the latest version of DocumentumApplication Installer on the local machine. (Refer to the Process Builder Release Notes forspecific version requirements.) If Documentum Application Installer is not installed onthe local machine, download and install it before running the procedure below.

Note: For DB2 repositories, you must use the DB2 Control Center to create auser temporary tablespace before installing the BPM DocApp. See the DB2 userdocumentation for instructions on using the DB2 Control Center.

You must be a superuser or EMC Documentum administrator to install a DocApp usingDocumentum Application Installer.

The BPM DocApp installs the following jobs:

• dm_QmPriorityAging— Increments priority of work queue tasks• dm_QmPriorityNotification—Checks the highest priority of work queue tasks against

the maximum priority• dm_WFReporting — Processes workflow audit trails and generates

dmc_completed_workflow and dmc_completed_workitem objects• dm_QmThresholdNotification— Checks the number of work queue tasks against the

threshold• dm_WFSuspendTimer— Resumes activities after the suspension interval expires• dm_WFCheckPoint—Monitors dm_WFPublishEvents job as a heartbeat job• dm_WFPublishEvents— Exports BPM process data to the BAM database

Note: All jobs in this list are installed and configured by the DocApp, with the exceptionof the dm_WFPublishEvents job, which must be configured manually. Configuring theWorkflow Publish Events job, page 20 provides instructions on configuring this job toenable BAM reporting.

To install the Process Builder DocApp:1. Download the Documentum Process Builder DocApp, Version 6.0 (zip) from the

Process Engine product download area on the customer download site:http://powerlink.emc.com

Note: The Powerlink site (http://powerlink.emc.com) provides access to https://emc.subscribenet.com/control/dctm/index where a complete listing of products isavailable for download.

2. Unzip the downloaded file BPM_DocApp_<version>.zip.The files comprising the DocApp are extracted into a subdirectory named BPM.

3. From the Microsoft Windows Start menu, select Programs > Documentum >Application Installer.The login screen for Documentum Application Installer appears.






Note: Documentum Application Installer is not installed as part of Process Builder.You must download and install it separately.

4. Select the EMC Documentum repository into which to install the DocApp and log inas a superuser or administrator.Documentum Application Installer starts.

5. Click Browse from the DocApp folder selection section and navigate to theBPM-Forms directory containing the DocApp files (from step 2 above).

6. In the Installer Log section, type a log file name in the File name box. The defaultlog file name is AppInstallerLog.html.Click Browse to select a directory other than the default to save the log file. You canrefer to the log file for any errors that occur during the installation of DocApp.

7. Click OK.A dialog box appears, detailing the DocApp name, Target Repository, and theinstallation status.

8. Click Start Installation.A dialog box appears stating “This will take a few minutes to complete.”

9. Click OK.If users are currently connected to the EMC Documentum repository into which youare installing the DocApp, a dialog box asks whether you want to continue with theinstallation. Click Yes. Users are not affected by the installation, but they will not seethe changes made by the DocApp until they reconnect.

10. Click Quit Installer.

11. Repeat steps 2 through 9 for each EMC Documentum repository in which you planto use Process Builder.


Chapter 3Installing Process Builder

If your system meets the requirements listed in Documentum Process Builder Release Notes, and youhave installed the supporting software described in Chapters 1 and 2, you are ready to install ProcessBuilder.

You install the Process Builder application on the local machine of each user who will be creating ormodifying process templates.

The installation program also installs a Java Runtime Engine (JRE), Documentum Forms Builder, andDocumentum Foundation Classes (DFC), which Process Builder uses to communicate with ContentServer. If the machine has no other EMC Documentum software installed on it, the installationprogram asks you to chose a “home” directory for EMC Documentum software and to identify aconnection broker that will enable the machine to locate Content Server hosts.

To install Process Builder:1. Download the Process Builder software.

You should have received instructions through email regarding how to downloadproducts from EMC Documentum’s download site. The URL below takes you tothe download site.Download Site: http://powerlink.emc.com

Note: The Powerlink site (http://powerlink.emc.com) provides access to https://emc.subscribenet.com/control/dctm/index where a complete listing of products isavailable for download.

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

3. Run the installation program from the directory you expanded the files into.For a Microsoft Windows host machine, the installation program isbpmWinSetup.exe. A welcome screen appears, listing the software that willbe installed. Process Builder installs Documentum Foundation Classes (DFC),Documentum Forms Builder, and Documentum Forms Services as supportingsoftware.

4. Read the welcome screen, then click Next.





Installing Process Builder

The EMC Documentum software license agreement appears.

5. Read the license agreement.

6. To continue with installation, click I accept the terms of the license agreementand click Next.If you do not accept the license agreement terms, the Next button is grayed out. Youcannot continue with the installation.The next screen gives you the option to install the developer documentation and aprimary interop assembly for Documentum Foundation Classes (DFC).

7. To install the DFC developer documentation, click the Developer Documentationcheck box.

8. To request installation of a Microsoft installer package (.msi file) for the DFC primaryinterop assembly, click the Primary Interop Assembly Installer check box.If you select this option, the Process Builder installation program places theinstallation package for the DFC primary interop assembly into the setup directoryof the DFC program root directory.

9. Click Next.

10. Select the language pack to install for this release and click Next.

11. If the machine doesn’t already have the global registry configured, designate theglobal registry for this installation.

a. Enter the name of the repository.

b. Enter the login name and password for the repository.

c. You can also select the checkbox to test the connection.

12. If the machine has no other EMC Documentum software installed on it, enter basicconfiguration information for DFC.If the machine already has DFC installed on it, the installation program uses theexisting values and does not display a screen asking for configuration information.

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.

13. If you are prompted, enter a connection broker host name and port number or acceptthe default and click Next.

14. Click Next.The installation program starts copying files to the appropriate locations. It alsocreates a shortcut on the Windows Start menu for starting Process Builder. When theinstallation is complete, a message screen appears indicating success.



15. Click Next, then click Finish.The installation program displays a reminder that you must perform additionalinstallation steps to prepare a EMC Documentum repository for use with ProcessBuilder. See the next two sections for details about these steps.

Note: After installing Process Builder, you must install Process Integrator messaging services on theContent Server. This ensures Process Integrator sends out SMTP notifications correctly. Refer to theDocumentum Process Integrator Installation Guide for more information about installing messagingservices.


Chapter 4Post-Installation Tasks

This chapter describes configuration tasks that you may need to perform after installing ProcessBuilder. The tasks are:

• Giving users access to Process Builder, page 19• Giving users access to Forms Builder, page 20• Configuring the Workflow Publish Events job, page 20• Configuring custom email templates, page 20You need to perform these tasks for each EMC Documentum repository in which you plan to useProcess Builder.

Giving users access to Process BuilderWhen a user starts Process Builder, the first step is to log in to a EMC Documentumrepository. To use Process Builder, the user must be a member of the role bpmuserin that repository.

You add users to the bpmuser role using Documentum Administrator.

To add users to the bpmuser 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. Click the name of the bpmuser role.The list page with members of the role is displayed.

4. To filter the list, select Only Groups, Only Users, or Only Roles from the list.

5. Click File > Add Member(s) to access the Choose a user/group page.

6. Select the names of the users to add to the role.

7. Click the right arrow.


Post-Installation Tasks

The members are moved to the right-hand side of the page.

8. Click OK.

Giving users access to Forms BuilderTo give users access to Forms Builder, see theDocumentum Forms Builder Installation Guide.

Conguring the Workow Publish Events jobTo publish data to the BAM reporting database, you must configure thedm_WFPublishEvents job with the connection parameters for the target database. Thisjob publishes data from the Process Builder audit trail to the BAM database where it canbe used to create BAM reports.

To modify a job:1. Connect to the repository and navigate toAdministration > JobManagement > Jobs.

The system displays the Jobs list page.

2. Select the job to modify and then select View > Properties > Info.The system displays the Job Properties - Info page.

3. Modify fields on the Job Properties - Info page.

4. Click the tabs to access other pages where you want to change information.

5. Click OK or Cancel to return to the Jobs list page.

Conguring custom email templatesProcess Builder enables you to create custom email notification methods. To use thisfeature, Content Server must invoke the dm_event_template_sender method to sendevent notifications using templates. The method is a Java method and is executed byan application server. The application server must reside on the same host as ContentServer. You can use the WebLogic server installed with Content Server or an applicationserver that you have installed.

Note: When Content Server is configured to use the dm_event_template_sender method,it uses this method rather than the default dm_event_sender method for all email.However, dm_event_template_sender ends up invoking dm_event_sender for all events



that do not have associated email templates. Therefore, any customization you havemade to the dm_event_sender method still apply.

To enable the use of custom email templates:1. Start the Java Method Server on the Content Server host machine.

• On a Windows host machine, start the Documentum Java Method Serverservice. The service is set to start automatically by default.

• On a UNIX host machine, run the shell script startMethodServer.sh script locatedin the $DOCUMENTUM/bea9.2/domains/DctmDomain directory. The JavaMethod Server is not started by default.

2. Configure Content Server to invoke the dm_event_template_sender method foremail messages.Set the mail_method attribute in the server config object (dm_server_config) byfollowing the steps below. By default, the attribute is set to dm_event_sender.To use the email templates for workflow events, you reset the attribute todm_event_template_sender.

a. Connect to the EMC Documentum repository and start an API session.

b. Use the Fetch or Checkout method to obtain the server config object from theEMC Documentum repository.fetch,c,server_config_object_idcheckout,c,server_config_object_id

If you do not know the object ID of the server config object, you can use theRetrieve method to obtain it:retrieve,c,dm_server_config where object_name =’server_config_name’

server_config_name is typically the name of the EMC Documentum repository.

c. Use the Set method to update the value of the mail_method attribute.You can use the keyword serverconfig to represent the server config object inthe Set syntax:API>set,c,server_config_object_id,mail_methodSET>dm_event_template_sender

d. To turn on tracing for the dm_event_template_sender method, set trace_level inthe method_args attribute. The only supported trace levels are:• 0, no tracing• 1, informational messages• 2, debug messagesBy default, the tracing information is recorded in the followinglocation. For Windows, look in %DM_HOME%\bea9.2\domains\DctmDomain\servers\DctmServer_MethodServer_



<hostname>\logs\DctmServer_MethodServer_<hostname>.log. For UNIX, check $DOCUMENTUM_SHARED\bea9.2\domains\DctmDomain\servers\DctmServer_MethodServer_<hostname>\logs\DctmServer_MethodServer_<hostname>.logTo change the default, set trace_file in the method_args attribute to the locationof your choice.

e. On UNIX hosts, set the SMTP server to use for sending email.When the dm_event_template_sender method is invoked on a UNIX host, ituses the SMTP server installed as part of the operating system by default. Touse a different SMTP server, set the smtp_server attribute in the server configobject to the name of the desired server.On Windows hosts, the smtp_server attribute is set by the user duringDocumentum repository configuration.

f. Use the Save or Checkin method to save your changes.save,c,server_config_object_idcheckin,c,server_config_object_id

You cannot use the serverconfig keyword in these methods.


Chapter 5Uninstalling Process Builder

Process Builder is installed as a standard Microsoft Windows application. If you need to remove theapplication from a computer, use the Add/Remove Programs option from theWindows Control Panel.

Note: The procedure below removes the Process Builder application from a local machine. It does notuninstall the supporting objects from any EMC Documentum repositories to which you applied theProcess Builder and Forms Builder DocApps or the Java files copied onto Content Server machines.

To uninstall Process Builder:1. Close Process Builder if it is running.

2. From the Microsoft Windows Startmenu, select Settings > Control Panel.The Control Panel appears.

3. Double-click Add/Remove Programs.

4. Select Documentum Process Builder from the list of currently installed programs,and click the Change/Remove button.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 Process Builder software.

6. Click Next > to remove the application.

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

8. Close the Control Panel.

Note: You must not uninstall Documentum Foundation Classes (DFC) afterremoving the Process Builder application.


emc documentum processbuilder · emc®documentum® processbuilder version6 installationguide...

Documents