Survey
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Microsoft Access wikipedia , lookup
Relational model wikipedia , lookup
Extensible Storage Engine wikipedia , lookup
Open Database Connectivity wikipedia , lookup
Database model wikipedia , lookup
Microsoft Jet Database Engine wikipedia , lookup
Ingres (database) wikipedia , lookup
Object-relational impedance mismatch wikipedia , lookup
Clusterpoint wikipedia , lookup
EMC ® Documentum ® Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide P/N 300-008-368–A04 EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.EMC.com Copyright © 1994 - 2009 EMC Corporation. All rights reserved. Published September 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. All other trademarks used herein are the property of their respective owners. Table of Contents Preface Chapter 1 Chapter 2 Chapter 3 ................................................................................................................................. Preparing for the Installation 9 Installation and configuration worksheet ........................................................... 10 Prepare the host machines ................................................................................. Deployment options ..................................................................................... Ports ............................................................................................................ Documentum directories ............................................................................... 11 12 12 12 Prepare the database and repository .................................................................. Repository and global registry ....................................................................... Connecting to an existing database ................................................................ Connecting to a Microsoft SQL Server database ............................................. Connecting to an Oracle database .................................................................. Entries in tnsnames.ora file........................................................................ 13 13 14 14 15 15 Installing Content Server OEM Edition ........................................................ 17 Installing Content Server OEM Edition with the GUI .......................................... 17 Reinstalling Content Server OEM Edition from the GUI ...................................... Installing Content Server OEM Edition from the command line ........................... Updating the configuration file ...................................................................... Running the command line installation .......................................................... 26 26 26 27 Reinstalling Content Server OEM Edition from the command line ....................... Reviewing the installation logs .......................................................................... 28 29 Starting or stopping Content Server OEM Edition ............................................... 30 Developing custom Documentum applications ................................................... 31 Uninstalling Content Server OEM Edition .......................................................... 32 Creating a Custom Installation Package ...................................................... 35 Replacing the Welcome page ............................................................................. Creating an installation package for the command-line installation ...................... 35 35 Creating the Content Server OEM Edition configuration file ................................ Configuration file format and parameters....................................................... 36 37 Removing Components from Content Server OEM Edition ................................. 39 Removing sample data Chapter 4 ........................................................................ 7 ..................................................................................... 40 Understanding the Content Server OEM Edition Repository ...................... 41 Configuring the repository ................................................................................ Operating configuration ................................................................................ Global registry ............................................................................................. Administration jobs ...................................................................................... 41 41 42 42 Runtime log files .............................................................................................. 42 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 3 Table of Contents Chapter 5 4 Creating users and groups ................................................................................ Adding users to the repository ...................................................................... Using an LDAP directory server .................................................................... Required and recommended attributes for users ......................................... Required and optional attributes for groups ................................................... 42 43 43 43 44 Configuring jobs ............................................................................................... Setting job schedules ..................................................................................... Activating and deactivating jobs .................................................................... 45 45 46 ............................................................... Understanding indexing and the indexing software ............................................ Words that are not indexed ............................................................................... Punctuation ..................................................................................................... Indexing numeric values ................................................................................... Indexing NULL values ...................................................................................... Supported formats ............................................................................................ Supported languages ........................................................................................ Supported querying .......................................................................................... Comparing Lucene and FAST full-text indexing systems ..................................... Internationalization .......................................................................................... Object type schema changes and full-text indexing ............................................. Optimizing the index ........................................................................................ Tuning the result set batch size .......................................................................... Objects and attributes supporting full-text indexing ............................................ Indexing failures .............................................................................................. Log files and logging ........................................................................................ 47 Understanding Full-Text Indexing 47 48 48 48 48 49 49 49 49 50 50 51 52 52 53 53 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Table of Contents List of Tables Table 1. Installation and configuration worksheet ............................................................... 10 Table 2. Content Server OEM Edition configuration file parameters ..................................... 38 Table 3. Web applications installed as part of Content Server OEM Edition ........................... 39 Table 4. Required and recommended user attributes ........................................................... 44 Table 5. Required and optional group attributes.................................................................. 45 Table 6. Full-text indexing server comparison — Lucene and FAST ...................................... 49 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 5 Table of Contents 6 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Preface EMC Documentum Content Server OEM Edition provides an infrastructure for developing applications that incorporate content management functionality. These applications are then deployed as part of a custom installation program. Content Server OEM Edition is an integrated platform that includes Content Server, development tools, administrative tools and applications. It also includes a relational database management system, and a full-text index system. It includes the core technology, content-related services, and the developer resources for building content-rich applications. Installing Content Server OEM Edition automatically deploys all components and configures a content repository. You can choose to install Content Server OEM Edition by using the graphical user interface (GUI) installation program or by using the command line (also known as "silent” installation). Note: Compared to Content Server Enterprise Edition, Content Server OEM Edition has limitations in terms of scalability and performance. If you find that Content Server OEM Edition does not meet your scalability and performance requirements, you might want to consider implementing Content Server Enterprise Edition. This manual describes how to install and configure Content Server OEM Edition, and how to incorporate it into an application. Intended audience This manual is intended for individuals developing applications that embed Content Server OEM Edition to provide an internal content repository. Revision history The following revisions have been made to this document: EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 7 Preface Revision History 8 Date Description June 2009 Initial publication September 2009 Revised publication EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Chapter 1 Preparing for the Installation This chapter describes how to prepare for the installation of Content Server OEM Edition into your development environment. It consists of these major sections: • Installation and configuration worksheet, page 10 • Prepare the host machines, page 11 • Prepare the database and repository, page 13 As you work your way through the installation steps, use the Installation and configuration worksheet, page 10, to record the information you need to collect in order to install Content Server OEM Edition. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 9 Preparing for the Installation Installation and configuration worksheet Use the following worksheet to record information you will be prompted for during the installation procedure. All parameters are required unless otherwise noted. Table 1. Installation and configuration worksheet Parameter Resource On Microsoft Windows only: Microsoft Windows username and password Your login information for the host. ______________________ On Linux only: root password ______________________ Documentum program directory: Prepare the host machines, page 11. ______________________ Documentum user directory: ______________________ Application server port (optional parameter) ______________________ Prepare the host machines, page 11. The default port is 9080. The GUI installation program only asks for this information if you ask to see custom options. You may also omit this parameter during the command-line installation, and instead the use the default value. For Oracle databases only: the database connection identifier ______________________ Entries in tnsnames.ora file, page 15, and Oracle database documentation. Microsoft Server only: ODBC data source name: Required only when connecting to an existing Microsoft SQL Server database. Prepare the database and repository, page 13. ______________________ Database administrator name: ______________________ Database administrator password: ______________________ Database server instance name (in ALL CAPS): ______________________ 10 Required only when connecting to an existing Microsoft SQL Server database or an existing Oracle database. Prepare the database and repository, page 13. The database administrator name is automatically set to "sa” when you choose to use the bundled Microsoft SQL Server Required only for installation from the command line. Required only when Content Server OEM Edition creates a new database. Prepare the database and repository, page 13. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Preparing for the Installation Parameter Resource Global registry password: Required only when connecting to an existing Microsoft SQL Server database or an existing Oracle database. Prepare the database and repository, page 13. The repository owner password is optional with the GUI installation program. You will only be asked to enter it if you choose to specify custom options. It is required for an installation from the command line. ______________________ Repository owner password: ______________________ Full path for the oemConfig.xml file (full_path_of_config_file) Required only for installation from the command line. SMTP server name Applies only to installations from the command line and is an optional parameter. Administrator email Applies only to installations from the command line and is an optional parameter. Prepare the host machines Before you begin installing Content Server OEM Edition, ensure that the host machine meets the hardware and software requirements detailed in the EMC Documentum Content Server OEM Edition Release Notes. The host on which you install Content Server OEM Edition must not have any existing EMC Documentum products installed on it. The host name must use only ASCII characters. To install Content Server OEM Edition, including Content Server, the database, the connection broker, and the indexing system, you must have a minimum 15 GB of free disk space and 3 GB free temporary space. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 11 Preparing for the Installation Deployment options You can deploy Content Server OEM Edition in one of two ways: • Single host: all components including application and database are on a single host. This configuration is typically used with embedded Microsoft SQL Express for development or proof of concept purposes. You can also use this configuration with Sybase in a production environment. • Multiple hosts: A multiple host configuration is typically used in a production environment in either one of the following configurations: — All Documentum components and applications are installed on one host. The database is on a different host. — All Documentum components are installed on one host. Applications and the database are installed on the same or different hosts. Ports The application server and connection broker installed with Content Server OEM Edition use ports on the host machine. Before installing the software, you must identify open ports for these components to use. The default port for the embedded application server is 9080. The application server requires a block of 20 consecutive open ports starting at this number. The default 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 Content Server OEM Edition 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 (Windows) or userHomeDirectory/dctm (Linux). • The user directory is the directory where Documentum data is stored. The typical location is C:\Documentum (Windows) or userHomeDirectory/dctm/shared. The user directory must not have any spaces in the path. You must identify these two directories when you run the Content Server OEM Edition installation program. The installation program will create the directories if they do not already exist. Record the paths to the program directory and user directory on the Installation and configuration worksheet, page 10. 12 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Preparing for the Installation Prepare the database and repository Content Server OEM Edition uses a relational database to store metadata about the content in the repository. Content Server OEM Edition supports Microsoft SQL Server, Sybase, and Oracle databases. For the supported database versions see the EMC Documentum Content Server OEM Edition Release Notes. Note: The Microsoft SQL Server 2005 Express database is provided as a courtesy only. Contact Microsoft for assistance. EMC is not responsible for supporting it. If you are using a Microsoft SQL Server database, by default, Content Server OEM Edition creates the database as part of the installation process. Alternatively, you have the option to connect to an existing database. If you choose to use an existing Microsoft SQL Server database, you use Microsoft SQL Server tools to create the database; the Content Server OEM Edition installation program creates the necessary tables for the repository. Content Server OEM Edition also supports a bundled Sybase database, where the database is created as part of the installation process. If you are using an Oracle database, you will connect to an external Oracle database. Record a name for the database server instance on the Installation and configuration worksheet, page 10. For the command-line installation when using the bundled database, the database server instance name must use all capital letters. For the bundled Microsoft SQL Server or Sybase database, the installation program will create a database server instance whose name is a combination of the server host name and the specified instance name, and, for Microsoft Windows only, create an ODBC data source with the instance name. Caution: The Microsoft bug described in KB article 968749 (http://support.microsoft.com/kb/ 968749) can cause an installation error ("DiPADbInstall failed!”) if you are using Microsoft SQL Server Express. This error occurs with XML Core Services 6.0 SP2, which is installed when you upgrade to Windows XP SP3. Follow the instructions in the Microsoft KB article cited above to correct your XML Core Services before attempting to install the product again. The repository has a name, which is the name users see when connecting to the repository and which is also used in the name of the underlying database. The repository name needs to be unique on the network. The name can have up to 32 characters, and must consist of ASCII letters, numbers, or underscores (_), with no spaces. The repository name "docu” is reserved by EMC Documentum. Record the repository name on the Installation and configuration worksheet, page 10. Repository and global registry The repository is created as a global registry. The global registry is a repository like any other repository except that it is capable of managing installation-wide elements that would be accessed if other repositories where a part of the installation. Content Server OEM Edition supports the creation of one repository per Content Server OEM Edition installation. Therefore, the repository functions as both a content repository and a global registry. For more information about global registries, refer to the EMC Documentum Content Server Installation Guide. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 13 Preparing for the Installation Record a global registry password and a global registry owner password on the Installation and configuration worksheet, page 10. Connecting to an existing database You can choose to connect to an existing Microsoft SQL Server or Oracle database. For information about supported databases, refer to the EMC Documentum Content Server OEM Edition Release Notes. Connecting to a Microsoft SQL Server database Refer to the Microsoft SQL Server documentation for information about installing Microsoft SQL Server. You can choose to install the Microsoft SQL Server Express database delivered with Content Server OEM Edition, or connect to an existing Microsoft SQL Server database. If you choose to use to an existing database, you can connect to a local database on the same host machine as Content Server OEM Edition or a remote database on a separate host. In a production environment, the database is almost always on a separate host for performance reasons. If you use an existing Microsoft SQL Server installation, ensure that it has the correct values for the required configuration options. The required configuration options are as follows: • Select the security mode value of Mixed Mode (Microsoft SQL Server authentication and Windows authentication). • Select a collation that uses Dictionary sort order and is case-sensitive. Install the database in case-sensitive mode. If the database and Content Server OEM Edition are on the same host machine, ensure that the database service is set to start automatically. If the database is on a different host machine from the Content Server OEM Edition, you also need to install Microsoft SQL Server client software on the Content Server OEM Edition machine. You need to install both the Microsoft SQL Server client and Microsoft SQL tools; see the Microsoft SQL Server documentation for details. On the Content Server OEM Edition machine, create a System DSN that uses the Microsoft SQL Server driver. When prompted for a name of the data source, use the name of the Content Server OEM Edition host machine. When prompted for the Microsoft SQL Server name, enter hostname/instancename if you have two Microsoft SQL Server instances on the same host. When creating the ODBC data source, you can choose either Windows authentication or Microsoft SQL Server authentication as an authentication method. • If you choose Windows authentication for creating the ODBC data source, the repository owner must have a Windows account and the installation owner must have System Administrator privileges in Microsoft SQL Server. • If you choose Microsoft SQL Server authentication, the repository owner does not have to have a Microsoft Windows account. 14 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Preparing for the Installation The appropriate network library for the driver depends on whether the database is on the same host machine as Content Server OEM Edition: • If Microsoft SQL Server is on a different host from Content Server OEM Edition, select TCP. • If Microsoft SQL Server is on the same host as Content Server OEM Edition, select Named Pipes. If you are connecting to an existing Microsoft SQL Server database, record the name and password for the database administrator and the name of the ODBC data source on the Installation and configuration worksheet, page 10. Connecting to an Oracle database Refer to the Oracle documentation for information about installing the RDBMS. If you choose to use to an existing database, you can connect to a local database on the same host machine as Content Server OEM Edition or a remote database on a separate host. In a production environment, the database is almost always on a separate host for performance reasons. Use the Custom installation option so that you can set the configuration options that Content Server OEM Edition requires. The required configuration options are as follows: • Retention Services require UTF-8 code page. • Set up the networking parameters required by Oracle as follows: — In the init.ora or spfile, use the following settings: optimizer_index_cost_adj=5 optimizer_index_caching=95 • Ensure that the Oracle Listener is running on the Oracle host. Entries in tnsnames.ora file Oracle database aliases (TNS aliases) are defined by entries in the tnsnames.ora file. You cannot connect to an Oracle database without an alias. Configure the tnsnames.ora file on the Content Server OEM Edition host. Use the Oracle SQL*Net configuration tool to create a database alias referring to the database instance you plan to use for Content Server OEM Edition. After you create the alias, test the alias by connecting to the Oracle database. Entries in the tnsnames.ora file for the Oracle HTTP service and data expo service do not contain parameters for HOST, SID, and SERVICE. If the first entry in the tnsnames.ora file is for one of these services, the Content Server OEM Edition installation program is unable to parse the tnsnames.ora EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 15 Preparing for the Installation file and cannot connect to the database. Make sure that the first entry in the tnsnames.ora file is not for the Oracle HTTP service or data expo service. 16 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Chapter 2 Installing Content Server OEM Edition You can install Content Server OEM Edition by using one of two methods: • Running a graphical user interface (GUI) installation program • Updating a configuration file and running the installation program from the command line Installing Content Server OEM Edition with the GUI You install Content Server OEM Edition by running the documentumSetup.exe installation program on Microsoft Windows or the documentumSetup.bin installation program on Linux. The installation program creates the repository and installs all Documentum components. You can install Content Server OEM Edition in one of the following configurations: • On a Microsoft Windows operating system and connecting to a Microsoft SQL Server database • On a Microsoft Windows operating system and connecting to an Oracle database • On a Microsoft Windows operating system and connecting to a Sybase database • On a Linux operating system and connecting to an Oracle database • On a Linux operating system and connecting to a Sybase database Note: For optimal performance during installation, turn off any virus checking on the host machine. To install Content Server OEM Edition on a Microsoft Windows operating system and to connect to a Microsoft SQL Server database: Note: Java 1.5, update 12 does not support Windows Server 2008. Therefore, if you want to run Content Server OEM Edition on the Windows Server 2008 operating system, you need to upgrade to Java 1.5, update 19 after the installation. See the EMC Documentum Content Server OEM Edition Release Notes for information on how to upgrade. Note: Before you can install Content Server OEM Edition on a Windows Server 2008 platform, you must disable user account control (UAC). See the EMC Documentum Content Server OEM Edition Release Notes for information on how to disable UAC. 1. Log in to the host system using your Microsoft Windows login. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 17 Installing Content Server OEM Edition Note: Microsoft Windows user accounts are not case-sensitive, but Content Server OEM Edition 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 Content Server OEM Edition 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. 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 the 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 OEM Edition and data (C:\Documentum) or click Browse to select a different installation directory. The name of the directory in which Content Server OEM Edition 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 the installation owner username and password, which is typically the login for the host on which you are performing the installation, and click Next. 9. Choose from the following options: • Install the Microsoft SQL Server Express database delivered with the Content Server OEM Edition software package or connect to an existing database. • Custom options, which enable you to set ports and additional passwords. To install the Microsoft SQL Server Express database delivered with the Content Server OEM Edition software package, click Yes, install a Microsoft SQL Server Express database for me. You must choose this option if you do not already have an Microsoft SQL Server database installed. To connect to an existing Microsoft SQL Server database, click No, I want to use my existing Microsoft SQL Server database. You must choose this option if you already have an Microsoft SQL Server database installed. In the dialog that appears next, enter the data source name, and the database administrator name and password. Click Next. To see custom options, click Yes under custom options. The Custom Options dialog appears where you enter the required information: • Type the application server port. The selected port must not be used by another application. The default port number is 9080. A total of 20 ports starting at the port number you select are 18 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Installing Content Server OEM Edition reserved for this application server instance, and all of them must be available. The installer will create an application server instance to host Webtop, the ACS methods server, and other applications. Enter the port number that you want the application server to bind to. This port number will appear in the URLs for the applications. • Type the repository name. If you choose to use the bundled SQL Server, this field does not appear and "documentum” will be used as the repository name. • Type the database administrator password. This field only appears if you have chosen to use the bundled SQL Server database. Enter the value that you want to set as the database administrator password. The default value is "documentum-1.” • Type the global registry password. This is the password to set for the dm_bof_registry user. Typically you would want to set the global registry password to a different value than the other passwords because you will need to share this password with most DFC clients. The default value is "documentum-1.” • Type the repository owner password. The repository owner is the database user that owns all repository metadata. The repository uses this database user to connect to the database. The installation program will create this user automatically. Enter the value that you want to set as the repository owner password. The default value is "documentum-1.” Click Next after having chosen your options and entered the required values. A dialog appears that shows a list of packages included in this installation. 10. Click Next. After clicking Next, the installation begins. If you have chosen to install the bundled SQL Server, the installation will take about 20 minutes. If you have chosen to connect to an existing database, the installation might take up to two hours. A dialog appears that indicates the successful installation of Content Server OEM Edition. 11. Click Finish. This will launch the Content Server OEM Edition 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. To install Content Server OEM Edition on a Microsoft Windows operating system and to connect to a Sybase database: 1. Log in to the host system using your Microsoft Windows login. Note: Microsoft Windows user accounts are not case-sensitive, but Content Server OEM Edition 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 Content Server OEM Edition 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. 4. Run the installation program from the directory into which you expanded the files by double-clicking documentumSetup.exe. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 19 Installing Content Server OEM Edition 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 the 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 OEM Edition and data (C:\Documentum) or click Browse to select a different installation directory. The name of the directory in which Content Server OEM Edition 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 the installation owner username and password, which is typically the login for the host on which you are performing the installation, and click Next. 9. The custom options dialog enables you to set ports and additional passwords: • Type the application server port. The selected port must not be used by another application. The default port number is 9080. A total of 20 ports starting at the port number you select are reserved for this application server instance, and all of them must be available. The installer will create an application server instance to host Webtop, the ACS methods server, and other applications. Enter the port number that you want the application server to bind to. This port number will appear in the URLs for the applications. • "documentum” will be used as the repository name. • Type the database administrator password. Enter the value that you want to set as the database administrator password. The default value is "documentum-1.” • Type the repository service name. This value must match the repository service value that you added to etc/services. • Type the global registry password. This is the password to set for the dm_bof_registry user. Typically you would want to set the global registry password to a different value than the other passwords because you will need to share this password with most DFC clients. The default value is "documentum-1.” • Type the repository owner password. The repository owner is the database user that owns all repository metadata. The repository uses this database user to connect to the database. The installation program will create this user automatically. Enter the value that you want to set as the repository owner password. The default value is "documentum-1.” Click Next after having chosen your options and entered the required values. A dialog appears that shows a list of packages included in this installation. 10. Click Next. After clicking Next, the installation begins. The installation will take about 20 minutes. A dialog appears that indicates the successful installation of Content Server OEM Edition. 11. Click Finish. 20 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Installing Content Server OEM Edition This will launch the Content Server OEM Edition 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. To install Content Server OEM Edition on a Microsoft Windows operating system and to connect to an Oracle database: 1. Log in to the host system using your Microsoft Windows login. Note: Microsoft Windows user accounts are not case-sensitive, but Content Server OEM Edition 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 Content Server OEM Edition 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. 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 the 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 OEM Edition and data (C:\Documentum) or click Browse to select a different installation directory. The name of the directory in which Content Server OEM Edition 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 the installation owner username and password, which is typically the login for the host on which you are performing the installation, and click Next. The database connection dialog appears. 9. In the database connection dialog, type the following values: • Database connection identifier • Database administrator name • Database administrator password Click Next. The custom options dialog appears. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 21 Installing Content Server OEM Edition 10. Choose from the following database options: • Connect to your existing Oracle database. • Custom options, which enable you to set ports and additional passwords. To connect to an existing Oracle database, click No, I want to use my existing Oracle database. You must choose this option if you already have an Oracle database installed. In the dialog that appears next, enter the data source name, and the database administrator name and password. Click Next. To see custom options, click Yes under custom options. The Custom Options dialog appears where you enter the required information: • Type the application server port. The selected port must not be used by another application. The default port number is 9080. A total of 20 ports starting at the port number you select are reserved for this application server instance, and all of them must be available. The installer will create an application server instance to host Webtop, the ACS methods server, and other applications. Enter the port number that you want the application server to bind to. This port number will appear in the URLs for the applications. • Type the repository name. If you choose to use the bundled SQL Server, this field does not appear and "documentum” will be used as the repository name. • Type the database administrator password. This field only appears if you have chosen to use the bundled SQL Server database. Enter the value that you want to set as the database administrator password. The default value is "documentum-1.” • Type the global registry password. This is the password to set for the dm_bof_registry user. Typically you would want to set the global registry password to a different value than the other passwords because you will need to share this password with most DFC clients. The default value is "documentum-1.” • Type the repository owner password. The repository owner is the database user that owns all repository metadata. The repository uses this database user to connect to the database. The installation program will create this user automatically. Enter the value that you want to set as the repository owner password. The default value is "documentum-1.” Click Next. A dialog appears that shows a list of packages included in this installation. 11. Click Next. A dialog appears that indicates the successful installation of Content Server OEM Edition. 12. Click Finish. This will launch the Content Server OEM Edition 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. To install Content Server OEM Edition on the Linux operating system and to connect to an Oracle database: 1. Log in to the host system using your host system login. 2. Download the Content Server OEM Edition 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. 22 Uncompress the distribution file. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Installing Content Server OEM Edition Uncompress the distribution file in any directory whose name does not contain spaces in the path. The installation files are uncompressed to that directory. 4. Run the installation program from the directory into which you expanded the files by double-clicking documentumSetup.bin. 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 the 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 OEM Edition and data (userHomeDirectory/dctm) or click Browse to select a different installation directory. The name of the directory in which Content Server OEM Edition 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 (userHomeDirectory/dctm/ shared) or click Browse to select a different directory. Click Next. 8. Type the root password, which is typically the login for the host on which you are performing the installation, and click Next. The custom options dialog appears. 9. Choose whether to specify custom options. If you choose to specify custom options, the custom options dialog appear in which you can specify ports and additional passwords. If you do not choose to specify custom options, the database connection panel appears. 10. If you chose to specify custom options: • Type the application server port. The selected port must not be used by another application. The default port number is 9080. A total of 20 ports starting at the port number you select are reserved for this application server instance, and all of them must be available. The installer will create an application server instance to host Webtop, the ACS methods server, and other applications. Enter the port number that you want the application server to bind to. This port number will appear in the URLs for the applications. • Type the repository name. If you choose to use the bundled SQL Server, this field does not appear and "documentum” will be used as the repository name. • Type the repository service name. This value must match the repository service value that you added to /etc/services. • Type the global registry password. This is the password to set for the dm_bof_registry user. Typically you would want to set the global registry password to a different value than the other passwords because you will need to share this password with most DFC clients. The default value is "documentum-1.” • Type the repository owner password. The repository owner is the database user that owns all repository metadata. The repository uses this database user to connect to the database. The installation program will create this user automatically. Enter the value that you want to set as the repository owner password. The default value is "documentum-1.” EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 23 Installing Content Server OEM Edition Click Next. The database connection dialog appears. 11. In the database connection dialog, type the following values: • Database connection identifier • Database administrator name • Database administrator password Click Next. A dialog appears that shows a list of packages included in this installation. 12. Click Next to begin the installation. The installation might take up to two hours. After the installation has completed, a dialog appears that indicates the successful installation of Content Server OEM Edition. 13. Click Finish. This will launch the a dialog that displays the path to where Content Server OEM Edition welcome page resides that provides information on how to launch its component applications. To install Content Server OEM Edition on the Linux operating system and to connect to a Sybase database: Note: Sybase ASE 15.0.3 ESD#1 requires the Microsoft Visual C++ 2005 SP1 Redistributed Package. Otherwise, the installation might fail, and you might see the message: "Sybase installation has failed. It is likely the Microsoft Visual C++ 2005 SP1 Redistributed Package has not been installed. For details on how to install that package, see the release notes.” Ensure that this package is installed before you begin installing Content Server OEM Edition with a Sybase database. You can download and install this package from the Microsoft web site. 1. Log in to the host system using your host system login. 2. Download the Content Server OEM Edition 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. Uncompress 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. 4. Run the installation program from the directory into which you expanded the files by double-clicking documentumSetup.bin. 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 the 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. 24 You can accept the default directory for Content Server OEM Edition and data (userHomeDirectory/dctm) or click Browse to select a different installation directory. The name of the directory in which Content Server OEM Edition is installed must contain only ASCII characters and must not include spaces. Do not use any of these characters in pathnames: ! \ /: *? "<>|. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Installing Content Server OEM Edition You can accept the default directory for shared Documentum programs (userHomeDirectory/dctm/ shared) or click Browse to select a different directory. Click Next. 8. Type the root password, which is typically the login for the host on which you are performing the installation, and click Next. The custom options dialog appears. 9. Choose whether to specify custom options. If you choose to specify custom options, the custom options dialog appear in which you can specify ports and additional passwords. If you do not choose to specify custom options, the database connection panel appears. 10. If you chose to specify custom options: • Type the application server port. The selected port must not be used by another application. The default port number is 9080. A total of 20 ports starting at the port number you select are reserved for this application server instance, and all of them must be available. The installer will create an application server instance to host Webtop, the ACS methods server, and other applications. Enter the port number that you want the application server to bind to. This port number will appear in the URLs for the applications. • For the bundled Sybase database, "documentum” will be used as the repository name. • Type the repository service name. This value must match the repository service value that you added to /etc/services. • Type the global registry password. This is the password to set for the dm_bof_registry user. Typically you would want to set the global registry password to a different value than the other passwords because you will need to share this password with most DFC clients. The default value is "documentum-1.” • Type the repository owner password. The repository owner is the database user that owns all repository metadata. The repository uses this database user to connect to the database. The installation program will create this user automatically. Enter the value that you want to set as the repository owner password. The default value is "documentum-1.” Click Next. The database connection dialog appears. 11. In the database connection dialog, type the following values: • Database connection identifier • Database administrator name • Database administrator password Click Next. A dialog appears that shows a list of packages included in this installation. 12. Click Next to begin the installation. The installation might take up to two hours. After the installation has completed, a dialog appears that indicates the successful installation of Content Server OEM Edition. 13. Click Finish. This will launch the a dialog that displays the path to where Content Server OEM Edition welcome page resides that provides information on how to launch its component applications. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 25 Installing Content Server OEM Edition Reinstalling Content Server OEM Edition from the GUI If an error occurs during installation, first diagnose and fix the problem that caused the failure, then reinstall Content Server OEM Edition. On a Microsoft Windows platform: • Run the uninstall wizard from the Start>Documentum>Uninstall menu. • If you are reinstalling on Windows, reboot the machine when prompted to do so. • Run the installation program again. On a Linux platform, uninstall Content Server OEM Edition from the command line as described in Reinstalling Content Server OEM Edition from the command line, page 28, then install Content Server OEM Edition on a Linux platform following GUI installation procedure described in this guide. Installing Content Server OEM Edition from the command line You install Content Server OEM Edition by running a command on the command line. The installation program creates the repository and installs all of the Documentum components. Updating the configuration file When the Content Server OEM Edition installation program runs, it refers to an XML configuration file to retrieve values for configuration settings. The configuration file is used to pass parameters to the installation program, including names for database and for the repository. Note: The following procedure describes how to create a basic configuration file with all required elements. For details about optional configuration parameters, refer to Creating the Content Server OEM Edition configuration file, page 36. To create a configuration file: 1. Download the Content Server OEM Edition software. You can find the location of the software and instructions for downloading it in the email you received regarding the EMC download site. 2. 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. 3. Use a text editor to open the file oemConfig.xml in the directory into which you expanded the files. 4. Update the XML text as shown below, with values from the Installation and configuration worksheet, page 10 in place of the italicized items. • If you are allowing the Content Server OEM Edition installation program to create a database: 26 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Installing Content Server OEM Edition <dctmOemInstall version="1.0"> <database connectionIdentifier=”db_server_name" databaseAdminName="sa" useExistingServer="false" /> <docbase name="repository_name" /> </dctmOemInstall> If the value for useExistingServer is false, the value you choose for the repository name is ignored and your repository is named "documentum.” • If you are connecting to an existing database: <dctmOemInstall version="1.0"> <database connectionIdentifier=”ODBC_name_for_SQL_Server” or oracle_connection_string databaseAdminName="db_admin_user" useExistingServer="true" /> <docbase name="repository_name" /> </dctmOemInstall> 5. To use nondefault ports for the application server or connection broker, add these elements just before the </dctmOemInstall> closing tag. • To use a port other than 9080 for the application server: <javaMethodServer httpPort="application_server_port" /> • To use a port other than 1489 for the connection broker: <docbroker port="connection_broker_port" /> 6. Save the configuration file. Running the command line installation After you have updated the configuration file, you can start the command-line installation. To install Content Server OEM Edition: 1. Log in to the host system using your Microsoft Windows user name and password. Note: Microsoft Windows user accounts are not case-sensitive, but Content Server OEM Edition 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. Run the installation program from the directory into which you expanded the files. The format of the command line for Microsoft Windows is: documentumSetup.exe -silent -target programDir="program_directory" userDir="user_directory" -passwords databaseAdmin=database_admin_password docbaseOwner=password windowsInstallOwner=username_and_password globalRegistryUser=password -oemConfig file="full_path_of_config_file" The format of the command line for Linux is: documentumSetup.bin -silent -target programDir="program_directory" EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 27 Installing Content Server OEM Edition userDir="user_directory" -passwords databaseAdmin=sa_password docbaseOwner=repository_owner_password unixRoot=root_password globalRegistryUser=password -oemConfig file="full_path_of_config_file" Use quotation marks to enclose any parameter values containing one or more spaces. The Installation and configuration worksheet, page 10 contains the values for program_directory, user_directory, username_and_password, and full_path_of_config_file. If you are connecting to an existing database, the database_admin_password must be the password for the user identified in the configuration file as the databaseAdminName. If the Content Server OEM Edition installation program is creating a new database, it will set the password for the user "sa” to the password you enter. The installation program sets the passwords for the docbaseOwner and globalRegistryUser to the values you enter on the command line. Valid passwords must conform to these requirements: • They must be composed entirely of alphanumeric characters (letters and the digits between 0–9 only) • They must contain at least six characters. • They must contain at least one digit. • They must contain at least two letters. For example, for a new Microsoft Windows installation: documentumSetup.exe -silent -target programDir="c:\Program Files\Documentum" userDir="c:\Documentum" -passwords databaseAdmin=dbapassword docbaseOwner=ownerPassword windowsInstallOwner=install_owner_password globalRegistryUser=globalregpassword -oemConfig file="c:\temp\oemConfig.xml" The Content Server OEM Edition installation program installs and configures the database first, then installs the Content Server OEM Edition software and configures a connection broker and repository. If the installation program fails at any point, it returns a nonzero return code. To check the return code on Microsoft Windows, enter echo %errorlevel% immediately after the installation command returns. To check the return code on Linux in a Bourne shell, enter echo $?. Reinstalling Content Server OEM Edition from the command line If an error occurs during installation and the repository failed to install successfully, run the Uninstall program to remove all of the components, then rerun the installation program. See Uninstalling Content Server OEM Edition, page 32. Reboot the host machine after removing the software and before reinstalling it. 28 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Installing Content Server OEM Edition Reviewing the installation logs If the installation fails, check the file setupError.log in the directory from which you ran the installation program. The log gives specific information about what failed. You can start the installation program again after correcting the cause of the error. See Reinstalling Content Server OEM Edition from the command line, page 28. If any of the values from the command line or the oemConfig.xml file are incorrect, the error message begins with text similar to: (timestamp), Setup.product.install, com.documentum.install. shared.common.error.DiException, err, An exception occured in: DiWAOemValidateInputData, beanID: validateInputData The remainder of the line tells you which value is invalid and why it is invalid. For example, if you specify a userDir that does not have enough disk space, the error message would be: (timestamp), Setup.product.install, com.documentum.install.shared.common.error. DiException, err, An exception occured in: DiWAOemValidateInputData, beanID: validateInputData - The file system, C:\, should have 3GB but it has 1GB only. For non-validation errors, the error message indicates which portion of the installation process failed. Refer to the log file for that component for more details. For example, if the message mentions launchServerConfigurationProgram.bat, check the log files in the directory user_dir\product\6.5\install for more details. If the message mentions launchFTConfigurationProgram.bat, check the log files in the directory program_dir\IndexAgents for more details. The log files created during installation are listed below. install_dir is the directory in which you run the installation program; program_dir is the Documentum program directory, and user_dir is the Documentum user directory. • install_dir\install_owner.ServerInstaller.log (Content Server OEM Edition installation log) • install_dir\setupError.log (Installation errors) • install_dir\install.log (Server installation log) • program_dir\IndexAgents\install.log (Index agent configuration log) • program_dir\IndexAgents\setupError.log (Index agent configuration errors) • user_dir\dba\config\repository_name/*.out (Repository script log) • user_dir\oem\log\DmServerOemService.log (Documentum Content Server OEM Edition service log) • user_dir\dba\log\DocBroker.Docbroker.log (Connection broker startup log) • user_dir\dba\log\repository_name.log (Repository startup log) • user_dir\product\6.5\install\install_owner.ServerConfigurator.log (Content Server OEM Edition configuration log) • user_dir\product\6.5\install\setupError.log (Content Server OEM Edition configuration errors) • Program Files\Microsoft SQL Server\90\Setup Bootstrap\LOG\summary.txt(Microsoft SQL Server summary log) EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 29 Installing Content Server OEM Edition • Program Files\Microsoft SQL Server\90\Setup Bootstrap\LOG\Files(Microsoft SQL Server log files) • userDir/sybase/log.txt (Sybase installation log) Starting or stopping Content Server OEM Edition This section describes how to start and log into Content Server OEM Edition components. To start or stop Content Server OEM Edition on Windows: 1. Start Content Server OEM Edition by starting the service named "Documentum Master Service.” The log for the service is named dctmServerOem.log and located in the user_directory\oem directory. Note: The Documentum Master Service replaces the Documentum services created for the enterprise edition of Content Server, such as the Documentum Java Method Server service. Use the Documentum Master Service to start and stop the software. To start or stop Content Server OEM Edition on Linux: 1. To start Content Server OEM Edition, run the dctmStartFullServer.sh script 2. To stop Content Server OEM Edition, run the dctmStopFullServer.sh script. Both scripts are located in the user_directory\dba directory. To log in to Documentum Administrator or Retention Policy Services Administrator from another machine: 1. Start a web browser on a client machine. 2. Connect to the following URL, where host is the name of the host machine where Content Server OEM Edition is installed and appserver_port is the application server port on that host: http://host:portnumber/da/ or http://host:portnumber/rpsa/ 3. Type your login name and password. If you have not yet used Documentum Administrator to add users and groups to the repository, you must log in as the installation owner, using the installation owner’s user name and password. 4. Click Login. To log in to Documentum Administrator from the Windows Start menu: 1. From the Microsoft Windows Start menu, navigate to Programs>Documentum>Administration>Documentum Administrator. 2. Type your Content Server OEM installation owner username and password. 3. Click Login. 30 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Installing Content Server OEM Edition To log in to Retention Policy Services Administrator from the Windows Start menu: 1. From the Microsoft Windows Start menu, navigate to Programs>Documentum>Administration>Retention Policy Services Admin. 2. Type your Content Server OEM installation owner username and password. 3. Click Login. To start Documentum Composer from the Windows Start menu: 1. From the Microsoft Windows Start menu, select Documentum > Documentum Composer. Note: Documentum Composer is supported on Microsoft Windows only. To log in to Webtop: 1. From the Windows Start menu, navigate to Programs>Documentum>Applications>Webtop. 2. Type the username and password provided on the welcome page. 3. Click Login. Developing custom Documentum applications Content Server OEM Edition includes development tools for customizing and creating Documentum applications. The key developer-oriented products are: • Documentum Composer, a design tool for creating application elements and deploying them into content repositories. Documentum Composer is supported on Microsoft Windows only. • Documentum Foundation Classes (DFC), the application programming interface for communicating with Content Server OEM Edition. • Documentum Foundation Services (DFS), a web-service interface that developers can use to access Documentum functionality. • Documentum Foundation Services (DFS) software development kit (SDK), which you can use to develop Documentum functionality. The SDK package provides libraries and samples for developing DFS clients that use the optional .NET or Java client productivity layer, and it provides tools for generating custom services from Java and .NET source files. The DFS SDK package is delivered as a .zip file (emc-dfs-sdk-6.5.zip). The file is available in the directory into which you uncompressed the installation package. For more information on how to install and use the DFS SDK package refer to the DFS documentation set. • Retention Policy Services (RPS) software development kit, which you can use to develop Documentum functionality for retention policies. The RPS SDK package is delivered as .zip file (emc-rps-sdk-6.5.zip). The file is available in the directory into which you uncompressed the installation package. For more information on how to install and use the RPS SDK package refer to the RPS documentation set. • Web Development Kit (WDK), the development environment for customizing web-based Documentum applications. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 31 Installing Content Server OEM Edition This set of products enables you to develop custom functionality at any layer of the architecture: • To customize the presentation layer (the user interface), use WDK. You can use WDK to customize Webtop, or use its library of web components to create new web applications. The web components are installed into the directory user_directory\jboss4.2.0\server\DctmServer_MethodServer\deploy\webtop.war; the components are in the wdk and webcomponent subdirectories. See the Web Development Kit Development Guide for information. Caution: This directory is part of a deployed application. Do not move or delete that directory • To customize the business logic, use the DFC business object framework to define the processing logic and DFS to expose the logic by means of web services. See the EMC Documentum Foundation Classes Development Guide and the EMC Documentum Foundation Services Development Guide. The Enterprise Content Services Reference provides a list of the available standard web services. • To customize the data layer in the repository, use Composer to create repository objects and custom object types. You can also use Composer to create application DAR files that package your custom artifacts for installation into a new repository. See the EMC Documentum Composer User Guide. Uninstalling Content Server OEM Edition You can use one of two methods to uninstall Content Server OEM Edition: • Uninstall with the GUI. • Uninstall from the command line. This method is optional. To uninstall Content Server OEM Edition by using the GUI: Note: If you uninstall Content Server OEM Edition from the command line, it will preserve metadata, content files, and full-text indexing by default. If you uninstall by using the Uninstall wizard from the Start>Documentum menu, everything, including metadata, content files, and full-text indexing will be deleted. 1. From the Microsoft Windows Start menu, navigate to Programs>Documentum>Uninstall and click Uninstall to launch the uninstallation program. The uninstallation wizard starts. 2. Click Next. 3. On Microsoft Windows only, type the Windows 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. 5. On Microsoft Windows only, restart your system when prompted. 6. If Content Server OEM Edition is connected to an existing database, use Microsoft SQL Server tools to execute these SQL commands: For a Microsoft SQL Server database: 32 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Installing Content Server OEM Edition USE master DROP SCHEMA repository_name DROP DATABASE db_repository_name DROP USER repository_name For an Oracle database: DROP TABLESPACE dm_repository_name_docbase including contents; DROP TABLESPACE dm_repository_name_index including contents; DROP USER repository_name; To uninstall Content Server OEM Edition from the command line: Note: If you uninstall Content Server OEM Edition from the command line, it will preserve metadata, content files, and full-text indexing by default. If you uninstall by using the Uninstall wizard from the Start>Documentum menu, everything, including metadata, content files, and full-text indexing will be deleted. 1. Navigate to the directory program_dir\_uninst\_suite\, where program_dir is the program directory you specified on the command line during installation. 2. For Microsoft Windows, enter this command line: uninstall.exe -passwords windowsInstallOwner=password [-deleteMetadata] [-deleteContentFiles][-deleteFullTextIndex] [-silent] The three optional arguments behave as follows: • -deleteMetadata deletes metadata from the database tables, the database tables, the database files. If the Content Server OEM Edition installation program created the database, it removes the database and the Microsoft SQL Server Express software as well. Note: If there are metadata tables left behind by a previous uninstallation procedure, running the uninstallation program with this option will not remove those leftover tables, nor will it remove the RDBMS binaries or DFC. In such cases, if you want to remove the leftover metadata tables, you must do so manually. To remove the binaries, you must first remove the leftover metadata tables manually, then run the uninstallation program again with the -deleteMetadata option. • -deleteContentFiles removes the content files from the repository’s file stores. If you use the -deleteContentFiles argument, the repository must be running when the uninstallation program is invoked. • -deleteFullTextIndex removes the full-text index from the file system. For Linux, enter this command line: uninstall.sh [-deleteMetadata] [-deleteContentFiles][-deleteFullTextIndex] [-silent] The three optional arguments behave as follows: • -deleteMetadata deletes metadata from the database tables, the database tables, the database files. If the Content Server OEM Edition installation program created the database, it removes the database and the Microsoft SQL Server Express software as well. Note: If there are metadata tables left behind by a previous uninstallation procedure, running the uninstallation program with this option will not remove those leftover tables, nor will EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 33 Installing Content Server OEM Edition it remove the RDBMS binaries or DFC. In such cases, if you want to remove the leftover metadata tables, you must do so manually. To remove the binaries, you must first remove the leftover metadata tables manually, then run the uninstallation program again with the -deleteMetadata option. • -deleteContentFiles removes the content files from the repository’s file stores. If you use the -deleteContentFiles argument, the repository must be running when the uninstallation program is invoked. • -deleteFullTextIndex removes the full-text index from the file system. If the uninstallation program fails, a nonzero code is returned. 3. If Content Server OEM Edition is connected to an existing database, use Microsoft SQL Server tools to execute these SQL commands: For a Microsoft SQL Server database: USE master DROP SCHEMA repository_name DROP DATABASE db_repository_name DROP USER repository_name In these commands, repository_name is the repository name from the <docbase> element in the oemConfig.xml file. For an Oracle database: DROP TABLESPACE dm_repositoryName_docbase including contents; DROP TABLESPACE dm_repositoryName_index including contents; DROP USER repositoryName; 4. On Microsoft Windows, reboot the host machine. If you do not reboot, the uninstallation process will be incomplete. Any reinstallation will fail. 34 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Chapter 3 Creating a Custom Installation Package A key purpose of Content Server OEM Edition is to enable you to install a repository "behind the scenes” as part of a custom application. This chapter discusses how to create an application installation package that includes Content Server OEM Edition. It contains the following topics: • Replacing the Welcome page, page 35 • Creating an installation package for the command-line installation, page 35 • Creating the Content Server OEM Edition configuration file, page 36 • Removing Components from Content Server OEM Edition, page 39 • Removing sample data , page 40 Replacing the Welcome page The Content Server OEM Edition installation package for GUI installation comes with a sample Welcome page that you need to replace with your own before you install Content Server OEM Edition. The Welcome page launches after successful installation. To repackage the Content Server OEM Edition installation sample Welcome page with your own welcome page: 1. In the directory to which you installed the Content Server OEM Edition package, locate the WelcomePage_files.zip file. 2. Unzip the WelcomePage_files.zip file and replace it with your own version of WelcomePage.htm. Your file must be named WelcomePage.htm, and it must be located in the same directory as the sample file was. Creating an installation package for the command-line installation For the command-line installation, the installation program does not display a user interface for entering the necessary configuration parameters. Instead, the installation program retrieves the necessary parameters from a configuration file and from values passed on its command line. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 35 Creating a Custom Installation Package To install Content Server OEM Edition as part of your application, you create an installation program that installs your application and invokes the Content Server OEM Edition installation program, passing to it the necessary configuration parameters. To create an application installation package that installs Content Server OEM Edition: 1. Edit the Content Server OEM Edition configuration file and set values for the parameters with pre-established values. When you install Content Server OEM Edition as part of your application, the installation program retrieves its configuration parameters from a configuration file. You can edit the configuration file to hard-code the values for parameters that will be the same for all installations of your application. For example, add any DocApps or DAR files required by your application. SeeCreating the Content Server OEM Edition configuration file, page 36, for information about the required parameters and Configuration file format and parameters, page 37, for details about the file format and about the available optional configuration parameters. 2. Create the installation program for your application. You can write the application installation program in the programming language of your choice or you can use a package such as InstallShield. The application installation program needs to accomplish these tasks: • Validate that the host on which the application is being installed meets the requirements for your application and for Content Server OEM Edition; see Prepare the host machines, page 11. • Capture values for any Content Server OEM Edition configuration parameters that are not preset in the configuration file. It can ask the user to enter the values or derive them programmatically. Update the oemConfig.xml file with the values. • Invoke the Content Server OEM Edition installation program, as described in Installing Content Server OEM Edition from the command line, page 26. • Uninstall any of the Documentum web applications that you do not want to include as part of your application package; see Removing Components from Content Server OEM Edition, page 39. • Deploy any custom applications. The JBoss deployment directory is at userDir/jboss4.2.0/server/DctmServer_MethodServer/deploy and hot deployment is turned on. Copy an EAR or WAR file to that directory, and it gets deployed automatically. Refer to the JBoss 4.2.0 documentation for instructions on how to package your application. Refer to the EMC Documentum Web Development Kit and Webtop Deployment Guide for information on how to deploy WDK and Webtop applications. • Run any tasks required by your application, such as running scripts or jobs. 3. Package the application installation program for delivery to customers. Creating the Content Server OEM Edition configuration file When the Content Server OEM Edition installation program runs, it refers to an XML configuration file to retrieve values for a variety of configuration settings. The values in the configuration file 36 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Creating a Custom Installation Package configure Content Server OEM Edition, the index agent, the Java method server, and the repository. You can optionally install DocApps and DAR files in the repository by identifying the DocApps in the configuration file. When you do so, the installer "silently” invokes Documentum Application Installer (DAI) to deploy DocApps and Documentum Composer to deploy DAR files. Refer to the Documentum Application Builder and Documentum Composer documentation for information about DocApps and DAR files. You can edit the configuration file using a text editor and package it with the application installation program. Alternatively, the application installation program can capture the parameter values and create the file dynamically. In either case, the file must exist when the application installation program invokes the Content Server OEM Edition installation program. Configuration file format and parameters The names of the elements in this configuration file are case sensitive; you must specify them capitalized as shown in the format below. The configuration file is used to pass some parameters to the installation program. It may also be used to pass information about DocApps and DAR files to the installation program, to enable the installer to deploy those DocApps and DAR files. The format of the file with only the required parameters is: <dctmOemInstall version="1.0"> <database connectionIdentifier=”db_server_or_DSN_name” databaseAdminName="db_admin_name" useExistingServer="true_or_false /> <docbase name="repository_name"> </docbase> </dctmOemInstall> The format with optional parameters is: <dctmOemInstall version=”1.0”> <database connectionIdentifier=”db_server_or_DSN_name” databaseAdminName="db_admin_name" useExistingServer="true_or_false /> <docbroker port=”connection_broker_port” /> <docbase id="repository_id" name="repository_name" enableCollaborationServices="TRUE" collaborationServicesLicense=license_code enableRm="TRUE" rmLicense=license_code enableFrs="TRUE" frsLicense=license_code enablePrm="TRUE" prmLicense=license_code <emailNotification smtpHost=”host_name” installOwnerEmail=”install_owner_email"/> </docbase> <javaMethodServer httpPort=”JSM_http_port” /> <docApps> <docApp name="DocAppName"> <description>DocAppDescription</description> <archiveDir>PathtoArchive</archiveDir> <logDir>PathtoLogDirectory</logDir> </docApp> </docApps> <dars> <dar name="DARFileName"> <description>DARFileDescription</description> <darFile>PathtoDARFile</darFile> </dar> </dars> </dctmOemInstall> EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 37 Creating a Custom Installation Package Table 2. Content Server OEM Edition configuration file parameters Parameter Description Default database connectionIdentifier The database server instance name (for a new database) or the ODBC data source name (for an existing Microsoft SQL Server database) or the database connection identifier from the tnsnames.ora file (for an existing Oracle database). The database server instance name for a new database must be all capital letters. database databaseAdminName The user name of the database administrator. If the installation program is creating the database, the databaseAdminName must be set to "sa”. database useExistingServer Boolean specifying whether to use an existing database rather than creating one as part of the installation. False. The installation creates a new database docbroker port The port on which the connection broker listens 1489 docbase id A unique repository identification number. The value can be any number from 1 to 16777215, without a leading zero (0). Automatically generated ID. docbase name The repository name. The name must be no longer than 32 characters. It must consist of letters, numbers, and underscores (_), and the first character must be a letter. The repository name cannot include spaces or nonalphanumeric characters and all letters and numbers in the name must be ASCII characters. The repository name "docu” is reserved by EMC Documentum. None. This attribute is required. docbase enable{product_ code}="TRUE” {product_code}License Activates the software license for the corresponding optional component. The licenses are active by default. For each component you want to deactivate, set the enable{product_code} attribute to "TRUE” and provide the license key for that component (received from EMC) with the corresponding {product_code}License attribute. The optional components are: The software licenses are inactive. • RM (Records Manager) • FRS (Federation Records Services) • PRM (Physical Records Manager) emailNotification smtpHost 38 The name of the host where an SMTP server is running. Content Server OEM Edition uses this SMTP server to send email notifications. "localhost" EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Creating a Custom Installation Package Parameter Description Default emailNotification installOwnerEmail The address to which Content Server OEM Edition sends email notifications about system issues. The value is the installation owner’s email address. javaMethodServer httpPort The port on which the Java Method Server listens docApp Include a <docApp>...</docApp> section for each DocApp you want to deploy. docApp name The name of a DocApp that the installation program installs in the repository description The description the DocApp archiveDir The directory on the host where the DocApp is located logDir The directory on the host where the log for DocApp installation is located. You can identify any existing directory where the installation owner has write permission. The name of the log file is docAppName_installLog.html. dar Include a <dar>...</dar> section for each DAR file you want to deploy. dar name The name of a DAR file that the installation program installs in the repository description The description the DAR file darfile The directory on the host where the DAR file is located 9080 The default is the value of the <archiveDir> element. Removing Components from Content Server OEM Edition The Content Server OEM Edition installation program installs several web applications, shown in the table below. If you do not want to include one or more of these web applications when you install your application, you can remove them after running the Content Server OEM Edition installation program. Table 3. Web applications installed as part of Content Server OEM Edition Web application file Component da.war Documentum Administrator rpsa.war Retention Policy Services Administrator rps.war Web services interfaces for Retention Policy Services EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 39 Creating a Custom Installation Package Web application file Component webtop.war Webtop dfs.ear Documentum Foundation Services IndexAgent1.war Index agent (for full-text indexing) acs.ear Accelerated Content Services server ServerApps.ear Method server To remove one or more web applications: 1. Stop the Content Server OEM Edition server. 2. Navigate to the directory user_directory/jboss4.2.0/server/DctmServer_MethodServer/deploy. 3. Delete the directory corresponding to the web application you want to remove. 4. Restart the Content Server OEM Edition server. Removing sample data When you install Content Server OEM Edition, the package includes sample data, such as sample user accounts, custom object types, and sample documents that you can use in your development environment. If you will not use the included sample data, you can remove them with Documentum Administrator. Before you can remove sample data, you need user Documentum Administrator to make the sample users named barthur and bwhite inactive: To change a user form active to inactive: 1. Navigate to Administration > User Management > Users. 2. Select the user and then select View > Properties to access the User Properties - Info page. 3. Make the active user inactive by selecting Inactive from the State dropdown list. 4. Click OK. 40 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Chapter 4 Understanding the Content Server OEM Edition Repository Installing Content Server OEM Edition installs a content repository. This chapter describes the initial configuration of the repository. It also includes information about the basic administration tasks that you can perform. The chapter includes the following topics: • Configuring the repository, page 41 • Runtime log files, page 42 • Creating users and groups, page 42 • Configuring jobs, page 45 Configuring the repository This section describes the basic configuration of the repository and associated Content Server OEM Edition after the installation. Operating configuration The repository is typically configured with the following operating values: • A maximum of concurrent users it can accept. The number of users depends on the type of database to which the repository connects. • A maximum of a specified size of objects per hour it can index. This value depends on the type of database to which the repository connects. • A maximum of a specified size of objects it can store. This value depends on the type of database to which the repository connects. • Uses the ACL associated with a user as the default ACL for objects created by the user (dm_server_config.default_acl=3) • Enforces folder security (dm_docbase_config.folder_security = true) For an example of sizing and scaling values, refer to the DOCUMENTUM OEM EDITION WEBTOP 6.5SP1 WITH 25 ACTIVE USERS ON SQL SERVER EXPRESS 2005 white paper on the Powerlink web site ((http://powerlink.EMC.com). EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 41 Understanding the Content Server OEM Edition Repository After installation, it is possible to change the allowed number of concurrent users by setting the concurrent_session key in the Content Server’s server.ini file. Resetting that key requires restarting the server after the change to make the change effective. You cannot change the tuned values for indexing ingestion or maximum object storage in the repository. Global registry The repository is created as a global registry. For information about global registries, refer to the EMC Documentum Content Server Installation Guide and Repository and global registry, page 13. Administration jobs Configuring a repository installs the basic suite of administration jobs. The jobs are installed with default schedules. Some are installed in the active state and some in the inactive state. All the jobs that delete objects or files from the repository are installed in the inactive state. For instructions on resetting job schedules and activating or deactivating jobs, refer to Configuring jobs, page 45. Runtime log files The log files generated by Content Server OEM Edition at runtime are in the same location as those created by a Content Server Enterprise Edition. Refer to the standard Content Server documentation suite for full details. Creating users and groups After a repository is configured, it has a default set of users and groups. Those users and groups provide access for the installation owner, the repository owner, and for internal processes such as the Index Agent. Before other individuals within an enterprise can access the repository, the individuals must be added as users to the repository. Additionally, if the site wants to use groups to control access to objects, those groups must also be added to the repository. If a customer is planning to use an LDAP directory server to manage users and groups and for user authentication, they must create LDAP entries for each user and group, rather than creating the users and groups directly in the repository. An internal job, dm_LDAPSynchronization, will automatically propagate the user and group entries to the repository, and set the user_source and group_source attributes. 42 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Understanding the Content Server OEM Edition Repository Adding users to the repository You add users and groups to the repository using Documentum Administrator. To create a user account: 1. Start a web browser on a client machine. 2. Connect to the following URL, where host is the name of the host machine where Content Server OEM Edition is installed and appserver_port is the application server port on that host: http://host:portnumber/da/ or http://host:portnumber/rpsa/ 3. Type your login name and password. If you have not yet used Documentum Administrator to add users and groups to the repository, you must log in as the installation owner, using the installation owner’s Windows user name and password. 4. Click Login. 5. Navigate to Administration > User Management > Users. 6. Select File > New > User. The system displays the New User - Info page. 7. Click the ? in the upper right corner to display the online help for creating a new user. Using an LDAP directory server To use an LDAP directory server for authentication, the customer must create an ldap config object in the repository for the directory server. Typically, ldap config objects are created using Documentum Administrator. The user must have Superuser privileges in the repository to create an ldap config object. For information ldap config objects and their attributes, refer to the EMC Documentum Object Reference Manual. For information about implementing use of an LDAP directory server, refer to the EMC Documentum Content Server Administration Guide. The user and group entries in the LDAP directory server must include LDAP attribute values that map to the required attributes of users and groups. The mappings between LDAP attributes and user or group attributes are defined in the ldap config object that represents an LDAP directory server in the repository. Required and recommended attributes for users Table 4, page 44, lists the attributes that are required and those that are recommended for users. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 43 Understanding the Content Server OEM Edition Repository Table 4. Required and recommended user attributes Attribute Description Required or recommended user_name Content Server OEM Edition user name. This can be an individual user or a group name. It must be unique among the user and group names in the repository. Required The name must consist of characters compatible with the server_os_codepage of the Content Server OEM Edition. user_login_name Name used to authenticate the user. Required The combination of user_login_name and user_login_domain must be unique in the repository. user_address User’s electronic mail address. Required user_source Indicates how the user is authenticated This is not required. However, the default is OS. If the user is authenticated through LDAP, the attribute is set automatically to LDAP by the dm_LDAP ynchronization job. default_cabinet Identifies the user’s default folder. This is where objects created by the user are stored unless the user explicitly designates another location. This is not required. The default is Temp. For a complete listing of user attributes, refer to the EMC Documentum Object Reference manual. Required and optional attributes for groups Table 5, page 45, lists the attributes that are required and those that are recommended for groups. 44 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Understanding the Content Server OEM Edition Repository Table 5. Required and optional group attributes Attribute Description Required or recommended group_name Content Server OEM Edition user name. This can be an individual user or a group name. It must be unique among the user and group names in the repository. Required The name must consist of characters compatible with the server_os_codepage of the Content Server OEM Edition. group_source Identifies the source of the group. The only valid value is LDAP, meaning the group was created by importing an LDAP group. This is automatically set to LDAP if the group is managed by an LDAP directory server. Configuring jobs Configuring a repository automatically installs a suite of administration jobs. These jobs are installed with default schedules and many, including all those that delete objects from the repository, are installed in the inactive state. For list of the installed administration jobs, refer to the Tools and Tracing chapter of the EMC Documentum Content Server Administration Guide. The reference material in that chapter describes each job, its arguments, and its default settings, as well as whether it is installed inactive or active. You may choose to activate or deactivate one or more jobs while installing the embedding application. You may also choose to reset a job’s schedule. Both of these operations can be performed by setting the appropriate attributes for a job. You may also decide to provide a way for the customer to activate and deactivate jobs and reset schedules. Setting job schedules Job schedules are controlled by several attributes. If you are not using Documentum Administrator to set job schedules, then you must set the attributes directly. The attributes that control a job schedule are: • start_date • a_next_invocation EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 45 Understanding the Content Server OEM Edition Repository • run_mode • run_interval The starting date is the earliest date at which the job can be executed. The a_next_invocation property defines the first (or next) scheduled execution of the job. When you set the job’s schedule, set start_date and a_next_invocation to the same value. Thereafter, when the job runs, a_next_invocation is automatically reset to the next invocation time. However, for the first run of the job, the value in a_next_invocation must match the value in start_date. The run_mode and run_interval values work in conjunction to define how often the job is run after its first execution. The run_mode attribute defines a unit of measure. The integer value you specify in the run_interval attribute is interpreted according to the unit of measure you specify in the run_mode attribute. For example, if you set the run_mode to 2, meaning delay in Hours, and run_interval to 12, the job is executed every 12 hours. If you set run_mode to 4, meaning day of Week, and run_interval to 7, the job is run every 7th day of the week. For more information about scheduling jobs, refer to the EMC Documentum Content Server Administration Guide. For a full list of job attributes, refer to the EMC Documentum Object Reference. Activating and deactivating jobs Whether a job is active or inactive is controlled by the is_inactive attribute of the dm_job object. To change the active state of a job, set that attribute to the value representing the desired state. 46 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Chapter 5 Understanding Full-Text Indexing This chapter discusses the Content Server OEM Edition’s implementation of the Lucene full-text indexing software. The chapter contains the following topics: • Understanding indexing and the indexing software, page 47 • Words that are not indexed, page 48 • Punctuation, page 48 • Indexing numeric values, page 48 • Indexing NULL values, page 48 • Supported formats, page 49 • Supported languages, page 49 • Supported querying, page 49 • Comparing Lucene and FAST full-text indexing systems, page 49 • Internationalization, page 50 • Object type schema changes and full-text indexing, page 50 • Optimizing the index, page 51 • Tuning the result set batch size, page 52 • Objects and attributes supporting full-text indexing, page 52 • Indexing failures, page 53 • Log files and logging, page 53 Understanding indexing and the indexing software Installing Content Server OEM Edition installs an index agent and the Lucene full-text indexing engine and creates the full-text index. The full-text indexing process is described in the EMC Documentum Content Server Full-text Indexing System Deployment Guide. The Lucene software is the index server for Content Server OEM Edition. Content Server Enterprise Edition uses a FAST index server. EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 47 Understanding Full-Text Indexing The Lucene software consists of an indexer plug-in and a searcher servlet. The software runs in the same application server servlet container as the index agent. The Content Server OEM Edition’s role in indexing is the same as in Content Server Enterprise Edition. Certain operations generate queue items that are queued to the full-text indexing user. The index agent reads the queue items and creates a DFTXML representation of the object to be indexed. (DFTXML is an internal format used by the indexing system.) The DFTXML representation contains the metadata associated with the object and a pointer to the content being indexed. Lucene extracts the indexable content from the content file, then updates the index. Lucene indexes content synchronously. When the DFTXML representing an indexable object is submitted to Lucene by the index agent, the properties and content of the SysObject are added to the index immediately. Lucene can index objects that have multiple associated content files. However, clients cannot specify a query against a particular content of the object. All text extracted from all of the associated content files is indexed together, not discretely. Thesaurus searching is not supported. Term-hit highlighting is not supported. Words that are not indexed The following stop words are not indexed: a, an, and, are, as, at, be, but, by, for, if, in, into, is, it, no, not, of, on, s, such, t, that, the, their, then, there, these, they, this, to, was, will, with The stop word list is not configurable. Punctuation Punctuation marks are not included in the index. The search process analyzes queries and removes punctuation marks, so that the indexed strings and the strings for which a query searches are identical. Indexing numeric values Numeric values are stored by Lucene using 16 decimal digits. Integers with a range of -21477483648 to 2147483647 are indexed. Double and floating-point numeric values have five digits of precision after the decimal point. For doubles and floating-point integers, precision past five digits is truncated. Indexing NULL values NULL values are indexed as follows by Lucene: • A NULL value for a numeric data type is stored in the index as a series of 16 zeros. • A NULL value for a date data type is stored in the index as the date 1753-01-01 00:00:00. 48 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Understanding Full-Text Indexing NULL values in string data types are not indexed. Supported formats The supported indexable formats are listed in the EMC Documentum Content Server Full-text Indexing System Deployment Guide. Supported languages In this release, English is the only supported language for full-text indexing of both content files and metadata. Supported querying Lucene supports the following queries: • The DQL SEARCH DOCUMENT CONTAINS clause • The following DQL WHERE clauses: — String data types =, !=, like — Boolean data types =, != — Integer, double, and date data types =, !=, <, >, <=, >= — id data types =, != — The FOLDER clause, including DESCEND — LIKE clauses, including wildcard support Comparing Lucene and FAST full-text indexing systems There are some differences in performance and scalability between the Lucene indexing system used by Content Server OEM Edition and the FAST indexing system used by Content Server Enterprise Edition, as shown in the following table: Table 6. Full-text indexing server comparison — Lucene and FAST Functionality Lucene index server FAST index server Scalability 3 million documents 20 million documents per node, 200 million maximum Ingestion rate 1.3 documents/sec.‘ 14 documents/sec EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 49 Understanding Full-Text Indexing Functionality Lucene index server FAST index server Format support Stellent 8.1.9 Stellent 8.1.9 VQL support No Yes XML support No Yes (VQL) Language support English only Most languages, including CJK Lemmatization No Yes High availability No Active/Active, Active/Passive (IS5) SAN/NAS support Unknown SAN, NAS in IS5 Thesaurus / synonym dictionary No Yes Support tools No Yes Administrative interfaces No Yes Platform support Windows/Linux All platforms FAST index server and Lucene index server handle certain full-text queries differently: • In the index server, SEARCH TOPIC is deprecated syntax that is supported for backward compatibility. SEARCH TOPIC is not supported by Lucene. SEARCH TOPIC clauses must be removed from queries. • Lucene does not support zone searching. • Lucene does not support chunked XML documents. • Lucene wild card searches do not return matches when there is a space in the result. For example, this query returns matches on FAST but not on Lucene because of the wild card in the search document contains clause: SELECT object_name FROM dm_document SEARCH DOCUMENT CONTAINS 'Installing%SCS' WHERE object_name LIKE 'FTDQL_FORMAT-12345' AND a_content_type='mif' Internationalization The index is stored in the UTF-8 encoding. Object type schema changes and full-text indexing You do not have to reindex the repository following a change to the object type hierarchy. Object types may be added or dropped and attributes added or dropped without any need to reindex. 50 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Understanding Full-Text Indexing Optimizing the index Documentum provides the dm_FTOptimizeIndex job for optimizing the index. The optimization process merges all existing file segments into a new segment and removes index entries that are marked for deletion. This results in a more compact index and faster search speed. However, optimizing the index does not increase the indexing speed or reduce the disk space usage. The time required to optimize the index varies directly with the size of the index. Optimizing regularly, for example, once a week, is useful, but you or your customers will determine the exact schedule. During the optimization process, the disk space usage of the index approximately doubles. However, the resulting index is not twice the size of the original index, nor is it significantly smaller. Before running the optimization job, ensure that there is sufficient free disk space on the drive. The job takes standard arguments and the path to the index. For example: collection_path=C:\Documentum\data\fulltext\lucene\IndexAgent1\index Shut down the index agent before running the job. If you run the optimization job while the index agent is running, the index is not optimized and the job report indicates that the index agent servlet was running and must be shut down. If the job is running, the index agent servlet cannot be started. This is a sample job report showing that the job ran successfully: FTOptimizeIndex Report For DocBase testenv.testenv As Of 2006/05/24 23:01:17 --------------------------------------FTOptimizeIndex Job Arguments: (StandardJobArgs: docbase_name=testenv.testenv userName=test1 jobId=0800019f8000550d methodTraceLevel=0) collection_path=C:\Documentum\data\fulltext\lucene\IndexAgent1\index --------------------------------------The index at C:\Documentum\data\fulltext\lucene\IndexAgent1\index was successfully optimized. Report End 2006/05/24 23:01:17 This is a sample job report showing that the index agent was running: FTOptimizeIndex Report For DocBase testenv.testenv As Of 2006/05/25 16:55:25 --------------------------------------FTOptimizeIndex Job Arguments: (StandardJobArgs: docbase_name=testenv.testenv userName=test1 jobId=0800019f8000550d methodTraceLevel=0) collection_path=C:\Documentum\data\fulltext\lucene\IndexAgent1\index --------------------------------------The index at C:\Documentum\data\fulltext\lucene\IndexAgent1\index is currently locked. Please shutdown the indexagent servlet and retry. Report End 2006/05/25 16:55:28 This is a sample job report showing that the collection_path argument was invalid or the index did not exist: FTOptimizeIndex Report For DocBase testenv.testenv As Of 2006/05/25 17:00:59 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 51 Understanding Full-Text Indexing --------------------------------------FTOptimizeIndex Job Arguments: (StandardJobArgs: docbase_name=testenv.testenv userName=test1 jobId=0800019f8000550d methodTraceLevel=0) collection_path=C:\Documentum\index --------------------------------------The index does not exist at collection path C:\Documentum\index Report End 2006/05/25 17:01:02 Tuning the result set batch size You can tune the size of the results set returned by the searcher for queries by setting the result_batch_size attribute in the ft engine config object. This affects all queries, both FTDQL and non-FTDQL. The default value for this attribute is 1000. Changing the value is desirable under some circumstances. Increase the value if: • You expect more non-FTDQL queries than FTDQL queries, or • You expect more queries with the NOFTDQL hint applied than queries with the FTDQL hint applied, or • Users are typically interested in browsing more results than the current value of the attribute. Decrease the value if: • You expect more FTDQL-compliant queries than non-FTDQL queries, or • You expect more queries with the FTDQL hint applied than queries with the NOFTDQL hint applied, or • Users are typically interested in browsing fewer results than the current value of the attribute. Objects and attributes supporting full-text indexing The same objects and attributes support full-text indexing in the Content Server OEM Edition as in Content Server Enterprise Edition. Note the following: • A location object named lucene refers to the directory where the dmfulltext.ini file is located. • The dmfulltext.ini file contains the name and path of the Lucene query plugin. • The ft engine config object representing the Lucene software is named "LUCENE Fulltext Engine Configuration.” • In the full-text index object, the install_loc attribute is set to the value lucene and the ft_engine_id attribute is set to the object ID of the ft engine config object. • The fulltext_location attribute of the server config object is set to the value lucene. • The fulltext_install_locs attribute of the docbase config object is set to the value lucene. 52 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Understanding Full-Text Indexing Indexing failures Information on indexing failures is recorded in log files and in the task_state property of the queue item. Refer to the EMC Documentum Content Server Administration Guide for information on how the index agent handles queue items. Use Documentum Administrator to resubmit objects for indexing. Log files and logging The log files for full-text indexing are located in program_directory\jboss4.2.0\server\DctmServer_ MethodServer\logs. The log file name is IndexAgentN.log where N is the number corresponding to the index agent number. (The first index agent is IndexAgent1, for example.) The following priority levels determine how much information is recorded in the log: • fatal records errors when the index cannot be opened, the index is corrupted, or other failures are preventing any indexing from taking place. • error records errors when an object fails indexing, and includes the reason for the failure and the object ID of the failed object. This is the default logging level. • warn records errors when a content file fails indexing but the metadata is indexed successfully. The reasons for the content failure and the object ID are logged. • info records all terms associated with failed object that is logged. • debug records execution trace messages and information about indexing operations, such as segment merges. Each logging level includes messages at its own level, plus all higher-level messages. The warn level also records error and fatal messages. The debug level records all possible information. The levels apply to both indexing and searching. The priority level of the logged messages is determined by a setting in the program_directory\jboss4.2. 0\server\DctmServer_MethodServer\deploy\IndexAgentN.war\WEB-INF\classes\log4j.properties file, where N is a number corresponding to the index agent number. To change the priority level, change the following entry: #Control logging level using line below for the IndexAgent. log4j.category.com.documentum=INFO Valid values for this entry are DEBUG, INFO, WARN, ERROR, and FATAL. Log files are time-stamped when the application server process is restarted. The Log Purge job cleans up old log files. Tracing related to indexing and searching generated by the index agent and Content Server OEM Edition operates the same as for the enterprise indexing system. Tracing generated by the Lucene query plugin is enabled by the MODIFY_TRACE administration method. The syntax is: apply,c,NULL,MODIFY_TRACE,SUBSYSTEM,S,fulltext,VALUE,S,all To disable tracing: apply,c,NULL,MODIFY_TRACE,SUBSYSTEM,S,fulltext,VALUE,S,none EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 53 Understanding Full-Text Indexing Trace messages are recorded in the fttrace_repositoryname.log file, where repositoryname is the name of the repository in which tracing is enabled. The log file is found in the $DOCUMENTUM/dba/log/fulltext directory. To disable tracing, turn off the MODIFY_TRACE apply method by setting VALUE to none. Trace messages in the log are time stamped with process ID information, and include HTTP connection information, HTTP request and response strings, the results returned from the full-text index, and information about how queries are translated from DQL by the query plugin. 54 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide Index A E administration jobs, configuration, 42 embedding installer recommendations and requirements, 36 C code page used by Lucene, 50 command-line installation configuration file, 26 configuration file for command-line installation, described, 26 configuration file for silent installer, described, 36 Content Server runtime log files, 42 Content Server OEM Edition Lucene software and, 47 starting/stopping all components, 30 Content Server, OEM Edition. See Documentum Content Server OEM Edition D database Oracle, 15 databases Windows requirements, 14 dm_FTOptimizeIndex job, 51 docbase config object fulltext_install_locs attribute setting, 52 Documentum Content Server OEM Edition, overview overview, 7 Documentum repository administration jobs, 42 as global registry, 42 configuration, default, 41 DQL queries supported by Lucene, 49 F files tnsnames.ora, 15 ft engine config object for Lucene, 52 full-text index encoding, 50 optimzing, 51 full-text indexes DQL queries, supported, 49 full-text indexing failures, troubleshooting, 53 file formats supported, 49 languages supported, 49 log files, 53 log files, removal, 53 logging levels, 53 NULL values, 48 numberic values, 48 object type hierarchy changes and, 50 overview, 47 punctuation, 48 query result batch size, tuning, 52 term-hit highlighting, 48 thesaurus searching, 48 unindexed words, 48 full-text querying differences from enterprise querying, 50 fulltext index object ft_engine_id attribute setting, 52 install_loc attribute setting, 52 G global registry, 42 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide 55 Index network locations, 13 SBOs, 13 groups creating, 42 LDAP Directory Server and, 43 required attributes, 44 I installation update installation, 28 installation owner case-sensitivity of username, 18 to 19, 21, 27 installing from command line introduction to, 35 installing, Sybase, 19 J jobs activating/deactivating, 46 configuration of, 45 dm_FTOptimizeIndex, 51 scheduling, 45 jobs, administration, 42 L LDAP directory server, use of, 42 location object lucene, 52 log files Content Server, 42 Lucene ft engine config object, 52 query plugin location, 52 lucene location object, 52 Lucene software components, 48 M Microsoft SQL Server ODBC configuration, 14 N network location objects, 13 NULL values in full-text indexes, 48 numeric values in full-text indexes, 48 O object type hierarchy affect of change on full-text index, 50 ODBC configuration, 14 Oracle database, 15 database aliases, 15 TNS aliases, 15 tnsnames.ora file, 15 P punctuation in f ull-text indexes, 48 R repositories global registry, 13 job activation/deactivation, 46 job scheduling, 45 users and groups, creating, 42 result_batch_size attribute, 52 S server config object fulltext_location attribute setting, 52 silent installer configuration file, 36 stop word list, 48 T term-hit highlighting, 48 thesaurus searching, 48 tnsnames.ora file, 15 U uninstalling from command line introduced, 32 updating an installation, 28 users creating, 42 LDAP Directory Server and, 43 required and recommended attributes, 43 W words not indexed, 48 56 EMC Documentum Content Server OEM Edition Version 6.5 SP2 Installation and Configuration Guide