EMC Documentum CenterStage

Transcription

1 EMC Documentum CenterStage Version 1.2 Installation Guide EMC Corporation Corporate Headquarters: Hopkinton, MA

2 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. Copyright 2012 EMC Corporation. All rights reserved.

3 Table of Contents Preface... 9 Chapter 1 Overview CenterStage system components Content Server Composer Documentum Administrator Transformation Services Federated Search Services Content Intelligence Services Full-text Indexing Application server CenterStage CenterStage DARs CenterStage WAR CenterStage EAR Planning the deployment Chapter 2 Preparation Installation requirements Use fully qualified domain names Secure Sockets Layer (SSL) Review troubleshooting notes Chapter 3 Deploying the CenterStage System Deploying Content Server Deploying Content Transformation Services Deploying Federated Search Services Configuring the connection to the search server Configuring the connection to the backup search server Installing Federated Search Services (FS2) Indexer for shared drives Deploying Full-text Indexing Services Deploying Content Intelligence Services (CIS) Deploying Composer Deploying the application server WebSphere Replace missing class in WebSphere Modify the web.xml file Configure Java options for WebSphere Enable webcontainer filter compatibility JBoss Tomcat Oracle Servers (WebLogic) Deploying CenterStage EMC Documentum CenterStage 1.2 Installation Guide 3

4 Table of Contents Deploying CenterStage DAR files Installing a DAR file with the DAR Installer Deploying CenterStage DARs using an Ant Task Customizing the product name in the application URL Deploying CenterStage WAR files Deploying CenterStage EAR files Deploying the EAR file to Oracle WebLogic Preparing the EAR file Updating the server JDK Installing the EAR file Deploying the EAR file to IBM WebSphere x Installing xplore Security and external access Installing CenterStage with a proxy server Branch office Central office Chapter 4 Upgrading CenterStage Backing up app.xml Backing up custom configuration files Reinstalling custom DARs Upgrading from CenterStage 1.x to CenterStage Running UpgradeCenterStage1_ Upgrading folder permissions from 1.1 to Chapter 5 Configuration Update paths for log4j appender Access Documentum Administrator Set up CenterStage indexes Create a user in the repository Enable notification for subscribed content Assign members to the dce_room_creator role Assign members to the dmc_kw_manage_space_templates role Configure the administrator address Configure the embedded Content Server for SMTP Configure Retention Policy Services (optional) Access CenterStage Create a space Configure the content policy for each space Installing DARs with a localized data dictionary Populating a localized CenterStage data dictionary Configuring high-availability Linux random number daemon configuration Configuring CenterStage to enable Kerberos authentication Configuring CenterStage for RSA authentication Configuring RSA Access Manager Web Agent to use an authorization dialog Configuring CenterStage for Netegrity authentication Configuring single sign-on with a reverse proxy server EMC Documentum CenterStage 1.2 Installation Guide

5 Table of Contents Chapter 6 Troubleshooting Disable the Windows 2008 firewall on user machines Troubleshooting CIS Validate the installation of cis_artifacts.dar Verify the required table has been created Test the entity extraction Configuring WebLogic security Optimizing performance Performance settings for Oracle repository Performance settings for MS SQL repository Delay when installing with existing DCS data tables Appendix A Test file for CIS entity extraction: EuropeanUnion.doc Appendix B Configuring HTTP compression Configuring HTTP compression on the web server Enabling HTTP compression on the Apache web server Enabling HTTP compression on the Apache Tomcat server Enabling HTTP compression on the RedHat JBoss server Enabling compression on the Oracle WebLogic server Enabling compression on the IBM WebSphere 7 application server EMC Documentum CenterStage 1.2 Installation Guide 5

6 Table of Contents List of Figures Figure 1. Branch Office configuration Figure 2. LAN settings Figure 3. BOCS configuration Figure 4. Documentum Administrator BOCS configuration settings Figure 5. HTTP Post method with BOCS read operation Figure 6. Central Office Figure 7. Proxy directives Figure 8. DMS proxy directives Figure 9. BOCS acs.properties definition Figure 10. Proxy URL setting in dms.properties Figure 11. ACS write operation Figure 12. Reverse proxy access log Figure 13. Example code snippet from the authentication element in app.xml Figure 14. sso_config element in app.xml for RSA authentication Figure 15. sso_config element in app.xml for Netegrity authentication EMC Documentum CenterStage 1.2 Installation Guide

7 Table of Contents List of Tables Table 1. DAR installer fields Table 2. Directories containing shared object files EMC Documentum CenterStage 1.2 Installation Guide 7

8 Table of Contents 8 EMC Documentum CenterStage 1.2 Installation Guide

9 Preface This manual describes how to install CenterStage. For information about known issues and limitations, refer to CenterStage Release Notes. For information about using CenterStage, refer to the online help. Intended audience This manual is for system administrators, developers, and evaluators who are installing or upgrading the CenterStage application. Revision history The following changes have been made to this document. Revision Date March 2011 September 2012 Description Initial publication Added a new Appendix chapter called "Configuring HTTP compression. EMC Documentum CenterStage 1.2 Installation Guide 9

10 Preface 10 EMC Documentum CenterStage 1.2 Installation Guide

11 Overview Chapter 1 This guide provides instructions for installing CenterStage application files. It is also an umbrella document that provides references to the specific documentation for the applications that comprise the CenterStage system. The goal is to gather much of the information required to install and configure the system in a convenient format. CenterStage system components This section provides brief descriptions of the applications that comprise the CenterStage system. Content Server Content Server provides basic content management functionality, including check out, check in, and version control capabilities. For more information on Content Server, see the Content Server Installation Guide, Chapter 1, Planning for Content Server Installation. Composer Documentum Composer is used to deploy the Documentum Archives (DARs) that provide supporting services and the CenterStage application files. For more information on Documentum Composer, see Documentum Composer Release Notes, Chapter 1, Product Description. Documentum Administrator Documentum Administrator can be used to create users and assign them permissions necessary to create CenterStage spaces and perform other privileged activities. For more information on Documentum Administrator, see the Documentum Administrator User Guide. EMC Documentum CenterStage 1.2 Installation Guide 11

12 Overview Transformation Services Thumbnail Generator creates single page thumbnails (300x300 pixels in size) for images, PDF, and Office documents. The generated thumbnails are used in various parts of the application to provide previews of content. CenterStage provides inline viewers that display the first page of a document with thumbnail generator. CenterStage can provide full document viewing capabilities after an upgrade to MTS (Media Transformation Services)/ADTS (Advanced Document Transformation Services). For more information, see Content Transformation Services for CenterStage Installation and Configuration Guide, About Content Transformation Services Products. Federated Search Services Federated Search Services (FS2) lets users search across multiple sources and aggregate the results of those searches. CenterStage also provides search adapters for Documentum ECM; eroom; ApplicationXtender; Xtender; ODBC/JDBC; Google.com; Google Desktop Enterprise; OpenDirectory; Yahoo Directory; OpenSearch; Wikipedia; Windows Search; and FS2 Indexer. Additional add-on adapters can be purchased separately. For more information on Federated Search Services, see Federated Search Services Installation Guide, Chapter 1, Preinstallation Tasks. Content Intelligence Services Content Intelligence Services (CIS) uses data mining for extraction of company names, locations, and people. Cartridges provide definitions for particular extraction domains (for example, locations). When users search for a particular location, the cartridge enables the search to infer the country, state, county, city, etc. This provides more reliable search results, even if the criteria entered are not precise matches. For more information on Content Intelligence Services, see Content Intelligence Services Installation Guide, Introduction. Full-text Indexing Full-text indexing enables rapid search on all text in the CenterStage repository. Full-text indexing options are described in the Documentum Content Server Full-Text Indexing Deployment Guide. 12 EMC Documentum CenterStage 1.2 Installation Guide

13 Overview Application server The application server is part of the operating environment for CenterStage. It is a third-party web server such as Apache Tomcat or Red Hat JBoss that enables access to the CenterStage application through a web browser. CenterStage The CenterStage application itself is deployed as Documentum Archives (DARs) to the repository, and Web Archives (WARs) or Enterprise Archives (EARs) to the application server. CenterStage DARs CenterStage DARs are deployed on the Content Server repository and contain the business logic for CenterStage. Certain DARs must also be installed on the Global repository. For DAR file instructions, see Deploying CenterStage DAR files, page 22. CenterStage WAR The CenterStage WAR file is deployed on the application server and provides the UI elements for the web application. Deploy the WAR on the following application servers: Apache Tomcat Oracle Application Server Oracle WebLogic Server 10g R3( ) Red Hat JBoss For WAR file instructions, see Deploying CenterStage WAR files, page 26. CenterStage EAR The CenterStage EAR file is deployed on the application server and provides the UI elements for the web application. Deploy the EAR file on the following application servers: IBM WebSphere x Oracle WebLogic Server (11g R1) For EAR file instructions, see Deploying CenterStage EAR files, page 26. EMC Documentum CenterStage 1.2 Installation Guide 13

14 Overview Planning the deployment CenterStage runs on a standard Documentum Content Server system. The performance and sizing considerations for CenterStage are described in the CenterStage System Planning Guide. 14 EMC Documentum CenterStage 1.2 Installation Guide

15 Preparation Chapter 2 CenterStage provides the primary user interfaces for cross-department and/or company collaboration, and data sharing through communities, spaces, wikis, blogs, data tables, and RSS feeds. CenterStage is deployed into an application server instance and accessed by end users through a browser. CenterStage runs in a multiple-host environment to ensure optimal performance. In this scenario, CenterStage is deployed by installing Documentum Archive (DAR) files on an existing Content Server instance (or one created specifically to host CenterStage). This chapter gives pre-installation information and describes pre-installation tasks. For an overview of the CenterStage system and in-depth discussion of how to plan your deployment, see the CenterStage System Planning Guide. For complete system requirements, see the chapter Environment and System Requirements in CenterStage Release Notes. Installation requirements Your installation must follow these requirements: The name of the machine on which to install the software must begin with an alphabetic character. If the NetBIOS name of the machine begins with a numeric instead of an alphabetic character, the installation will fail. The physical or virtual server used for the installation must be dedicated to the CenterStage application. An SMTP server must be installed and available before you install CenterStage. The SMTP server can be on the CenterStage host or a remote host. After the installation procedure, you must use Documentum Administrator to configure CenterStage to use the name or IP address of the computer hosting the SMTP server so that CenterStage can connect to it. Use fully qualified domain names DNS lookups can be quite costly in terms of performance. To avoid lengthy lookups, use fully qualified path names when configuring the CenterStage server. EMC Documentum CenterStage 1.2 Installation Guide 15

16 Preparation Secure Sockets Layer (SSL) By default, SSL is not enabled in CenterStage. Over HTTP, passwords are sent in clear text when SSL is not enabled. EMC recommends that customers enable SSL to provide secure transmission of sensitive data such as authentication credentials. For more information, see the EMC Documentum Documentum Administrator User Guide, Managing User Authentication. Review troubleshooting notes Before you install, review Chapter 6, Troubleshooting. 16 EMC Documentum CenterStage 1.2 Installation Guide

17 Chapter 3 Deploying the CenterStage System This section of the manual provides references to the specific manuals for installing each element in the CenterStage system, with commentary on any special considerations when you are installing the product to work well with CenterStage. Deploying Content Server To install Content Server, follow the instructions in Content Server Installation Guide, Chapter 1, Planning for Content Server Installation. Deploying Content Transformation Services Thumbnail Generator is used to create thumbnail views of documents in CenterStage. CenterStage is also compatible with Media Transformation Services and Advanced Document Transformation Services for enhanced capabilities. To install Content Transformation Services, see the Content Transformation Services for CenterStage Installation and Configuration Guide. Deploying Federated Search Services To deploy Federated Search Services (FS2), follow the instructions starting with Federated Search Services Installation Guide, Chapter 1, Preinstallation Tasks. To allow users to search external sources, an administrator must configure a connection to a Federated Search server. EMC Documentum CenterStage 1.2 Installation Guide 17

18 Deploying the CenterStage System Configuring the connection to the search server The following procedure describes how to enable the Federated Search server to query external sources. The Federated Search documentation provides more information about how to configure the Federated Search server itself. To configure the connection to a Federated Search server: 1. Unpack the client application WAR file. 2. Open the file dfc.properties in WEB-INF/classes. 3. Enable the Federated Search server by setting the following: dfc.search.ecis.enable=true 4. Specify the RMI Registry host for the Federated Search server by setting the following: dfc.search.ecis.host=host_ip dfc.search.ecis.port=port Where host_ip is IP address or machine name of the Federated Search server port is the port number that accesses the Federated Search server. The default port is Configuring the connection to the backup search server You can set a backup server in case the primary Federated Search server is unreachable. If a DFC application cannot connect to the primary Federated Search server to query external sources, the backup server is used. You can define the time period after which the application will try to connect again to the primary server. To define the backup server, specify the RMI host and port in the dfc.properties file: dfc.search.external_sources.backup.host : host of the backup Federated Search server. Default value is localhost dfc.search.external_sources.backup.port : port of the backup Federated Search server. Default value is dfc.search.external_sources.retry.period : waiting period before retrying to connect to the primary Federated Search server. This time is in milliseconds. Default value is Installing Federated Search Services (FS2) Indexer for shared drives To index and search shared (network) drives as part of the federated search experience in CenterStage, you must install FS2 Indexer. The installation files for this option are available in the Download Center under the FS2 product line, as part of the archive file for Windows operating systems. The installation procedure is described in the Federated Search Services Installation Guide. 18 EMC Documentum CenterStage 1.2 Installation Guide

19 Deploying the CenterStage System Deploying Full-text Indexing Services EMC Documentum recommends that you use xplore full-text indexing services for improved performance. If you choose to do so, you need to install xplore after you deploy CenterStage. See Installing xplore, page 27 for more information. If you choose to deploy Documentum Content Server Full-text Indexing Services (FAST), the installation should take place at this point in the stack. Follow the instructions in the Full-Text Indexing System Installation and Administration Guide, Chapter 2, Prepare for Installation. Deploying Content Intelligence Services (CIS) To deploy Content Intelligence Services, follow the instructions in the Content Intelligence Services Installation Guide. Deploying Composer To deploy Documentum Composer, follow the instructions in the Documentum Composer Release Notes, Chapter 9, Installation. Deploying the application server Follow the instructions provided by the vendor of your supported application server of choice. After deploying the application server, you need to update the dfc.properties file to access the repository. To update the dfc.properties file for your application server: 1. Unpack the client application WAR (or EAR) file. 2. Open the file dfc.properties in WEB-INF/classes. 3. Enter the correct values for the following properties: dfc.docbroker.host[0] dfc.docbroker.port[0] dfc.globalregistry.repository dfc.globalregistry.username dfc.globalregistry.password 4. Save the dfc.properties file. 5. Restart the application server. EMC Documentum CenterStage 1.2 Installation Guide 19

20 Deploying the CenterStage System The sections that follow provide specific installation and configuration information for supported application servers. WebSphere IBM WebSphere is a third-party product. For installation information, visit the IBM web site. At the time this guide is being written, the correct link to product documentation is For information on load balancing for IBM WebSphere, see docview.wss?rs=180&uid=swg After installing WebSphere, you deploy CenterStage as follows: 1. Replace missing class in WebSphere, page Modify the web.xml file, page Configure Java options for WebSphere, page Enable webcontainer filter compatibility, page Deploy the EAR file Replace missing class in WebSphere Due to an incompatibility in the bundled JAR files in WebSphere version , users may encounter parsing errors when saving page objects. To prevent these errors, perform the following workaround before deploying the CenterStage application: 1. Obtain a copy of xalan.jar, as follows: 2. Go to the JAXP website: &expandfolder=4584&folderID= From the JAXP 1.3.x directory, download JAXP Stand-alone. 4. After downloading, run java -cp JAXP_RI_ , which unpacks JAXP into./jaxp_ri_ Locate the xalan.jar file in the JAXP_RI_ directory after extraction. 6. Copy xalan.jar to <CenterstagePro.ear>\APP-INF\libif. 7. Clear the application server cache. 8. Restart the server. Modify the web.xml file The web.xml file as shipped: 20 EMC Documentum CenterStage 1.2 Installation Guide

21 Deploying the CenterStage System <web-app xmlns:j2ee=" xmlns:xsi=" xsi:schemalocation=" The web.xml file updated for WebSphere application server (changes in bold text): <web-app xmlns:j2ee=" xmlns:xsi=" xsi:schemalocation=" metadata-complete="true"> Configure Java options for WebSphere IBM WebSphere does not recognize the JAVA_OPTS variable used by CenterStage for application server configuration. Three variables need to be set using the WebSphere Administration Console. To configure Java options for WebSphere: 1. Open the WebSphere Administration Console. 2. Navigate to Java Virtual Machine Custom Properties panel. For example, Application servers > server_name > Process definition > Java Virtual Machine > Custom Properties 3. Click New. 4. Set the name of the new property to javax.xml.stream.xmlinputfactory. 5. Set the value of the new property to com.sun.xml.stream.zephyrparserfactory 6. Click OK. Enable webcontainer filter compatibility This is a workaround for a known bug in the WebSphere server. To specify the Web container custom property: 1. In the administrative console choose Servers > Application Servers > server_name > Web Container settings > Web Container 2. Under Additional Properties select Custom Properties. 3. On the Custom Properties page, click New. 4. On the settings page, enter the name of the custom property: "com.ibm.ws.webcontainer. invokefilterscompatibility" 5. Set the value of the property to true. 6. Click Apply or OK. 7. Click Save on the console task bar to save your configuration changes. 8. Restart the server. EMC Documentum CenterStage 1.2 Installation Guide 21

22 Deploying the CenterStage System JBoss Red Hat JBoss is a third-party product. For installation information, visit the Red Hat web site. At the time this guide is being written, the link to the installation guide is For an example of load balancing for Red Hat JBoss, see Tomcat Apache Tomcat is an open source product. For installation information, visit the Apache Software Foundation web site. At the time this guide is being written, the link to the setup instructions is For a discussion of load balancing for Apache Tomcat, see generic_howto/loadbalancers.html. Oracle Servers (WebLogic) CenterStage supports third-party application servers from Oracle. You can find documentation for all Oracle products on the Oracle Technology Network website at Deploying CenterStage After completing the tasks outlined in Deploying the application server, page 19, continue with your CenterStage deployment by following these instructions: Deploying CenterStage DAR files, page 22 Deploying CenterStage WAR files, page 26 Deploying CenterStage EAR files, page 26 Deploying CenterStage DAR files When deploying CenterStage, you deploy discrete elements of the application on two or more servers. This chapter covers the specific steps for deploying Documentum Archive (DAR) files to the repositories required for CenterStage. The following DARs need to be installed in the order listed: Collaboration Services.dar DCS Attachments.dar CenterStage.dar 22 EMC Documentum CenterStage 1.2 Installation Guide

23 Deploying the CenterStage System CenterStagePro.dar CenterStageDatatable.dar CenterStageTemplates.dar Extended_Search-Clustering.dar Rich_Media_Services.dar Transformation.dar cis_artifacts.dar Install all DAR files on the global repository and any working CenterStage repository. DARs can be deployed using any of the methods described in the Documentum Composer User Guide. For convenience, the following are specific examples for deploying the necessary DARs for CenterStage. Two options are available for deploying DAR files: Installing a DAR file with the DAR Installer, page 23 (recommended) Deploying CenterStage DARs using an Ant Task, page 25 Installing a DAR file with the DAR Installer You can use the DAR Installer to install the CenterStage DAR files to a repository if you do not want to use the interface within Composer. The DAR Installer requires Composer to be installed, but does not launch the full Composer IDE. When you open the DAR Installer, it creates three folders in your Composer installation directory: darinstallerconfig contains configuration files for the DAR Installer Plugin darinstallerlogs the default location of the log files darinstallerworkspaces workspaces that are created and used by the DAR Installer Plugin. The DAR Installer Plugin does not delete these workspaces automatically after installation of the DAR file. The workspace directories are named in the following form: darinstaller_workspace_yyyy-mm-dd-hh-mm-ss. Moving, deleting, or adding projects manually to the workspace might have adverse effects on DAR installations. The DAR Installer requires you to fill in certain values that are marked with an asterisk (*). All other fields are optional. For a description of the fields for the DAR Installer plug-in, see Table 1, page 24. To install a DAR file: 1. Run dardeployer.exe, which is located in the Composer root directory, to start the DAR Installer. 2. In the DAR Details section, specify values for the fields. 3. In the Connection Broker Details section, specify values for Connection Broker Host and Connection Broker Port and click Connect. 4. In the Repository Details section, specify values for the fields and click Install to install the DAR file to the repository. EMC Documentum CenterStage 1.2 Installation Guide 23

24 Deploying the CenterStage System You can view the log for the DAR installation by selecting the log file from the Log File drop down menu and clicking Open. Table 1. DAR installer fields Parameter Required Description DAR Yes The absolute file path to the.dar file that you want to install. The file path cannot contain any international characters or the installation will fail. Input File No The absolute file path to the install-based parameter file. Local Folder No The absolute file path to localized.properties files. If you want to make your application available in other languages, localize the project data such as labels, tabs, and descriptions. Log File No The file to save the log to. If this is not specified, the file defaults to <DAR>.log. Connection Broker Host Yes The address of the Connection Broker. Connection Broker Port Yes The port of the Connection Broker Repository. Repository Yes The name of the repository that you want to install the DAR file to. Click the Connect button after entering the Docbroker host and port to retrieve the available repositories. User Name Yes The login name for the repository. Password Yes The password for logging in to the repository. Domain No The domain of the user. Locale Folder No The absolute file path to localized.properties files. 24 EMC Documentum CenterStage 1.2 Installation Guide

25 Deploying the CenterStage System Deploying CenterStage DARs using an Ant Task You can deploy CenterStage DARs using the Ant task emc.install. Create an XML file that sets the following parameters. Parameter Required Description dar Yes The absolute file path to the.dar file being installed inputfile No The absolute file path to the install-based parameter file docbase Yes The name of the repository into which the.dar file is installed username Yes The login name for the repository password Yes The password for logging in to the repository domain No The domain in which the repository resides. localesfolder No The absolute file path to localized.properties files The following example XML file installs the DAR file CenterStage.dar in the testrepo repository. <?xml version="1.0"?> <project name="testtarget" default="installdar"> <description> This is ant script code used to install a DAR in a repository. </description> <!================================= target: installdar ================================= > <target name="installdar"> <emc.install dar="c:\builds\tools\headless\centerstage.dar" docbase="testrepo" username="user1" password="xxyyzz" domain=""/> </target> Customizing the product name in the application URL You can change the product name that appears in the product URL by renaming the WAR or EAR file before you deploy it. By default, CenterStagePro appears in the URL, but you can customize this name. Prior to deploying the CenterStage WAR or EAR file on the application server, change the name of the file from CenterStagePro to your preferred product name. The new name can contain only upper and lower case letters from A to Z and numbers from 0 to 9. Deploy the WAR or EAR file as described in Deploying CenterStage WAR files, page 26 or Deploying CenterStage EAR files, page 26 For more information about customizing and branding CenterStage, see the chapter Branding CenterStage in the EMC Documentum CenterStage Version 1.2 Best Practices Guide. EMC Documentum CenterStage 1.2 Installation Guide 25

26 Deploying the CenterStage System Deploying CenterStage WAR files Deploy the CenterStage WAR files according to the instructions provided with your chosen application server. Deploy the WAR on the following application servers: Apache Tomcat Oracle Application Server Oracle WebLogic Server 10g R3( ) Red Hat JBoss If your application server is not listed here, then it requires the CenterStage EAR file. See Deploying CenterStage EAR files, page 26 for instructions. Deploying CenterStage EAR files While some application servers require the CenterStage WAR file, the following application servers use the EAR file instead: Oracle WebLogic Server (11g R1) IBM WebSphere x If your application server is not listed here, then it requires the CenterStage WAR file. See Deploying CenterStage WAR files, page 26 for instructions. Deploying the EAR file to Oracle WebLogic Oracle WebLogic Server (11g R1) deployments use the CenterStage EAR file. Follow these tasks to deploy the EAR file to Oracle WebLogic Server (11g R1): 1. Preparing the EAR file, page Updating the server JDK, page Installing the EAR file, page 27 Preparing the EAR file To prepare the CenterStage EAR file for Oracle WebLogic: 1. Update the weblogic-application.xml file: <?xml version="1.0" encoding="utf-8"?> <weblogic-application xmlns=" <prefer-application-packages> <package-name>javax.namespace.xml.* </package-name> <package-name>org.apache.xerces.*</package-name> <package-name>org.apache.commons.*</package-name> </prefer-application-packages> <prefer-application-resources> <resource-name>meta-inf/services/*</resource-name> 26 EMC Documentum CenterStage 1.2 Installation Guide

27 Deploying the CenterStage System </prefer-application-resources> </weblogic-application> 2. Update weblogic.xml to set <cookie-http-only> to false: <?xml version="1.0" encoding="utf-8"?> <weblogic-web-app xmlns=" <container-descriptor> <prefer-web-inf-classes>true</prefer-web-inf-classes> </container-descriptor> <session-descriptor> <cookie-http-only>false</cookie-http-only> </session-descriptor> </weblogic-web-app> Updating the server JDK If the Oracle WebLogic server uses JDK 1.6, it can cause failures in CenterStage, including problems transferring files, and changing space settings. If these problems arise, use the following workaround. To update the WebLogic server for JDK 1.6: 1. Copy jaxb-api.jar, jaxb-impl.jar, jaxb1-impl.jar and jaxws-api.jar from %CenterStage%/APP-INF/lib 2. Paste the files into the application server directory %JAVA_HOME%/jre/lib/endorsed. If the endorsed directory does not exist, create it. 3. Delete jaxb-api.jar, jaxb-impl.jar, jaxb1-impl.jar, jaxws-api.jar, jsr173_api.jar, and saaj-api.jar from %CenterStage%/APP-INF/lib. Installing the EAR file Install the CenterStage EAR file per the instructions provided with Oracle WebLogic Server (11g R1). Deploying the EAR file to IBM WebSphere x Install the CenterStage EAR file per the instructions provided with IBM WebSphere x. Installing xplore To use xplore, you need to set up index agent filters after you configure the index agent, but before you start reindexing. Otherwise, the filters cannot be applied to objects that already have been indexed. You can install index agent filters that exclude cabinets, folders, or object types from being indexed. The CenterStage index filter is installed along with the CenterStage DARs. CenterStage needs to be installed before xplore starts to index. For information on installing xplore, see the EMC Documentum xplore Installation Guide. EMC Documentum CenterStage 1.2 Installation Guide 27

28 Deploying the CenterStage System Security and external access In some cases, CenterStage customers want to provide CenterStage access to employees, suppliers, clients, or partners who are not part of their internal network. They require a deployment solution that enables secure access to the CenterStage application. This section discusses the basic configuration required to deploy CenterStage with a proxy server. For additional information on external access scenarios, see the CenterStage System Planning Guide. Installing CenterStage with a proxy server Proxy servers can be integrated into the distributed content architecture to provide additional security to customer deployments. They can also provide caching benefits and traffic monitoring. There are two types of proxy servers. A forward proxy server acts as an intermediary between browsers in a client subnet and the outside world. HTTP requests from the client are redirected through the forward proxy so that outside of the client subnet, all requests are seen as coming from the proxy. Reverse proxy servers provide protection to the back end environments. They work in parallel with firewall configurations so that only the reverse proxy host has access to the back end environment. HTTP requests from the outside world are intercepted by the reverse proxy server and passed to the back end servers. This section walks through the configuration steps required to implement a topology in which proxy servers are implemented with ACS, Branch Office Caching Services (BOCS), and DMS. The Apache 6.0 Web Server is shown as an example, acting as the forward and reverse proxy server. Please note that the following are sample configurations. Refer to the appropriate third party vendors for additional information. Branch office This configuration uses one client and a BOCS server in the branch office using a forward proxy. The BOCS and the client need to be configured to send requests to the backend servers via the forward proxy. The configuration settings are shown in Figure 1, page EMC Documentum CenterStage 1.2 Installation Guide

29 Deploying the CenterStage System Figure 1. Branch Office configuration To implement a Branch Office configuration: 1. To configure Apache 6.0 web server as a forward proxymodify Apache s httpd.conf file to specify the clients allowed to use this proxy. ProxyRequest On ProxyVia On <Proxy *> Order deny.allow Deny from all Allow from </Proxy> 2. Restart the Apache web server. 3. Configure the client to access the proxy. In Internet Explorer, select Tools > Internet Options > Connections tab > LAN Settings. Enter the address and port of the Apache forward proxy. In Figure 2, page 30, Apache running on plesys107 vm2 port 80 is set to be the forward proxy to be used by this client. EMC Documentum CenterStage 1.2 Installation Guide 29

30 Deploying the CenterStage System Figure 2. LAN settings 4. IF DMS can directly access BOCS, push or pull mode can be used. Otherwise, BOCS must be configured to work in pull mode. In this case (BOCS behind a forward proxy), BOCS must be configured in pull mode to poll the DMS server periodically for any messages. 5. If BOCS is using a forward proxy, the forward proxy server host and port should be specified. The values are stored in the BOCS acs.properties as shown in Figure 3, page 30. Figure 3. BOCS configuration The BOCS installer presents options to install in pull mode and also specify the proxy host and port. The corresponding BOCS configuration object is defined in Documentum Administrator as shown in Figure 4, page EMC Documentum CenterStage 1.2 Installation Guide

31 Deploying the CenterStage System Figure 4. Documentum Administrator BOCS configuration settings 6. View the Apache access logs to see if the proxy is being used properly. A snippet of the HTTP Post method with BOCS URL for a BOCS read operation is shown in Figure 5, page 31. Figure 5. HTTP Post method with BOCS read operation Central office The central office example uses Content Server/Accelerated Content Server (CS/ACS), Documentum Messaging Server (DMS), CenterStage, and Documentum Administrator (DA). DMS should always be installed in a location with direct access to the primary CS/ACS. In this scenario, ACS, DMS, and CenterStage are configured with supported reverse proxy servers so that client requests will be redirected through the proxy server to the ACS, DMS, or CenterStage servers. This involves 1) configuring the reverse proxy for redirection and 2) modifying the base URLs of the ACS Server configuration object to use the proxy URL, as shown in Figure 6, page 32. EMC Documentum CenterStage 1.2 Installation Guide 31

32 Deploying the CenterStage System Figure 6. Central Office Configure the Apache web server as a reverse proxy to ACS, DMS, and CenterStage. The UCF client needs to send requests to the back-end servers via the proxy. Modify the Apache configuration file (httpd.conf) on the proxy server to specify the redirect rules. 1. Add the directives shown in Figure 7, page 32 to map proxy host>/acs1 to server host>:9080/acs. Figure 7. Proxy directives 2. Add the directives shown in Figure 8, page 32 to map proxy host>/dms to server host>:8489. Figure 8. DMS proxy directives Next you will configure the ACS and DMS servers. To the UCF client, the ACS is hidden behind a proxy. The ACS base URL must be modified since DFC will use this information to construct the URL that the UCF client uses to perform content transfer. The constructed URL must be accessible from the UCF client and should be accessed via the proxy. Use Documentum Administrator to modify the base URL (acs_base_url) of the ACS server configuration object. To modify the base URL of the ACS server configuration object 1. Log in to each repository associated with the ACS server using Documentum Administrator. 2. Navigate to Administration>Distributed Content Configuration>ACS Servers. 32 EMC Documentum CenterStage 1.2 Installation Guide

33 Deploying the CenterStage System 3. Go to the Properties page of the ACS server. 4. Select the ACS Server Connect URL and click Edit. 5. Modify the ACS Base URL to specify the proxy URL. For example: Original ACS URL server host>:9080/acs/servlet/acs Proxy ACS URL proxy host>/acs1/servlet/acs 6. Restart the repository and the ACS server (Java Method Server). Configure DMS messaging and verify the proxy is working properly. To configure DMS and verify the proxy configuration 1. Define a URL for DMS to use when polling BOCS for messages. This is defined in the BOCS acs.properties as shown in Figure 9, page 33. Figure 9. BOCS acs.properties definition Note that the dms.pulling.url is set to http\://<reverse proxy host>/dms, which was mapped to server host>:8489 in the httpd.conf. 2. On the DMS host, the dms.service.return.url defined in the DMS dms.properties must contain the proxy URL, as shown in Figure 10, page 33 Figure 10. Proxy URL setting in dms.properties 3. To verify that proxy is being properly used, check the ACS log on the application server. The URL built by DFC that is passed to the UCF client to use for the content transfer contains the proxy host. The URL from an ACS write operation is shown in Figure 11, page 33. Figure 11. ACS write operation The access logs on the reverse proxy host will also show a POST method, as shown in Figure 12, page 34. EMC Documentum CenterStage 1.2 Installation Guide 33

34 Deploying the CenterStage System Figure 12. Reverse proxy access log 34 EMC Documentum CenterStage 1.2 Installation Guide

35 Chapter 4 Upgrading CenterStage This chapter provides both general and specific information regarding upgrading from earlier versions of CenterStage to CenterStage 1.2. Backing up app.xml If you have customized one or both of your CenterStage app.xml files, back them up before upgrading to a new version to avoid having the file overwritten by the generic app.xml files that ship with CenterStage. These files are located in Documentum Administrator at the following locations: Cabinets > System > Applications > CenterStage Cabinets > System > Applications > CenterStage Pro After Upgrading from 1.0 or 1.1 to CenterStage 1.2, you must apply your configuration changes to /CenterStage Pro/app.xml. Note that /CenterStage/app.xml should NOT be modified. This contains the base configuration for CenterStage. Edit /CenterStage Pro/app.xml to configure CenterStage. See the instructions in app.xml for details. Backing up custom configuration files If you have added any custom configuration files to the /CenterStage Pro/config/ directory, back up those files and restore them after upgrade. Reinstalling custom DARs If you have deployed any custom DARs in your current CenterStage system, reinstall them after installing the CenterStage DAR. EMC Documentum CenterStage 1.2 Installation Guide 35

36 Upgrading CenterStage Upgrading from CenterStage 1.x to CenterStage 1.2 This chapter provides specific instructions for upgrading an existing CenterStage 1.x instance to CenterStage 1.2. To upgrade from 1.x to Clear the DFC BOF cache on the Content Server machine a. Go to the Windows Services panel and stop the Documentum Java Method Server service. b. Delete the contents of <documentum_home>/cache (for example C:\Documentum\cache). c. In the Windows Services panel, start the Documentum Java Method Server service. Verify that the service is running before you continue. 2. Install.dar files in the following order. For installation instructions, please see Installing a DAR file with the DAR Installer, page 23. a. Collaboration Services b. DCS Attachments c. CenterStage.dar d. CenterStage_Pro.dar e. CenterStageDatatable.dar f. CIS_Artifacts.dar g. Extended_Search-Clustering.dar h. All other.dar files (optional.dars) Rich_Media_Services.dar (optional) Transformation.dar (optional, supports Thumbnail Generator) CenterStageTemplates.dar (optional) 3. Again, use the Windows Services window to verify that the Documentum Java Method Server is running. 4. Using Documentum Administrator (DA), verify that UpdateRoomAspect Attributes has run successfully. a. Open the DA application and log in as the repository owner. b. Navigate to Cabinets>Temp. c. Double-click Result.UpdateRoomAspectAttributes to open the item. If there are multiple items with the same name, open the one with the most current date and time. The file will open in a text editor, such as Notepad. d. Verify the following text in the result file: Result: T Update: Updating RoomAspect attribute a_modify_date successful. 36 EMC Documentum CenterStage 1.2 Installation Guide

37 Upgrading CenterStage If it has not run successfully, run the method manually using DA. 5. Using DA, run the SetupCenterStageIndexes method. a. Navigate to Administration>Job Management>Methods. b. Type setup in the search box to find the method. c. Right-click the SetupCenterStageIndexes method and choose Run. d. Select the Save Results and Run As Server options and click OK. 6. Verify the ServerApps.log file does not contain any current errors. a. On the Content Server, navigate to the Method Server logs directory. For example, C\Documentum\jboss4.2.0\server\DctmServer_MethodServer\logs. b. Notice the Date Modified for the ServerApps.log file. Verify that this file has not been modified since you began the upgrade process. c. Open the log file and verify that no new/current errors have occurred. Running UpgradeCenterStage1_2 The method UpgradeCenterStage1_2 should run automatically after you deploy the version 1.2 DAR files. In Composer, check the log for the DAR installation by selecting the centerstagedar.log file from the Log File drop down menu and clicking Open. The log files are stored in [composer installation directory]/darinstallerlogs/. If UpgradeCenterStage1_2 did not run, you should run the UpgradeCenterStage1_2 method manually using Documentum Administrator. When running the method, choose the option Save Results and Run as Server, then click OK. Running this method ensures that: changes to the discussion/topic object model are visible in the user interface custom space icons and template icons are retained customized ACLs on folders are upgraded to the ContainerSecurityAspect for consistency with the new ContainerSecurityModel.. EMC Documentum CenterStage 1.2 Installation Guide 37

38 Upgrading CenterStage Upgrading folder permissions from 1.1 to 1.2 During upgrade from 1.1 to 1.2, a method is invoked at the end of the DAR installation that will do the following: Assign the kw_acl permission to all folders with dm_permissions that are governed by a space. Convert subfolders with custom permissions to the container security aspect. Folders having custom ACLs are not converted. ACLs on children of folders will not change. 38 EMC Documentum CenterStage 1.2 Installation Guide

39 Chapter 5 Configuration After installation, you must set up users and configure the system. Some of these tasks are performed using Documentum Administrator. Perform the following tasks in the following order: Update paths for log4j appender, page 40 Access Documentum Administrator, page 40 Set up CenterStage indexes, page 40 Create a user in the repository, page 41 Enable notification for subscribed content, page 42 Assign members to the dce_room_creator role, page 42 Assign members to the dmc_kw_manage_space_templates role, page 43 Configure the administrator address, page 43 Configure the embedded Content Server for SMTP, page 44 Configure Retention Policy Services (optional), page 44 Access CenterStage, page 44 Create a space, page 45 The following are additional and optional configuration options: Configure the content policy for each space, page 45 Installing DARs with a localized data dictionary, page 45 Populating a localized CenterStage data dictionary, page 46 Configuring high-availability, page 47 Linux random number daemon configuration, page 47 Configuring CenterStage to enable Kerberos authentication, page 48 Appendix B, Configuring HTTP compression (Optional) EMC Documentum CenterStage 1.2 Installation Guide 39

40 Configuration Update paths for log4j appender After installing the CenterStage WAR file (or before, if you prefer), you need to update two placeholder path values in the log4j.properties file. The log4j.properties file is located at <Web Application Home Folder>/CenterStagePro/WEB-INF/classes/log4j.properties. In that file are two values identifying the locations for log4j files. log4j.appender.xmlfile.file=/temp/logs/centerstage-log.xml log4j.appender.file.file=/temp/logs/centerstage.log Change the path values for these two variables to valid paths on the web application system where log4j log files can be created and updated by the web application server. This should be done for all lines in the log4j.properties file that contain the string ${java.io.tmpdir}. Note: Starting the CenterStage web application without changing these values to valid paths on the host machine will result in an error message about log4j.appender configuration that varies depending on the application server in use. Access Documentum Administrator You can start Documentum Administrator by going to number]/da, where [machinename] is the fully qualified server name and port number is the port on which Documentum Administrator is listening. Log in with the install owner credentials. This is the account that was used to install the Content Server. For information on using Documentum Administrator and on administering CenterStage, refer to the following documents, available on EMC Documentum CenterStage Administration Guide EMC Documentum Documentum Administrator Deployment Guide EMC Documentum Documentum Administrator User Guide EMC Documentum Documentum Administrator Release Notes EMC Documentum Content Server Installation Guide EMC Documentum Content Transformation Services Administration Guide Set up CenterStage indexes After completing an install, it is important that you run the method SetupCenterStageIndexes from Documentum Administrator. This method greatly improves the performance of several common CenterStage queries. The database administrator should run the method during a time when the repository is not being used heavily, as the method can take a long time to run when the repository has millions of objects. To run the SetupCenterStageIndexes method: 1. Open Documentum Administrator. 40 EMC Documentum CenterStage 1.2 Installation Guide