EMC
®
Documentum
®
Case Management Solution
Framework
Version 6.5 SP1
Installation Guide
P/N 300-009-150 A01
EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.EMC.comCopyright©1994 - 2009 EMC Corporation. All rights reserved. Published April 2009
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS 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.
Table of Contents
Preface
...
5Chapter 1 Understanding Case Management Solution Framework
...
7Case Management Solution Framework components
...
7Environment and system requirements
...
9Installed product versions
...
9Hardware requirements
...
10Software requirements
...
10Chapter 2 Installing Case Management Solution Framework
...
11Database and repository
...
11Step 1: Prepare the host machine(s)
...
11Ports
...
12Documentum directories
...
12Passwords
...
12Step 2: Install Case Management Solution Framework
...
13Reviewing the installation logs
...
14Deploying web applications after the installation
...
14Reinstalling Case Management Solution Framework
...
15Step 3: Configuring the Grants Management sample application
...
15Creating a base FTP folder
...
15Creating email accounts
...
15Creating email inboxes
...
16Editing email process parameters
...
16Changing email listener poller frequency
...
17Getting the WSDL for the web application (optional)
...
17Step 4: Start Case Management Solution Framework
...
17Table of Contents
List of Tables
Table 1. Software products comprising Case Management Solution Framework
...
9Table 2. Hardware requirements
...
10Table 3. Operating system requirements
...
10Preface
This guide provides an overview of Case Management Solution Framework and describes how to install and configure Case Management Solution Framework. This guide also contains information about uninstalling Case Management Solution Framework.
Intended audience
The guide is intended for product demonstration and proof-of-concept purposes.
Revision history
The following revisions have been made to this document:
Revision History
Date Description
Chapter 1
Understanding Case Management
Solution Framework
Case Management Solution Framework is a part of the Case Management Solution Framework family of products and provides a solution for case management application evaluation and development workstations. Case Management Solution Framework is an integrated platform that combines Content Server, a relational database management system, a full-text indexing system, and complete case management applications in a single package. It includes the core technology, content-related services, and the developer resources for building content-rich applications. Installing Case Management Solution Framework automatically deploys all components and configures a content repository.
Case management Solution Framework also installs a sample application. The sample application is a demo application that shows how the current Case Management Solution Framework products can be used to build a case management application. For details about the sample application refer to the EMC Documentum Case Management Solution Framework Grants Management Sample Application Guide. This chapter describes the product. It includes these major topics:
• Case Management Solution Framework components, page 7
• Environment and system requirements, page 9
Case Management Solution Framework
components
A basic installation of Case Management Solution Framework consists of a complete stack of EMC Documentum products, including the basic Documentum content management platform and the interrelated components for case management. All products are installed by the Case Management Solution Framework installation program.
The Documentum platform products and components included with Case Management Solution Framework are:
• A content repository that stores the content
• Content Server, which manages the content repository and provides content management capabilities
Understanding Case Management Solution Framework
• A JBoss application server, which Content Server uses for running administration jobs and for hosting Documentum Administrator and other web applications, including custom-built applications
• Documentum Administrator, a web-based tool for configuring Content Server and the content repository
• Documentum Composer, a design tool for creating application elements and deploying them into content repositories
• Documentum Foundation Classes (DFC), the application programming interface for communicating with Content Server
• Documentum Foundation Services (DFS), a web-service interface that developers can use to access Documentum functionality
• Retention Policy Services Administrator, a web-based tool for defining retention policies • Document Image Services, which provide support for high-performance document and image
viewing and annotations.
• Web Development Kit (WDK), the development environment for customizing web-based Documentum applications
The Case Management Solution Framework installation program also activates the following extended feature licenses:
• Trusted Content Services provides additional security features, such as encrypted file stores, in which content files are encrypted and secure socket layer (SSL) communications between Content Server and DMCL.
• Content Services for EMC Centera and Network Appliance SnapLock add support for retention type stores, which provide content storage with guaranteed retention and immutability.
• High-Volume Server is an extension of Content Server that supports features implemented to solve common problems with large content stores. The three broad areas of enhancements that make up High-Volume Server are:
— Lightweight system objects
— Batch operations and currency scoping — Database partitioning
Note: SQL Server Express does not support database partitioning.
• Content Storage Services enables you to define business rules to govern where content files are stored.
• Retention Policy Services is a compliance-oriented feature that gives you control over how long and under what circumstances documents and other objects are retained in a repository.
The Content Server Fundamentals Guide provides further details about these products and the features they enable.
Understanding Case Management Solution Framework
The Case Management Solution Framework installation program also installs these case management products:
• Process Engine, which consists of the system components involved in running automated business processes.
• Process Builder, which is a graphical design tool for formalizing and automating business processes.
• Forms Builder, which is an interactive tool for creating and modifying forms and TaskSpace layouts.
• Process Integrator, which provides outbound and inbound messaging capabilities enabling Documentum applications to exchange documents and information with people outside the organization.
• TaskSpace, which provides a configurable user interface for task processing and document retrieval
• Business Activity Monitoring (BAM), which provides the ability to show business process status and generate performance statistics.
Environment and system requirements
This section lists the hardware requirements and software versions supported with this release.
Hardware requirements, page 10, addresses basic machine resource requirements. Software requirements, page 10, addresses specific software versions that are required for the installation platform.
Installed product versions
Table 1, page 9, lists the product versions that comprise this release.
Table 1. Software products comprising Case Management Solution Framework
Product Version
EMC Documentum products 6.5 SP1 Microsoft SQL Server 2005
Express Edition SP2
9.0.0.3042
Java 1.5.0_12
Note: The Microsoft SQL Server 2005 Express database is provided as a courtesy only. Customers
should contact Microsoft for assistance. EMC is not responsible for supporting it.
The bundled database has all of the features and limitations of Microsoft SQL Server 2005 Express, including a maximum database size of 4 GB. Contact Microsoft for more information.
Understanding Case Management Solution Framework
Hardware requirements
Table 2, page 10, lists nominal machine resources required for product installation and use.
Table 2. Hardware requirements
Hard disk space RAM CPU Display
20 GB 4 GB Refer to the
information inTable 3, page 10
A video card capable of displaying a minimum of 256 colors (SVGA), or 800 x 600
Software requirements
Table 3, page 10, describes the operating system requirements for the product.
To install Case Management Solution Framework using the bundled SQL Server database, the host machine must also have the Microsoft .NET Framework, version 2.0 or higher, installed on it.
Table 3. Operating system requirements
Operating System Processor
Windows Server 2003 R2 with SP2 (32-bit version)
Intel (x86) Windows Server 2003 SP2 (32-bit version) Intel (x86)
Windows XP Sp3 (32–bit version) Intel (x86)
Caution: Case Management Solution Framework supports installing onto NTFS file systems
only. If you choose to install onto a non-NTFS file system, the installation will fail. NTFS is the standard file system type for Windows 2003 and XP.
Chapter 2
Installing Case Management Solution
Framework
This chapter describes how to install Case Management Solution Framework. It consists of these major sections:
• Database and repository, page 11
• Step 1: Prepare the host machine(s), page 11
• Step 2: Install Case Management Solution Framework , page 13
• Step 3: Configuring the Grants Management sample application, page 15
• Step 4: Start Case Management Solution Framework , page 17
Database and repository
Content Server uses a relational database to store metadata about the content in the repository. By default, Case Management Solution Framework creates the database as part of the installation process. Case Management Solution Framework uses a database server instance name of DOCUMENTUMDB and a repository name of "documentum.”
Step 1: Prepare the host machine(s)
Before you begin installing Case Management Solution Framework, ensure that the host machine meets the hardware and software requirements detailed inEnvironment and system requirements, page 9. The host on which you install Case Management Solution Framework must not have any existing EMC Documentum products installed on it. The host name must use only ASCII characters. The host machine must meet the following system requirements:
• No Microsoft SQL Server or SQL Server Express installed • No other Documentum software installed
• Microsoft .NET 2.0 or higher
Installing Case Management Solution Framework
• RAM: A minimum of 4 GB • Free disk space: 5 GB • Processor: Intel x86 • Operating system:
— Microsoft Windows XP SP3 — Windows Server 2003 R2 with SP2 — Windows Server 2003 SP2
You must be logged in as a member of the Microsoft Windows Administrators group, but not necessarily as Administrator.
Ports
The database server, application server, and connection broker installed with Case Management Solution Framework use ports on the host machine.
Case Management Solution Framework installs a database server and uses port 1433 for TCP/IP connections.
The port for the embedded application server is 9080. The application server requires a block of 20 consecutive open ports starting at this number.
The connection broker port is 1489. The connection broker also uses the next port number, so ensure that the next port number (1490) is also open.
Documentum directories
The Case Management Solution Framework installation program installs files into two directories, referred to as the program directory and the user directory.
• The program directory is the directory where Documentum products are installed. The typical location is C:\Program Files\Documentum.
• The user directory is the directory where Documentum data is stored. The typical location is C:\Documentum. The user directory must not have any spaces in the path.
You must identify these two directories when you run the Case Management Solution Framework installation program. The installation program will create the directories if they do not already exist.
Installing Case Management Solution Framework
Step 2: Install Case Management Solution
Framework
You install Case Management Solution Framework by running the documentumSetup.exe installation program. The installation program creates the repository and installs all Documentum components.
Note: For optimal performance during installation, turn off any virus checking on the host machine.
To install Case Management Solution Framework:
1. Log in to the host system using your Microsoft Windows login.
Note: Windows user accounts are not case-sensitive, but Case Management Solution Framework
installation fails if you connect to the host by using the incorrect case in the username. For example, if the account is set up as JPSmith and you connect as jpsmith, you can log in to the host, but installation fails.
2. Download the Case Management Solution Framework software.
You can find the location of the software and instructions for downloading it in the email you received regarding the EMC download site.
3. Unzip the distribution file.
Uncompress the distribution file in any directory whose name does not contain spaces in the path. The installation files are uncompressed to that directory and to two subdirectories: dbserver and installConfig.
4. Run the installation program from the directory into which you expanded the files by double-clicking documentumSetup.exe.
The installation program starts and a dialog box appears that lists all system requirements. 5. Ensure that your system meets all requirements listed and click Next. The software license
agreement appears.
6. Read the license agreement.
To continue with installation, click I accept the terms of the license agreement and click Next. If you do not accept the license agreement terms, the Next button becomes unavailable, and you cannot continue with the installation.
7. You can accept the default directory for Content Server and data (C:\Documentum) or click Browse to select a different installation directory. The name of the directory in which Content Server is installed must contain only ASCII characters and must not include spaces. Do not use any of these characters in pathnames: ! \ / : * ? " < > | .
You can accept the default directory for shared Documentum programs (C:\Program Files\Documentum) or click Browse to select a different directory.
Click Next.
8. Type your Windows password and click Next.
A dialog that lists the packages to be installed appears. 9. Click Next.
A dialog appears that indicates the successful installation of Case Management Solution Framework.
Installing Case Management Solution Framework
10. Click Finish.
This will launch the Case Management Solution Framework welcome page that provides information on how to launch its component applications. You can access the welcome page any time after the installation by navigating to Start>Programs>Documentum>Welcome.
Reviewing the installation logs
The installation program creates the following log files in the installer directory. You might want to review the following logs to verify that installation was successful:
• setupError.log (Installation errors). If the installation was successful, this log will not be created. • install.log (Main installation log)
• install_owner.ServerInstaller.log (Content Server installation log)
Deploying web applications after the installation
After the Case Management Solution Framework installation is completed, the Jboss method server automatically deploys all the web applications. Sometimes, the process of deploying the web applications can take several minutes. Check the server.log in
C:\Documentum\jboss4.2.0\server\DctmServer_MethodServer\log directory. If the size of the log file is around 7 KB and does not grow, the web applications could not be properly deployed. To resolve this you need to shut down the Java method server (JMS) and delete the contents of the tmp and work directories.
To start, stop, and restart the JMS:
1. From Windows navigate to Start>Administrator Tools>Services. In the Services dialog, the JMS is called "Documentum Java Method Server".
2. You can start, stop, and restart the JMS by right-clicking on "Documentum Java Method Server" in the Services dialog and selecting the appropriate menu item from the context menu.
3. Verify that the Java process has stopped by doing the following: a. Click Ctrl-Alt-Del to open the Windows Task Manager. b. Click the Processes tab and sort by Process Name.
c. Look for processes named "Java.exe". The Java method server will be a Java.exe process that is using at least 500,000K of memory.
d. If the Java.exe process has not stopped, manually stop it by selecting it in the Windows Task Manager and clicking End Process.
Installing Case Management Solution Framework
2. Open Windows Explorer and navigate to C:\Documentum\jboss4.2.0\server\DctmServer_ MethodServer.
3. Delete the contents of the tmp and work folders.
Reinstalling Case Management Solution Framework
If a problem occurs during installation, you can reinstall Case Management Solution Framework.
To reinstall Case Management Solution Framework:
1. Diagnose and fix the problem that caused the failure.
2. Uninstall the software by navigating from the Windows Start menu to
Programs>Documentum>Uninstall and clicking on Uninstall.
3. Restart your system.
4. Reinstall the software by following the installation steps.
Step 3: Configuring the Grants Management
sample application
The following sections describe additional configurations you need to make before using the Grants Management sample application.
Creating a base FTP folder
To use FTP to submit the grant request application, you must create the base FTP folder on the inbound application server machine. This folder should be:
C:/applicantfolder/application
This location is already configured in the Receive Application via FTP activity template in the Create Grant Request process template. If you need to change it to another path, you must also update the path in the Receive Application via FTP activity template.
Creating email accounts
To create and configure the email accounts for the Grants Management sample application, you must follow these steps:
• Create email inboxes
• Edit email process parameters
Installing Case Management Solution Framework
Creating email inboxes
Configure three inboxes in your email server for the following users: • newapps, which receives the incoming applications
• updateapp, which receives the required documents from the applicant
• grantnotification, which sends automatic notification email messages to the applicant
For both newapps and updateapp accounts, create the passwords to be identical to the user inbox name. So the username and password combination for the incoming applications must benewapps/newapps and for the incoming required documents it must be updateapp/updateapp. The grantnotification account does not require an identical password.
The Process Builder process templates are preconfigured to use the localhost for these addresses. If you are not using a local email server, you must change the host name of the email server in all Email activity templates. If your email host is not located on machine where the Documentum Content Server is running, you must change the Host Name in the following activities from localhost to the host name of the email server.
Table 4. Change from localhost to host name of email server
Process template Activity Tab
Create Grant Request Receive Application via Email Email Inbound Request Documents Wait for Additional Documents Email Inbound Send Notification Send Email To Applicant SMTP Activity Send Advanced
Notification
Send Received Grant Request Email
SMTP Activity
Send Advanced Notification
Send Rejected for more Info Message
SMTP Activity Send Advanced
Notification
Send Request Denied Message SMTP Activity
Send Advanced Notification
Send Request Approved Message SMTP Activity
Editing email process parameters
The Manage Grant Request and Validate and Classify Grant Request process templates include a process parameter that must point to the grantnotification sending email address that you have set up for automatic notifications. Use TaskSpace to edit the SystemEmailAddress for both process templates.
Installing Case Management Solution Framework
3. Select the Manage Grant Request process template and click Manage Process Parameters. The Process Parameters page appears.
4. Edit the Value for the SystemEmailAddress process parameter to point to the email address you set up for grantnotification and click OK.
The system displays the original value and the modified value in a confirmation page. 5. Click OK.
6. Repeat these steps for the Validate and Classify Grant Request process template.
Changing email listener poller frequency
The listener poller frequency in the Receive Application via Email activity is set to 10,000 seconds by default. Edit the polling interval to a lower value, for example, 300 seconds.
To edit the listener poller frequency:
1. Open Documentum Process Builder.
2. Select File > Open > Grants Management > Processes.
3. Navigate to and open the Create Grant Request process template. 4. Uninstall the process.
5. Open the Receive Application via Email activity and select the Email Inbound tab. 6. Change the value in the Listener Poller Frequency (in secs) to a lower value such as 300. 7. Save the activity.
8. Save, validate and install the process template.
Getting the WSDL for the web application (optional)
To use the web service inbound submittal option, you must supply the SOAP request to start the application process.
To get the WSDL for the process, you must use http://<BPSInbound Host>:<port>/bps/webservice/ Create Grant Request?WSDL or http://localhost:9080/bps/webservice/<process ID>?WSDL to retrieve the WSDL associated with the create grant request process.
Step 4: Start Case Management Solution
Framework
When Case Management Solution Framework is installed, a Documentum shortcut is automatically created in the Microsoft Windows Start menu from which you can start the Case Management Solution Framework administration tools, applications, and development tools. From this shortcut
Installing Case Management Solution Framework
you can also open the Case Management Solution Framework welcome page or uninstall Case Management Solution Framework.
To log in to TaskSpace:
1. From the Microsoft Windows Start menu, navigate to
Programs>Documentum>Application>TaskSpace.
2. Type your Windows username name and password. 3. Click Login.
To start Process Builder:
1. From the Microsoft Windows Start menu, navigate to
Programs >Documentum>Development Tools>Process Builder.
To start Forms Builder:
1. From the Microsoft Windows Start menu, navigate to
Programs >Documentum>Development Tools>Forms Builder.
To start Process Reporting Services:
1. From the Microsoft Windows Start menu, navigate to
Programs >Documentum>Development Tools>Process Reporting Services.
To start Documentum Composer:
1. From the Microsoft Windows Start menu, navigate to
Programs >Documentum>Development Tools>Composer.
To log in to Documentum Administrator:
1. From the Microsoft Windows Start menu, navigate to
Programs>Documentum>Administration>Documentum Administrator.
2. Type your Microsoft Windows login name and password. 3. Click Login.
To log in to Retention Policy Services Administrator:
1. From the Microsoft Windows Start menu, navigate to
Programs>Documentum>Administration>Retention Policy Services Admin.
2. Type your Microsoft Windows username name and password. 3. Click Login.
Chapter 3
Uninstalling Case Management
Solution Framework
Case Management Solution Framework is provided with a program that uninstalls the software. The program removes all binary portions of the Documentum software, including the full-text and database software if it was installed as part of the package.
To uninstall Case Management Solution Framework:
1. From the Microsoft Windows Start menu, navigate to Programs>Documentum>Uninstall and click Uninstall to launch the program that uninstalls Case Management Solution Framework. The uninstallation wizard starts.
2. Click Next.
3. Type the Windows administrator password and click Next.
At the end of the uninstallation process a dialog appears that indicates the successful uninstallation of the software.
4. Click Next.