EMC Documentum Repository Services for Microsoft SharePoint

Transcription

1 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide P/N A01 EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright 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.

3 Table of Contents Preface... 7 Chapter 1 Chapter 2 Chapter 3 Introducing EMC Documentum Repository Services for Microsoft SharePoint... 9 EMC Documentum Repository Services for Microsoft SharePoint overview... 9 What EMC Documentum Repository Services for Microsoft SharePoint does How EMC Documentum Repository Services for Microsoft SharePoint works Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation Typical installation scenario EMC Documentum Repository Services for Microsoft SharePoint prerequisites Preinstallation checklist Understanding permissions and accounts Gathering user information before installation Determining the application pool account users Determining the SSP service account user Creating the performance cache for redirection Creating the temporary cache for reading journaled data Installing EMC Documentum Repository Services for Microsoft SharePoint Overview of installation and configuration Creating initial setup user permissions Installing the Admin Config component Creating the admin user permission Deploying and activating the solution Creating the EDRSMS database Granting database permissions Setting the server farm account Setting service logon user permissions Installing the EDRSMS components Completing installation Setting the Java memory allocation Granting permissions to SharePoint end users Installing the EDRSMS DAR file Installing the DAR file with the DAR Installer plugin EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 3

4 Table of Contents Confirming installation success Chapter 4 Removing EMC Documentum Repository Services for Microsoft SharePoint Disabling the EBSH and JME processes Deactivating the EBSH component Removing the EDRSMS components Deleting the EDRSMS database Removing the Admin Config component Glossary EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

5 Table of Contents List of Figures Figure 1. Content flow in an EDRSMS deployment Figure 2. Functioning of EDRSMS components Figure 3. Typical installation scenario Figure 4. Users in EDRSMS EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 5

6 Table of Contents List of Tables Table 1. Preinstallation checklist Table 2. DAR Installer fields EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

7 Preface This guide describes how to install EMC Documentum Repository Services for Microsoft SharePoint (EDRSMS) as an integration to an existing SharePoint deployment. It provides preinstallation guidance for EMC Documentum Repository Services for Microsoft SharePoint as well as information relating to deactivation and removal. You must perform a number of configuration tasks to complete the deployment of EDRSMS; this configuration is described in the EMC Documentum Repository Services for Microsoft SharePoint Administration Guide. Administrators should review the administration guide before proceeding with installation. Caution: Before you deploy this product to a production environment, EMC recommends that you: Install, configure, and test this product in a development environment. It is important to understand how the redirection and journaling processes work and to determine the appropriate configuration settings for your organization before you implement this application in a live environment. Perform a full SharePoint backup. Intended audience This manual is intended primarily for administrators who are installing this application as an integration to an existing SharePoint deployment. You should be familiar with SharePoint and its Central Administration interface. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 7

8 Preface Revision history The following changes have been made to this document. Revision date September 2009 Description Initial publication. 8 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

9 Introducing EMC Documentum Repository Services for Microsoft SharePoint Chapter 1 This chapter describes the EMC Documentum Repository Services for Microsoft SharePoint application and its main functions: EMC Documentum Repository Services for Microsoft SharePoint overview, page 9 What EMC Documentum Repository Services for Microsoft SharePoint does, page 10 How EMC Documentum Repository Services for Microsoft SharePoint works, page 13 EMC Documentum Repository Services for Microsoft SharePoint overview In a typical SharePoint deployment, content is stored as BLOB objects in the SQL content database. By adding EMC Documentum Repository Services for Microsoft SharePoint (EDRSMS) to your SharePoint environment, these BLOBs are transferred to an external Documentum repository. EDRSMS uses a Microsoft supported API called EBS (External BLOB Storage) as its foundation. This API intercepts read and write calls made to SharePoint and can redirect the BLOBs. By storing SharePoint content and a metadata copy in a Documentum repository, EDRSMS offers a number of advantages: Enables customers to manage this content with advanced content management features Facilitates archiving, compliance, and data aggregation Provides operational efficiency by relieving the SQL Server of content While EMC Documentum Repository Services for Microsoft SharePoint is transparent to SharePoint end users, it provides enhanced archiving and compliance capabilities. By using a high capacity Documentum repository rather than the SQL content server, EMC Documentum Repository Services for Microsoft SharePoint enables administrators to manage multiple farms in a central repository. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 9

10 Introducing EMC Documentum Repository Services for Microsoft SharePoint What EMC Documentum Repository Services for Microsoft SharePoint does Multiple steps and functions are involved in the journaling of SharePoint content. Primarily, there are two major steps involved: EDRSMS first redirects SharePoint content to a location on a shared file system, and then the content is transferred (or journaled) to an EMC repository. Figure 1, page 11 provides a simplified depiction of the product and illustrates how SharePoint content flows through the EDRSMS process. Content files are handled as follows: 1. SharePoint end users import content files to SharePoint. Master metadata is stored in SQL database server. Note: This is default SharePoint behavior which would occur even in the absence of EDRSMS. 2. Content files (known in SharePoint as BLOBs) are saved in one of two places, depending on how EDRSMS is configured: BLOBs that are configured for external storage are sent to the performance cache on a network file system. EDRSMS uses a supported Microsoft API to perform this redirection. BLOBs that are not configured for external storage are saved to the SQL server. In addition, a convenience copy of the metadata (in XML format) is created for BLOBs that are configured for external storage. This copy is saved to the perfomance cache. 3. EDRSMS determines which BLOBs require journaling, based on configuration settings. It saves the content file to the external repository and attaches a copy of the metadata as a rendition of the object. EDRSMS assigns a BLOB ID to every BLOB; the BLOB ID is recorded in both the EDRSMS database and the SQL server. 4. When SharePoint users want to view or edit the content files that have been journaled, EDRSMS uses the BLOB ID to locate the content file in the repository. A copy of the content file is transferred from the external repository to a temporary cache from which it is read for the user. Content that was configured for redirection only is read from the performance cache. Metadata is always read from the SQL Server, as is typical in a SharePoint environment. 10 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

11 Introducing EMC Documentum Repository Services for Microsoft SharePoint Figure 1. Content flow in an EDRSMS deployment When a SharePoint end user modifies a content file, it is saved as a new BLOB. Previous versions of updated content files, as well as files deleted by end users, may become orphans in the repository as determined by various settings in SharePoint relating to versioning and the recycle bin. EDRSMS can be configured to remove the orphaned content and BLOB IDs from the repository and EDRSMS database, respectively, on a regular basis. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 11

12 Introducing EMC Documentum Repository Services for Microsoft SharePoint Orphaned BLOBs also result when a SharePoint user deletes previously journaled content. Deleted BLOBs have various states: 1. When the end users delete content in SharePoint, the deleted BLOBs are sent to the users recycle bins. This is known as a soft delete. Note: This is optional SharePoint behavior which can be disabled. 2. When the users empty their recycle bins, the BLOBs are sent to the site collection s recycle bin (where enabled). 3. Once the BLOBs are emptied from the site collection recycle bin, they are no longer referenced in SharePoint. This is known as a hard delete. Based on configuration settings, EDRSMS acts to remove orphaned content files from the external repository, and it removes orphaned BLOB IDs from the EDRSMS database. Alternatively, EDRSMS can be configured to only mark items as deleted if so desired; in this case, objects in the Documentum repository are not removed 1. Regardless of the deletion configuration for repository objects, orphaned objects are always deleted from the performance cache. Note: If repository content is controlled by an application such as EMC Documentum Retention Policy Services, it may not be possible to delete it through EMC Documentum Repository Services for Microsoft SharePoint. Marking objects as deleted is the recommended option in this scenario. Note: As depicted in Figure 1, page 11, EMC Documentum Repository Services for Microsoft SharePoint is a day forward application. This means that only content that is created or modified in SharePoint after EDRSMS is deployed is journaled. There is no batch method for redirecting or journaling content that resided in SharePoint prior to the date EDRSMS was deployed, but EDRSMS processing can be invoked by checking in and checking out existing content. Alternatively, performing a backup and restore using the Microsoft Stsadm utility or an application such as EMC Networker with the SharePoint module will push existing content through EBS during the restore. The EMC Documentum Repository Services for Microsoft SharePoint Administration Guide describes how to use the Stsadm utility in several different scenarios. 1. This functionality refers to the DCTM Object Marking option that is configured in the Connector Configuration. Consult the EMC Documentum Repository Services for Microsoft SharePoint Administration Guide for details. 12 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

13 Introducing EMC Documentum Repository Services for Microsoft SharePoint How EMC Documentum Repository Services for Microsoft SharePoint works EMC Documentum Repository Services for Microsoft SharePoint comprises three components that work together to execute journaling functions: The External BLOB Storage Handler (EBSH) is EMC s implementation of Microsoft s External BLOB storage (EBS) provider that implements the writing and reading of SharePoint BLOBs to/from the redirection cache and external repository. The Journaling Management Engine (JME) performs several functions: It associates newly created BLOBs with SharePoint objects and, when configured to do so, moves the BLOBs to an external repository. The JME makes journaling decisions based on a rules engine. It creates the convenience copy of the metadata (in XML format) that is stored in the external repository. After the Clean Up Collection Service (CCS) marks objects for deletion, the JME executes the deletion of orphaned objects when configured to do so. The JME runs as a Windows service on the Web front end servers (WFEs). The service name appears as EMC Journal Management Engine when viewed through the Control Panel. The Clean Up Collection Service (CCS) is a post processing component of EMC Documentum Repository Services for Microsoft SharePoint that detects BLOBs that are no longer referenced in SharePoint. Running on a configured schedule, the CCS marks these BLOBs for deletion by the JME. The CCS runs as a Windows service on the WFEs. The service name appears as EMC Clean Up Collection Service when viewed through the Control Panel. Figure 2, page 14 depicts the journaling process in terms of the components that are invoked when BLOBs are initially written to and read from EDRSMS. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 13

14 Introducing EMC Documentum Repository Services for Microsoft SharePoint Figure 2. Functioning of EDRSMS components Cleaning up deleted or outdated content is a post processing function directed by the CCS. The CCS compares the list of SharePoint objects in the SQL content server to the list of journaled BLOBs maintained by the EDRSMS database. When the CCS detects orphaned content BLOBs that are no longer referenced in SharePoint but reside in the performance cache or repository it flags these BLOBs as being no longer referenced. Depending on the chosen connector option, the JME either deletes the objects or marks them as deleted by updating the metadata of the object in Documentum without destroying the object. The option to mark or delete objects applies to journaled objects only. 14 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

15 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation Chapter 2 This chapter describes a typical installation, highlights any software or hardware considerations that you should be aware of before installing EMC Documentum Repository Services for Microsoft SharePoint, and provides preinstallation procedures: Typical installation scenario, page 15 EMC Documentum Repository Services for Microsoft SharePoint prerequisites, page 18 Preinstallation checklist, page 18 Understanding permissions and accounts, page 19 Gathering user information before installation, page 20 Creating the performance cache for redirection, page 21 Creating the temporary cache for reading journaled data, page 23 Typical installation scenario Figure 3, page 17 is a logical flow diagram that depicts the EDRSMS components and the host machines on which they reside in a typical installation scenario. EMC Documentum Repository Services for Microsoft SharePoint has three installer files: The EDRSMS Admin Config component, installed on the SharePoint Central Administration host, controls the configuration settings for the farm. This host must be one of the WFEs in the farm. The EDRSMS Components, installed on every WFE in the farm, include the EBSH, JME, and CCS components. Caution: This is a mandatory requirement. If you do not install the EDRSMS components on every WFE, you will get inconsistent and unpredictable results. Note that the EDRSMS database must be created before you install these components. The EDRSMS DAR file, which is deployed to Documentum repositories, is needed if you plan to enable the following two features: Static Property Mapping (advanced setting) and Static Folder Replication. These features are enabled in the Journaling Rule configuration; see the EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 15

16 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation EMC Documentum Repository Services for Microsoft SharePoint Administration Guide for detailed information about these features. Note: The basic Static Property Mapping feature is default behavior and does not require the DAR file to function. Some automatic configuration occurs when you install the EDRSMS components. If you are installing EDRSMS on just one WFE, the JME and CCS services are both designated as primary. When you are planning the order in which to install the EDRSMS components in a multi WFE farm, consider the following default configuration settings for the JME and CCS: On the first WFE to which EDRSMS is installed, the JME and CCS services are designated as Primary. On the second WFE to which EDRSMS is installed, the JME is designated as Secondary and the CCS is designated as Standby. On any subsequent WFEs, the JME and CCS services are designated as Standby. If desired, you can change these settings after installation in SharePoint Central Administration. The JME settings can be modified on the JME Configuration page, while the CCS settings can be modified on the CCS Configuration page. Consult the EMC Documentum Repository Services for Microsoft SharePoint Administration Guide for more detailed information about configuration. When the EBSH is enabled, it redirects SharePoint BLOBs to the performance cache; this file system should reside on an independent Windows or Linux/UNIX host that exposes a shared/mounted drive. The JME directs BLOBs that are configured for journaling to an EMC repository through a Documentum connector using Documentum Foundation Services (DFS), while the related BLOB ID reference is stored in the EDRSMS database. Note that while the EDRSMS database must reside in a SQL server, it does not need to be created on the same server as Windows SharePoint Server (WSS) or Microsoft Office SharePoint Server (MOSS). The temporary cache is a file location on a shared/mounted drive that is used to temporarily store BLOBs that are retrieved from DCTM during journaling read operations. EDRSMS can be configured to delete the contents of the temporary cache when a certain duration is exceeded. 16 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

17 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation Figure 3. Typical installation scenario EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 17

18 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation EMC Documentum Repository Services for Microsoft SharePoint prerequisites Successful EDRSMS installation requires these prerequisite applications:.net Framework Microsoft Office SharePoint Server (MOSS) or Windows SharePoint Server (WSS) Visual C Redistributable Package (x64 or x86) This prerequisite application is bundled with the EDRSMS components installer. If it does not already reside on the host, you can direct the installer to install it for you. This application can coexist with other versions of the Visual C++ Redistributable Package, but the version installed by EDRSMS is compulsory for successful functioning of EDRSMS. In addition, the Admin Config component of EMC Documentum Repository Services for Microsoft SharePoint must be installed on a WFE host on which: SharePoint s Central Administration is available MOSS or WSS service is running Consult the EMC Documentum Repository Services for Microsoft SharePoint Release Notes for current versions of these prerequisites and detailed requirements information. Ensure that host machines meet these requirements before you install EDRSMS. Preinstallation checklist Before you install EDRSMS, complete the following tasks: Table 1. Preinstallation checklist Requirement Review the system requirements documented in the EMC Documentum Repository Services for Microsoft SharePoint Release Notes. If you are planning to install EDRSMS on multiple WFEs within the same farm, be aware that the order in which you install the EDRSMS components on the WFEs affects the default configuration settings for the CCS and JME. Review this information so that you can plan your deployment accordingly and reduce the need for manual configuration. Review the information about permissions and accounts. Note the user names for the application pool account and the SSP service account. For more information Refer to the EMC Documentum Repository Services for Microsoft SharePoint Release Notes for the version you are installing. An overview of automatic configuration is provided in Typical installation scenario, page 15; see Configuring the CCS instance and Configuring the JME instance in the EMC Documentum Repository Services for Microsoft SharePoint Administration Guide for more details. See Understanding permissions and accounts, page 19 and Gathering user information before installation, page EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

19 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation Requirement Create the shared folders that will be used as the performance cache and the temporary cache. Ensure that Documentum Composer 6.5 SP1 or SP2 is installed and configured for all target repositories if you plan to install the optional EDRSMS DAR file. See Installing the EDRSMS DAR file, page 37 for more details. For more information See Creating the performance cache for redirection, page 21 and Creating the temporary cache for reading journaled data, page 23. Obtain Documentum Composer by conducting a product search on the EMC Download site ( search). Refer to the Documentum Composer documentation for more information about this application. Understanding permissions and accounts Within the SharePoint and EDRSMS environment, a variety of different users are involved in deployment. These user types are designated as: Setup user: User who installs EDRSMS Admin Config and EDRSMS Components. Admin user: User who performs EDRSMS configuration in Central Administration. Service logon user: Logon user for the two EDRSMS Windows services. Other application pool account users: The w3wp process owner. This process is associated with the IIS application pool. Server farm account user: The CA application pool account. SSP service account user: The Shared Service Provider (SSP) account used for querying content in SharePoint. This account user is invoked during Redirection Read and Journaling Read operations. Figure 4, page 20 illustrates the relationship between the EDRSMS components, related users, and the database. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 19

20 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation Figure 4. Users in EDRSMS Permissions need to be set up at certain points within the installation and configuration process; they cannot all be set up before you begin installation. However, during the preinstallation process, you need to complete the procedures in Gathering user information before installation, page 20 to obtain certain user information that is needed later on. All permission procedures are documented in this guide at the appropriate stages in the process. Gathering user information before installation Before you proceed with installation, complete Determining the application pool account users, page 20 and Determining the SSP service account user, page 21 to identify or verify these users in your environment. Determining the application pool account users The following procedure describes how to determine the application pool account user for each SharePoint web application. You will need to have this information available when Creating the performance cache for redirection, page 21, Creating the temporary cache for reading journaled data, page 23, and Granting database permissions, page EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

21 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation To identify the application pool account user: 1. Go to Start > Administrative Tools > Internet Information Services (IIS) Manager. 2. Expand the Web Sites folder. Select a SharePoint website (web application) and select Properties from the context menu. The Properties dialog box opens. 3. Select the Home Directory tab. Note the Application pool value at the bottom of this tab, and then click Cancel to close this dialog box. 4. Expand the Application Pools folder in Internet Information Services Manager. Select the application pool identified in Step 3 and select Properties from the context menu. The Properties dialog box opens. 5. Open the Identity tab. The application pool account user is identified in the User name field of this tab. Make a note of this user. 6. Click Cancel to close this dialog box. Determining the SSP service account user The following procedure describes how to determine the SSP service account user in SharePoint s Central Administration. You will need to have this information available when Creating the performance cache for redirection, page 21, Creating the temporary cache for reading journaled data, page 23, and Granting database permissions, page 30. To identify the SSP service account user: 1. Log in to Central Administration on SharePoint. 2. On the Home tab, click Shared Services Administration. The Manage this Farm s Shared Services page appears. 3. Hover over the default SharedServices SSP and open the drop down list. Select Edit Properties. The Edit Shared Services Provider page appears. 4. The SSP user name is indicated in the SSP Service Credentials section. Make a note of this user. 5. Click Cancel to close this page. Creating the performance cache for redirection Before you install EMC Documentum Repository Services for Microsoft SharePoint, you should create the folder that will serve as the performance cache or redirection area. When you configure the Site Collection Redirection in SharePoint s Central Administration, you will need to provide the path to the performance cache as the Current Redirection Path. You can create a performance cache for each site collection, if desired, or all site collections can be redirected to one performance cache. The amount of storage space available on your file system will likely determine your design decisions with respect to the performance cache(s). If you are using one EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 21

22 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation performance cache for the farm, you must provide the UNC to a shared file system accessible to all WFEs, rather than using a local drive. To create a shared folder for the performance cache on Windows: 1. Create a new folder on the shared file system. Choose a location that has sufficient storage space for storing redirected content from SharePoint. Note: This procedure assumes that the shared folder is created on a server in a trusted Windows domain. If this is not the case, Full Control permission needs to be granted to everyone and the Guest Windows account must be enabled on the server. 2. Right click the folder and choose Properties from the context menu. 3. On the Sharing tab, select Share this folder. 4. Click Permissions. The Share Permissions tab opens. 5. Select the following users and grant them Full Control permission: User for the logon setting for the JME and CCS services on all WFE servers (the service logon user) User for the Application pool identity of Central Administration (server farm account user) Users for the Application pool identity of web applications which will be configured for redirection (identified in Determining the application pool account users, page 20) 6. Grant Read permission to the SSP service account user (identified in Determining the SSP service account user, page 21). 7. Ensure that all remaining users have no access to this folder. Note that hidden shares are supported. Click OK. 8. On the Sharing tab, select Caching. 9. For security purposes, choose Files or programs from the share will not be available offline. Click OK. 10. On the Security tab, assign: Full Control to the users listed in Step 5. Read permission to the SSP service account user (identified in Determining the SSP service account user, page 21). Click Apply and then OK. To create a shared folder for the performance cache on Linux/UNIX: 1. Create a new folder on the shared file system. Choose a location that has sufficient storage space for storing redirected content from SharePoint. 2. Create the SMB root folder, and assign the following permissions: Full Control to the user account Read access to the Root group 22 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

23 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation 3. Set up Linux/UNIX so that Windows can see it as a network drive. Refer to the documentation for your version of Linux/UNIX for instructions. 4. On Windows, mount the file share created in Step 3: a. Ensure that the client for SMB is running. b. Go to My Network > Entire Network. c. Select SMB Network. d. Right click Favorite LAN, and select Add/Remove Hosts from the context menu. e. Add the Linux/UNIX host. On this host, the exported SMB folder appears as a shared folder in Windows. Creating the temporary cache for reading journaled data Before you install EMC Documentum Repository Services for Microsoft SharePoint, you should create the folder that will serve as the temporary cache for journaling read operations. When you configure journaling in the Global Configuration in SharePoint s Central Administration, you will need to provide the path to the temporary cache as the Temp file path. This cache is used for retrieving journaled content from Documentum when Delete Cached Copy for Journaled Objects is enabled (in either the Global Configuration or Journaling Rule Configuration in CA). The storage space requirements for this cache are much less than that for the performance cache because: This cache is only used when retrieving content from the repository and only if you choose not to keep a copy in the performance cache. Objects reside in this cache temporarily. By default, objects are retained in the temporary cache for 30 minutes; after that time, the JME will delete the contents of the cache. There is only one temporary file cache for the entire farm. To create a shared folder for the temporary cache on Windows: 1. Create a new folder on the shared file system. Note: This procedure assumes that the shared folder is created on a server in a trusted Windows domain. If this is not the case, Full Control permission needs to be granted to everyone and the Guest Windows account must be enabled on the server. 2. Right click the folder and choose Properties from the context menu. 3. On the Sharing tab, select Share this folder. 4. Click Permissions. The Share Permissions tab opens. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 23

24 Planning for EMC Documentum Repository Services for Microsoft SharePoint Installation 5. Select the following users and grant them Full Control permission: User for the logon setting for the JME and CCS services on all WFE servers (the service logon user) User for the Application pool identity of Central Administration (the server farm account user) Users for the Application pool identity of web applications which will be configured for redirection (identified in Determining the application pool account users, page 20) The SSP service account user (identified in Determining the SSP service account user, page 21) Click OK. 6. On the Sharing tab, select Caching. 7. For security purposes, choose Files or programs from the share will not be available offline. Click OK. 8. On the Security tab, assign Full Control to the users listed in Step 5. Click Apply and then OK. To create a shared folder for the temporary cache on Linux/UNIX: 1. Create a new folder on the shared file system. Choose a location that has sufficient storage space for storing redirected content from SharePoint. 2. Create the SMB root folder, and assign the following permissions: Full Control to the user account Read access to the Root group 3. Set up Linux/UNIX so that Windows can see it as a network drive. Refer to the documentation for your version of Linux/UNIX for instructions. 4. On Windows, mount the file share created in Step 3: a. Ensure that the client for SMB is running. b. Go to My Network > Entire Network. c. Select SMB Network. d. Right click Favorite LAN, and select Add/Remove Hosts from the context menu. e. Add the Linux/UNIX host. On this host, the exported SMB folder appears as a shared folder in Windows. 24 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

25 Installing EMC Documentum Repository Services for Microsoft SharePoint Chapter 3 This chapter outlines the tasks required to install EMC Documentum Repository Services for Microsoft SharePoint on host machines: Overview of installation and configuration, page 25 Creating initial setup user permissions, page 26 Installing the Admin Config component, page 27 Creating the admin user permission, page 28 Deploying and activating the solution, page 28 Creating the EDRSMS database, page 29 Granting database permissions, page 30 Setting the server farm account, page 32 Setting service logon user permissions, page 33 Installing the EDRSMS components, page 34 Completing installation, page 35 Confirming installation success, page 39 Overview of installation and configuration EMC Documentum Repository Services for Microsoft SharePoint installation requires you to perform a sequence of installation, permissions, and configuration tasks. Most configuration is explained in the EMC Documentum Repository Services for Microsoft SharePoint Administration Guide, so you should have this guide available prior to starting the installation process. Creating initial setup user permissions, page 26 is the first step in an EDRSMS installation. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 25

26 Installing EMC Documentum Repository Services for Microsoft SharePoint Creating initial setup user permissions Before installing the EDRSMS Admin Config component, ensure that the setup user has the appropriate permissions. These permissions include: Member of the local administrators group on each WFE to which EDRSMS is deployed. Member of farm administrators in Central Administration. Member of WSS_Content_Application_Pools on the SQL server. Procedures for creating these permissions are provided below. To add a new member to the local administrators group: 1. From the Start menu in Windows, right click on My Computer. Select Manage from the context menu. The Computer Management console opens. 2. Go to System Tools > Local Users and Groups > Groups. 3. Open the Administrators group. 4. Click Add to add the setup user to this group. 5. Enter the user s name as the object name, and click Check Names to verify. 6. Click OK to add this user. To add a user as a farm administrator: 1. Log in to Central Administration on SharePoint. 2. From the Home tab, open Site Actions > Site Settings. The Site Settings page appears. 3. Select People and groups under User and Permissions. The People and Groups Farm Administrators page appears. 4. If the setup user is not already a member of farm administrators, select New > Add Users. The Add Users Central Administration page appears. 5. Enter the setup user s name in the Add Users text box. Add the user to the Farm Administrators (Full Control) group. 6. Click OK. To add the setup user as a member of WSS_Content_Application_Pools on SQL server: 1. In SQL Server Management Studio, expand the Security and Logins folders. 2. Right click the Logins folder and select New Login. The Login New dialog box appears. 3. On the General page, enter the user s name in the Login name field. Ensure that Windows authentication is selected. 26 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

27 Installing EMC Documentum Repository Services for Microsoft SharePoint 4. Click the User Mapping page. Map this user to the SharePoint_AdminContent database. Select the WSS_Content_Application_Pools database role membership. 5. Click OK. Now proceed with Installing the Admin Config component, page 27. Installing the Admin Config component The first installation task involves installing the EDRSMS Admin Config component on the WFE that hosts SharePoint Central Administration (CA). You then deploy the solution and activate the feature in CA. This component allows you to perform the necessary configuration tasks from the SharePoint interface. To install the Admin Config component of EMC Documentum Repository Services for Microsoft SharePoint: 1. Obtain the EDRSMS installer as an FTP download from the Powerlink website ( 2. Save the compressed distribution file to a temporary location on a host to which SharePoint Central Administration is deployed. 3. Unzip the file. 4. Start the Admin Config installer executable (either EMC_EDRSMS_AdminConfig_win32.exe or EMC_EDRSMS_AdminConfig_win64.exe). 5. A Welcome message is displayed, listing the software that will be installed. Click Next. 6. The system detection screen lists the prerequisites for the EDRSMS host machine. Before proceeding with installation, you must verify that the host meets these requirements by clicking Test. If all prerequisites are present, click Next to proceed with installation. If you need to install some prerequisite applications before proceeding with EDRSMS installation, click Cancel. Confirm that you wish to abort installation, and click Finish to exit. If you receive Failed or Unchecked test results, click Cancel. Confirm that you wish to abort installation, and click Finish to exit. Install the necessary prerequisites and then return to Step On the Choose Destination Location page, you can: Accept the default folder location (C:\Program Files\EMC\EDRSMS\AdminConfig) by clicking Next. Browse to a different location, select the location, and then click Next. 8. Click Install to begin installation. 9. You will receive confirmation when installation is complete. Click Finish to exit the wizard. Proceed to Creating the admin user permission, page 28. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 27

28 Installing EMC Documentum Repository Services for Microsoft SharePoint Creating the admin user permission The following permission must be granted on the CA host to the user who will be configuring EDRSMS. To add a new member to the local administrators group: 1. From the Start menu in Windows, right click on My Computer. Select Manage from the context menu. The Computer Management console opens. 2. Go to System Tools > Local Users and Groups > Groups. 3. Open the Administrators group. 4. Click Add to add the admin user to this group. 5. Enter the user s name as the object name, and click Check Names to verify. 6. Click OK to add this user. Now continue at Deploying and activating the solution, page 28. Deploying and activating the solution After the EDRSMS Admin Config component is installed, you must deploy and activate the solution in order to perform EDRSMS Configuration in SharePoint s Central Administration. The solution is deployed once to those Web front end (WFE) servers in the farm on which Central Administration resides; this is an asynchronous process that can be scheduled at a specific time in order to reduce the load on the target servers. After the solution is deployed, the Admin Config feature must be activated. To deploy the solution to the farm: 1. Log in to Central Administration on SharePoint as the installation owner. 2. From the Operations tab, select Solution Management under Global Configuration. The Solution Management page appears, listing all of the solutions in the farm. 3. Select the EMC Documentum Repository Services for Microsoft SharePoint solution by clicking on emc.edrsms.adminconfig.wsp. The Solution Properties page appears. 4. Click Deploy Solution to globally deploy this solution to the farm. The Deploy Solution page appears. 5. Choose when to deploy the solution. You can defer the deployment to a certain date and time if the load on the target servers is a concern. 6. Click OK. The solution is now globally deployed to the farm. Next, you activate the Admin Config feature in CA. 28 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

29 Installing EMC Documentum Repository Services for Microsoft SharePoint To activate the Admin Config feature on WFEs on which CA resides: 1. Navigate to the Operations tab in Central Administration. 2. Select Manage Farm Features under Global Configuration. 3. Locate the EMC EDRSMS Admin Config feature and click Activate. The feature s status is now Active. Note: Feature activation serves to merge the site mapping of the Admin Config component with the site mapping of CA. In an environment in which CA resides on multiple WFEs, activating this feature on the first WFE will appear to activate it on other WFEs in the farm. However, in this scenario the site mappings will not be properly merged on the local server; therefore, you must first deactivate the feature on subsequent WFEs and then activate it to ensure proper operation. The EMC Documentum Repository Services for Microsoft SharePoint configuration menu can now be accessed at Central Administration > Operations > Data Configuration > EDRSMS Configuration. Proceed to Creating the EDRSMS database, page 29. Creating the EDRSMS database After the EDRSMS Admin Config component is installed, deployed, and activated, you must create an EDRSMS database on a SQL server. The EDRSMS database can reside on the same server as WSS/MOSS, or on a separate server for increased efficiency and ease of backup. One EDRSMS database must be created for each farm that is to be configured for EDRSMS; two or more farms cannot share the same EDRSMS database. The EDRSMS database contains all of the routing information for the BLOBs and stores the BLOB IDs for redirected and journaled content. EDRSMS uses Windows authentication to create and access the EDRSMS database. The EDRSMS database owner is the Central Admin Application pool account user. Note: As soon as content is redirected in EDRSMS and BLOB IDs reside in the EDRSMS database, you cannot delete it. Thus, EMC recommends that you choose the SQL server and the EDRSMS database name carefully to avoid future issues. Only empty EDRSMS databases can be deleted, as described in Deleting the EDRSMS database, page 43. To create the EDRSMS database: 1. Log in to Central Administration on SharePoint. 2. From the Operations tab, select EDRSMS Configuration under Data Configuration. The EMC Documentum Repository Services for Microsoft SharePoint Configuration menu appears. 3. Select Create EDRSMS Database. The Create EDRSMS Database page appears. 4. For an initial deployment of EDRSMS, select the option to Create New Database. 5. Enter the SQL content server name in the Database server name field. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 29

30 Installing EMC Documentum Repository Services for Microsoft SharePoint 6. Assign a Database name that contains the following valid characters: ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz en dash ( ), underscore (_) Note: The first character of the database name must be a letter. The farm s Global Unique Identifier (GUID) is automatically appended to the database name. 7. Click Test to verify that the server is accessible. 8. A success message or error message indicates the test results: If the verification fails, correct the information and click Test again. If the database information is correct, click OK to create the EDRSMS database. You will receive a confirmation message after the database is created. Click Continue. The EDRSMS database now exists on the server. The next task is Granting database permissions, page 30. Granting database permissions Now that you have created the EDRSMS database, various users must be granted permissions to the database. This task must be completed before you install the EDRSMS components. Read and Write permissions need to be granted to the following users: Setup user Other application pool accounts (identified in Determining the application pool account users, page 20) SSP service account user (identified in Determining the SSP service account user, page 21) The procedure for creating these permissions is provided below. To grant EDRSMS database permissions to a user: 1. In SQL Server Management Studio, expand the Security and Login folders. 2. Right click a user to whom you would like to grant EDRSMS database permissions. 30 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

31 Installing EMC Documentum Repository Services for Microsoft SharePoint 3. Choose Properties from the context menu. The Login Properties dialog box appears. 4. Select the User Mapping page. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 31

32 Installing EMC Documentum Repository Services for Microsoft SharePoint 5. Select Map for the EDRSMS database to map this user to the database. In the Database Role Membership list, select db_datareader and db_datawriter. 6. Click OK. Proceed to Setting the server farm account, page 32. Setting the server farm account The CA Application Pool account (also known as the server farm account) is used to perform a number of operations in EDRSMS. This account must be added to the local administrators group on all WFEs (including the server on which CA resides) to ensure successful configuration and operation of this product. Refer to Determining the application pool account users, page 20 if you need to determine the application pool account user. To add the server farm account to the local administrators group on all WFEs: 1. From the Start menu in Windows, right click on My Computer. Select Manage from the context menu. The Computer Management console opens. 2. Go to System Tools > Local Users and Groups > Groups. 3. Open the Administrators group. 32 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

33 Installing EMC Documentum Repository Services for Microsoft SharePoint 4. Click Add to add the server farm account to this group. 5. Enter the user s name as the object name, and click Check Names to verify. 6. Click OK to add this user. 7. Perform an IIS restart so that this change takes effect. The next step is Setting service logon user permissions, page 33. Setting service logon user permissions The service logon user is the logon user for the two EDRSMS services: the JME service and the CCS service. To simplify the permissions process, EMC Documentum recommends that you use the server farm account (the CA Application Pool account) for the service logon user. Under this scenario, the only additional permission required by the service logon user is membership in the Administrators group on all WFE servers (provided below). If you select to use a user other than the server farm account as the service logon user, you will need to perform these tasks in addition to the two mentioned above: Full Control permission for the performance cache (refer to the permission steps in Creating the performance cache for redirection, page 21) Full Control permission for the temporary cache (refer to the permission steps in Creating the temporary cache for reading journaled data, page 23) Member of farm administrator s group (refer to the procedure in Creating initial setup user permissions, page 26) Owner permission for EDRSMS database Member of WSS_Content_Application_Pools (refer to the procedure in Creating initial setup user permissions, page 26) Owner permission on all WSS content databases Member of the Administrators group on all WFE servers Must have administrator permission on target Site Collections Whenever a new web application or site collection is created, you must grant owner and administrator permissions (respectively) to this user To add the service logon user to the local administrators group: 1. From the Start menu in Windows, right click on My Computer. Select Manage from the context menu. The Computer Management console opens. 2. Go to System Tools > Local Users and Groups > Groups. 3. Open the Administrators group. 4. Click Add to add the service logon user to this group. 5. Enter the user s name as the object name, and click Check Names to verify. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 33

34 Installing EMC Documentum Repository Services for Microsoft SharePoint 6. Click OK to add this user. The service logon user must be designated as a site collection administrator in SharePoint. In Central Administration (Application Management > Site collection administrators), it is only possible to add two administrators for any site collection; however, through the Site Actions menu in SharePoint, multiple administrators can be configured. To add the service logon user as a site collection administrator: 1. In the SharePoint root site, open the Site Actions menu. 2. Select Site Settings > Site collection administrators. 3. Add the service logon user to the list and click OK. You can now proceed to Installing the EDRSMS components, page 34. Installing the EDRSMS components The EBSH, CCS, and JME components are combined into one installer file. You must install these components on all Web front end servers in the SharePoint farm. After installation, the CCS and JME will run as Windows services. The services will be started automatically after the installer reboots the host. To install the EBSH, CCS, and JME components of EMC Documentum Repository Services for Microsoft SharePoint: 1. Locate the unzipped installer files obtained in step 1 of Installing the Admin Config component, page Save the Components installer (either EMC_EDRSMS_Components_win32.exe or EMC_EDRSMS_Components_win64.exe) to a temporary location on each Web front end server in the SharePoint farm. 3. Start the installer executable. 4. The installer checks to see whether Visual C Redistributable Package exists on the host. If this application already exists on the host, the installer automatically progresses to Step 5. If the prerequisite does not reside on the host, click Install. Accept the license terms and click OK. Visual C Redistributable Package is deployed by the EDRSMS components installer. 5. A Welcome message is displayed, listing the software that will be installed. Click Next. 6. The system detection screen lists the prerequisites for the host machine. Before proceeding with installation, you must verify that the host meets these requirements by clicking Test. If all prerequisites are present, click Next to proceed with installation. If you need to install some prerequisite applications before proceeding with EBSH installation, click Cancel. Confirm that you wish to abort installation, and click Finish to exit. If you receive Failed or Unchecked test results, click Cancel. Confirm that you wish to abort installation, and click Finish to exit. Install the necessary prerequisites and then return to Step EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

35 Installing EMC Documentum Repository Services for Microsoft SharePoint 7. On the Choose Destination Location page, you can: Accept the default folder location (C:\Program Files\EMC\EDRSMS\AdminConfig) by clicking Next. Browse to a different location, select the location, and then click Next. 8. Provide the database information needed for the installation process. Enter the Database Server Name and then click Retrieve Databases to populate the listing of databases on this server. Select the EDRSMS database from the listing and click Test Connection to validate your choice. Click Next to continue. 9. Enter the domain, user name, and password of a Windows domain account under which the CCS and JME will run as Windows services. Note: This user must have farm administrator privileges so that these services operate properly. See Setting service logon user permissions, page 33 for details. Click Next to being installation. 10. You will receive confirmation when installation is complete. The host must be restarted before you attempt to use the application; choose when to restart the machine and then click Finish to exit the wizard. Repeat this procedure on the remaining WFEs in the farm. Completing installation Before configuring EDRSMS, perform the following procedures: Setting the Java memory allocation, page 35 (mandatory for all EDRSMS deployments) Granting permissions to SharePoint end users, page 36 (mandatory for all EDRSMS deployments) Installing the EDRSMS DAR file, page 37 (optional; refer to details in this section to determine whether this is required for your deployment) Setting the Java memory allocation Application servers can slow down, throw exceptions, or crash with an application that has a large number of Java Server Pages. Thus, to avoid memory and performance issues, EMC Documentum recommends that you set the Java heap size on the application server hosting DFS to 1024 MB. The following procedure pertains to default DFS installations, wherein DFS is automatically deployed to the Content Server host on JBoss. Revise this procedure accordingly if you have installed DFS on a separate host and/or deployed it on a different application server. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 35

36 Installing EMC Documentum Repository Services for Microsoft SharePoint To modify the Java heap size on JBoss: 1. On Windows, open %DCTM_HOME%\jboss4.2.0\server\startMethodServer.cmd. 2. Change the following: set USER_MEM_ARGS= Xms256m Xmx256m XX:PermSize=64m XX:MaxPermSize= 256m Xss256k XX:+DisableExplicitGC Xrs to: set USER_MEM_ARGS= Xms1024m Xmx1024m XX:PermSize=64m XX:MaxPermSize= 256m Xss256k XX:+DisableExplicitGC Xrs 3. Restart the Documentum Java Method Server service. If required for your deployment, perform Installing the EDRSMS DAR file, page 37. If you are not installing the DAR file, you can now consult the EMC Documentum Repository Services for Microsoft SharePoint Administration Guide for the configuration tasks necessary to complete deployment. Granting permissions to SharePoint end users SharePoint end users need to be granted Read & Execute permission on two EDRSMS entries on all WFE servers. This requirement applies to all SharePoint users of a farm that is configured for EDRSMS, regardless of whether they are accessing a site collection configured for redirection. These permissions ensure that end users can successfully upload files to SharePoint. In a multi WFE environment, end users who log on to the SharePoint front end must be domain users. On the Domain Controller, by default, the Domain Users user group contains all the domain users created by administrator. Thus, on each WFE server, the group Domain Users can be used directly for these security settings. In an all in one, single WFE environment, by default there is a Users user group on the Windows server which contains all users created on the machine; this is the group to which the following permissions should be granted. To grant permissions to the EDRSMS Components folder: 1. On each WFE, navigate to the destination folder for the EDRSMS Components (such as C:\Program Files\EMC\EDRSMS\Components). 2. Right click the folder and choose Properties from the context menu. 3. On the Security tab, select the user group Domain Users (in a multi WFE environment) or Users (in a single WFE environment) and grant Read & Execute permissions. 4. Click OK. To grant permissions to the EMCEDRSMS.xml file: 1. On each WFE, navigate to C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\config. 2. Right click the EMCEDRSMS.xml file and choose Properties from the context menu. 3. On the Security tab, select the user group Domain Users (in a multi WFE environment) or Users (in a single WFE environment) and grant Read & Execute permissions. 4. Click OK. 36 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

37 Installing EMC Documentum Repository Services for Microsoft SharePoint Installing the EDRSMS DAR file The EDRSMS DAR file installs two custom document types to the Documentum repository to enable advanced metadata mapping of journaled content, and it enables one way folder synchronization between SharePoint and Documentum. Installation of the DAR file can be considered as optional, but it is mandatory if you want to enable the Static Property Mapping (advanced setting) and Static Folder Replication features in the Journaling Rule configuration. Install this DAR file in each Documentum repository for which you intend to enable these features. The basic Static Property Mapping feature is default behavior and does not require the DAR file to function. Note: Documentum Composer 6.5 SP1 or SP2 is required for the following procedure. See Preinstallation checklist, page 18 for more information. Installing the DAR file with the DAR Installer plugin A DAR file is a deployable, package representation of a Documentum Composer project. You can use the DAR Installer plugin to install a DAR file to a repository if you do not want to use the interface within Composer. The DAR Installer plugin requires Composer to be installed, but it does not launch the full Composer IDE. This plugin is useful for installing Documentum product DAR files or in cases where you want to decouple the development of DAR files from the installation of DAR files. When you open the DAR Installer plugin, 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 plugin, see Table 2, page 38. To install the EDRSMS DAR file in a Documentum repository: 1. Obtain the EDRSMS DAR file as an FTP download from the Powerlink website ( 2. Save the installer to a temporary location on the repository host(s). 3. Download the DAR Installer zip file. You can find the DAR Installer plugin by going to and searching for Composer to reach the Documentum Composer download site. 4. Unzip the DAR Installer zip file to the root of your Composer or headless Composer installation directory. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 37

38 Installing EMC Documentum Repository Services for Microsoft SharePoint 5. Run darinstaller.exe, which is located in the Composer root directory, to start the DAR Installer plugin. 6. In the DAR Details section, specify values for the fields. 7. In the Connection Broker Details section, specify values for Connection Broker Host and Connection Broker Port and click Connect. 8. In the Repository Details section, specify values for the fields and click Install to install the DAR file to the repository. 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 2. 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 I18N 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, you need to localize the project data such as labels, tabs, and descriptions. Log File No The file to which to save the logs. 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 to which you want to install the DAR file. Click Connect after entering the Connection Broker host and port to retrieve the available repositories. User Name Yes The login name for the repository. 38 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

39 Installing EMC Documentum Repository Services for Microsoft SharePoint Parameter Required Description Password Yes The password for logging into the repository. Domain No The domain where the repository resides. You can now perform the configuration tasks outlined in the EMC Documentum Repository Services for Microsoft SharePoint Administration Guide. Confirming installation success After completing the installation process, you can confirm the presence of EMC Documentum Repository Services for Microsoft SharePoint components in Central Administration in these locations: Under Solution Management, EMC Documentum Repository Services for Microsoft SharePoint appears as a solution (emc.edrsms.adminconfig.wsp). Under Manage Farm Features, EMC Documentum Repository Services for Microsoft SharePoint appears as a feature. Installing EDRSMS creates a number of directories and additional software components on the host machines: On the SharePoint Central Administration host, a new menu item (EMC Documentum Repository Services (EDRSMS) Configuration) appears on the Operations tab under Data Configuration. The Clean Up Collection Service and Journaling Management Engine will be running as Windows Services on all WFEs. These services are named EMC Clean Up Collection Service and EMC Journal Management Engine. EDRSMS Admin Config and EDRSMS Components appear in Windows Add or Remove Programs listing. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 39

40 Installing EMC Documentum Repository Services for Microsoft SharePoint 40 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

41 Removing EMC Documentum Repository Services for Microsoft SharePoint Chapter 4 This chapter discusses how to remove EMC Documentum Repository Services for Microsoft SharePoint from the SharePoint farm. In a development environment, you may need to uninstall and reinstall the application during testing. In this scenario, data recovery is not an issue and the following abbreviated procedure can be followed: 1. Removing the EDRSMS components, page Deleting the EDRSMS database, page Removing the Admin Config component, page 43 To completely remove the EMC Documentum Repository Services for Microsoft SharePoint application in a production environment, first consult the EMC Documentum Repository Services for Microsoft SharePoint Administration Guide for information regarding backup of site collections. Then follow these procedures in this order to remove this application: 1. Disabling the EBSH and JME processes, page Deactivating the EBSH component, page Removing the EDRSMS components, page Deleting the EDRSMS database, page Removing the Admin Config component, page 43 Disabling the EBSH and JME processes The first step in removing EMC Documentum Repository Services for Microsoft SharePoint from the farm is to disable the redirection and journaling processes. To disable the EBSH and JME processes on the CA host: 1. Navigate to the Operations tab in Central Administration. 2. Select EDRSMS Configuration under Data Configuration. The EMC Documentum Repository Services for Microsoft SharePoint Configuration menu appears. EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 41

42 Removing EMC Documentum Repository Services for Microsoft SharePoint 3. Select Global Configuration. The Global Configuration page appears. 4. Under EBSH Configuration, disable EBSH activity. 5. Under Journaling Configuration, disable JME activity. 6. Click OK. The redirection and journaling activities for all site collections are now disabled. Deactivating the EBSH component When you deactivate the EBSH, most EDRSMS functioning ceases. To deactivate the EBSH component: 1. Navigate to the Operations tab in Central Administration. 2. Select EDRSMS Configuration under Data Configuration. The EMC Documentum Repository Services for Microsoft SharePoint Configuration menu appears. 3. Select Manage EBSH Feature. The Manage EBSH Feature page appears. 4. Click Deactivate. When the warning message appears, confirm this action by clicking Deactivate this feature. Removing the EDRSMS components The EDRSMS components application, which includes the EBSH, CCS, and JME, must be removed from all the Web front end servers in the SharePoint farm. To remove the EDRSMS components program: 1. On the Web front end server that hosts CA: Go to Start > Control Panel > Add or Remove Programs (Windows 2003 server). Go to Start > Control Panel > Programs > Programs and Features > Uninstall a program (Windows 2008 server). 2. Select EMC Documentum Repository Services for Microsoft SharePoint Components, and click Remove or Change/Remove. Follow the prompts on the screen to complete program removal. 42 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

43 Removing EMC Documentum Repository Services for Microsoft SharePoint Deleting the EDRSMS database Only empty EDRSMS databases can be deleted through Central Administration. If the database you wish to delete contains data, use SQL Management Studio to delete it; be aware that deleting a database that contains referenced objects is irreversible and will result in data loss. To delete an empty EDRSMS database: 1. Log in to Central Administration on SharePoint. 2. From the Operations tab, select EDRSMS Configuration under Data Configuration. The EMC Documentum Repository Services for Microsoft SharePoint Configuration menu appears. 3. Select Delete EDRSMS Database. The Delete EDRSMS Database page appears. 4. Click Delete. Removing the Admin Config component To remove the EDRSMS Admin Config component from the CA host, you must perform two tasks: remove the solution from the farm, and then remove the component using Windows. If the Admin Config component is installed on more than one CA host, perform these procedures on each host. To remove the solution from the farm: 1. Log in to Central Administration on SharePoint as the installation owner. 2. From the Operations tab, select Solution Management under Global Configuration. The Solution Management page appears, listing all of the solutions in the farm. 3. Select the EDRSMS solution by clicking on emc.edrsms.adminconfig.wsp. The Solution Properties page appears. 4. Click Retract Solution to remove this solution from the farm. 5. Click OK to confirm this action. 6. After the solution is successfully retracted, select Remove Solution. 7. Click OK to confirm this action. To remove the Admin Config component program: 1. On the Web front end server that hosts CA: Go to Start > Control Panel > Add or Remove Programs (Windows 2003 server). Go to Start > Control Panel > Programs > Programs and Features > Uninstall a program (Windows 2008 server). EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 43

44 Removing EMC Documentum Repository Services for Microsoft SharePoint 2. Select EMC Documentum Repository Services for Microsoft SharePoint AdminConfig, and click Remove or Change/Remove. Follow the prompts on the screen to complete program removal. 44 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

45 Glossary Terminology relating to EMC Documentum Repository Services for Microsoft SharePoint is defined here. binary large object (BLOB) This is a Microsoft term used to describe how binary data is stored in an SQL Server Content Database. It refers to the actual content of documents and attachments in SharePoint. Central Administration (CA) SharePoint s interface for administration tasks. Once EMC Documentum Repository Services for Microsoft SharePoint is installed, you can administer and configure this application from CA. Clean Up Collection Service (CCS) A post processing component of EMC Documentum Repository Services for Microsoft SharePoint that detects BLOBs that are no longer in use. Running on a configured schedule, the CCS marks these BLOBs for deletion by the JME. EDRSMS database A database added to Microsoft SQL Server that assists the EBSH in locating BLOBs for journaling. The EDRSMS database contains only routing information for the BLOBs; it does not store the BLOB content or the BLOB s metadata. This database also contains all of the configuration settings and rules that are defined in SharePoint Central Administration. External BLOB storage handler (EBSH) EMC s External BLOB Storage (EBS) provider that leverages the Microsoft API which implements the writing and reading of SharePoint BLOBs to/from the redirection cache and external repository. journaling The action where BLOB data that resides in the performance cache can be further transferred to a Documentum repository. BLOB data is moved via DFS in an asynchronous process. Journaling Management Engine (JME) As the core of the journaling solution, the JME retrieves the metadata stored in Documentum and moves the BLOBs to the external repository. The JME makes journaling decisions based on a rules engine. When configured to do so, the JME deletes orphaned content identified by the CCS service. orphan A BLOB that is no longer referenced in SharePoint. A BLOB becomes an orphan as a result of a hard delete in SharePoint, or when a SharePoint user edits (overwrites) a document in an EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 45

46 Glossary unversioned list. When the CCS runs, it will flag the orphans. The JME deletes the orphaned content from the performance cache and either deletes or marks orphaned content in the Documentum repository depending on the configuration setting. performance cache A folder on a shared file system to which SharePoint BLOBs are redirected for every site collection that is configured. Depending on storage availability, there may be one performance cache for the farm or separate performance caches for each site collection. redirection The action by which BLOB content from a configured site collection is transferred to the performance cache. This uses the Microsoft EBS API and is a synchronous process. SP Resolver The process of associating a BLOB with a SharePoint object and obtaining the metadata. temporary cache A file location used to temporarily store BLOBs for journaling read operations when the content resides in Documentum and where there is no performance cache copy. The temporary cache has a timer whereby the contents are deleted on a schedule. Unlike the performance cache, there is only one temporary cache for the entire farm. WatchDog A thread in the JME that sends notifications to an administrator when the system needs attention. The WatchDog monitors the activity in and logs for the EBSH, JME, and CCS. 46 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

47 Index A activating Admin Config feature, 28 Admin Config component installing, 27 removing, 43 admin user defined, 19 permissions, 28 application pool account users database permissions, 30 defined, 19 identifying, 20 permissions, 22, 24 B BLOB IDs assigning, 10 orphaned, 11 processing in EDRSMS, 10 BLOBs defined, 10 deleted, 11 orphaned, 11 processing in EDRSMS, 10 reading, 10 updated, 11 writing, 10 C components functioning, 13 configuration overview, 25 content lifecycle, 10 creating EDRSMS database, 29 D DAR file, installing, 37 DAR Installer plugin, 37 deactivating EBSH, 42 delete hard, 12 permanent, 12 soft, 12 deploying the solution, 28 DFS Java heap size, 35 Documentum repository, 9 E EBSH, deactivating, 42 EDRSMS Administration Guide, 25 EDRSMS components installing, 34 removing, 42 EDRSMS database creating, 29 naming, 30 valid characters for name, 30 F farm administrator privileges, 26 folder replication in Documentum, 37 G glossary, 45 H hard delete, 12 heap size, Java, 35 I installation overview, 25 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 47

48 Index preinstall checklist, 18 prerequisites, 18 setting Java memory, 35 typical scenario, 15 installers, obtaining, 27 installing Admin Config component, 27 confirming success, 39 DAR file, 37 DAR file using the DAR Installer, 37 EDRSMS components, 34 J Java memory setting, 35 L lifecycle of content, 10 local administrator privileges, 26 M metadata mapping in Documentum, 37 processing in EDRSMS, 10 storing, 10 MOSS, 18 N.NET Framework, 18 O overview of installation and configuration, 25 of product functionality, 9 P permissions admin user, 28 database, 30 overview, 19 server farm account user, 32 service logon user, 33 setup user, 26 SharePoint end users, 36 planning installation, 15 preinstallation checklist, 18 privileges farm administrator, 26 local administrator, 26, 28, 32 to 33 site collection administrator, 34 SQL server, 26 processing BLOB IDs, 10 BLOBs, 10 metadata, 10 processing content through EDRSMS, 10 product overview, 9 R recycle bins, 12 removing Admin Config component, 43 EDRSMS, 41 S server farm account user defined, 19 permissions, 22, 24 setting permissions, 32 service logon user defined, 19 permissions, 22, 24 setting permissions, 33 setup user database permissions, 30 defined, 19 permissions, 26 SharePoint end users, permissions, 36 soft delete, 12 solution deployment, 28 SQL content server, 10 SQL server privileges, 26 SSP service account user database permissions, 30 defined, 19 identifying, 21 permissions, 22, 24 Static Folder Replication, 37 Static Property Mapping advanced, 37 basic, 37 U users in EDRSMS, EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide

49 Index W WSS, 18 EMC Documentum Repository Services for Microsoft SharePoint Version 6.5 SP2 Installation Guide 49