EMC Documentum Connector for Microsoft SharePoint

EMC Documentum Connector for Microsoft SharePoint Version 7.1 Installation Guide EMC Corporation Corporate Headquarters Hopkinton, MA 01748-9103 1-508-435-1000 www.emc.com

Legal Notice Copyright 2013-2014 EMC Corporation. All Rights Reserved. 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. Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks used herein are the property of their respective owners. Documentation Feedback Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can make our documentation better or easier to use, please send us your feedback directly at IIGDocumentationFeedback@emc.com

Table of Contents Preface... 5 Chapter 1 System Requirements and Prerequisites... 7 Additional Requirements... 8 Chapter 2 Installing Connector for SharePoint... 9 Deploying Documentum Foundation Services Extensions... 9 Configuring the SharePoint Server... 10 Adding a System Variable for Connector for SharePoint... 10 Configuring the Session State... 10 Deploying the Connector for SharePoint Solutions... 12 Deploying the Base Solution... 12 Deploying the Configuration Solution... 12 Verifying the Installation... 13 Activating Connector for SharePoint Features... 14 Running the InstallFeature.cmd Command... 15 Chapter 3 Installing and Configuring Add-ons... 17 Installing and Configuring the D2 Add-on... 17 Installing the UCF Client... 17 Installing Language Packs... 18 Chapter 4 Upgrading Connector for SharePoint... 19 Chapter 5 Uninstalling Connector for SharePoint... 21 Chapter 6 Troubleshooting... 23 Deploying Connector for SharePoint to a Cluster... 23 Tuning for Large File Upload... 23 Using Custom Columns in the Data Grid... 24 Tuning DFS Data Synchronization... 24 Resource Files Are Not Deployed Correctly... 25 Using Manual Authentication... 25 Using Ticketed Login with Privileged Client... 25 3

Table of Contents 4

Preface Intended Audience This document is intended for system administrators responsible for installing EMC Documentum Connector for Microsoft SharePoint. Revision History Revision date September 2014 March 2014 Description Added a note on upgrading to the latest DFSX version. Initial publication 5

Preface 6

Chapter 1 System Requirements and Prerequisites Before installing Connector for SharePoint, make sure that you have installed the following software: Microsoft SharePoint Server EMC Documentum Content Server EMC Documentum Foundation Services The EMC Documentum Connector for Microsoft SharePoint Release Notes provides detailed information about system requirements and compatibility matrices. Before installation, you must make sure that the SharePoint Administrator account has administrator access to the SharePoint farm and has access to the SQL Server to install solutions. For optimal performance, EMC recommends the following server configuration: Server A Server B Server C Microsoft SharePoint Server Connector for SharePoint Documentum Foundation Services Documentum Content Server Note: You must install Connector for SharePoint on the SharePoint server. You can install Documentum Foundation Services on the SharePoint server, but it might affect the performance of the SharePoint server. 7

System Requirements and Prerequisites Additional Requirements The Multiple File Upload control requires Microsoft Silverlight 4 or higher. The Inbox Web Part and data services workflow integration requires the following software: Documentum Process Engine Business Process Manager Microsoft SharePoint Designer The faceted search and full-text search requires EMC Documentum xplore installed on the Content Server. The D2 add-on requires EMC Documentum D2 installed and configured. 8

Chapter 2 Installing Connector for SharePoint This chapter describes the following steps for installing Connector for SharePoint: 1. Deploying Documentum Foundation Services Extensions (DFSX) 2. Configuring the SharePoint server 3. Deploying the Connector for SharePoint solutions 4. Activating the Connector for SharePoint features Deploying Documentum Foundation Services Extensions The Documentum Foundation Services Extensions (DFSX) is an extension of EMC Documentum Foundation Services (DFS). DFSX implements several web services that Connector for SharePoint uses. You must deploy DFSX on the server where you install DFS. Note: Do not deploy DFSX on the Java Method Server that is bundled with the Content Server installation suite. Apache Tomcat 1. Download the dfsx.war file. 2. Create a folder named dfsx. 3. Extract the dfsx.war file to the dfsx folder. You can rename dfsx.war to dfsx.zip and unzip the file to the dfsx folder. Note: Do not use the built-in Windows compression utility to extract the dfsx.war file because it might corrupt the file. Instead, use a ZIP utility. 4. Navigate to the dfsx\web-inf\classes directory and open the dfc.properties file. 5. Replace the existing lines with a #include statement that references to the dfc.properties file of DFS. For example: #include C:\tomcat\webapps\emc-dfs\WEB-INF\classes\dfc.properties You can also update the dfc.properties file by copying the settings from the dfc.properties file that installs with the Content Server. For example, on a Windows 9

Installing Connector for SharePoint installation of Content Server, the dfc.properties file is located in the Documentum\config directory. 6. Zip the dfsx folder and rename the Zip file to dfsx.war. 7. Copy the updated dfsx.war file to the <TomcatHome>\webapps directory to deploy DFSX. You can verify the DFSX deployment by visiting the following URL in a web browser: http://localhost:8080/dfsx/services/dfsx/documentserviceex?wsdl If you cannot view WSDL, restart the web or application server where you installed DFS and DFSX. Note: You can also use the DFS-DFSX Test Application to test the deployment of DFSX. You can download this application from the EMC download site. Configuring the SharePoint Server After deploying DFSX, you must configure the SharePoint server before installing Connector for SharePoint. Adding a System Variable for Connector for SharePoint In the Windows Environment Variables dialog box, add a system variable with the following values: Variable name: DC4M Variable value: %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\Documentum Configuring the Session State Configuring the Session State for SharePoint 2010 1. Open the Internet Information Services (IIS) Manager and locate your web application. 2. Double-click Modules in the IIS section. 3. Click Add Managed Module under Actions. 4. Enter SessionState in Name. 5. Select the following item in Type: System.Web.SessionState.SessionStateModule, System.Web, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a 6. Locate the web.config file for the SharePoint instance in the web directory, for example, \inetpub\wwwroot\wss\virtualdirectories\80. The web directory is where you want to install Connector for SharePoint. 7. Use a text editor to open the web.config file. 10

Installing Connector for SharePoint Ensure that you create a backup copy of the web.config file before editing. 8. Locate the enablesessionstate attribute and set the value to true. <pages enablesessionstate="true" enableviewstate="true" enableviewstatemac="true" validaterequest="false" pageparserfiltertype ="Microsoft.SharePoint.ApplicationRuntime.SPPageParserFilter, Microsoft.SharePoint, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" asynctimeout="7"> 9. Save and close the web.config file. Configuring the Session State for SharePoint 2013 1. Open the Internet Information Services (IIS) Manager and locate your web application. 2. Double-click Modules in the IIS section. 3. Check to see if a module named Session exists. If not, click Add Managed Module under Actions to create the Session module using the following settings: Name: Session Type: System.Web.SessionState.SessionStateModule 4. Locate the web.config file for the SharePoint instance in the web directory, for example, \inetpub\wwwroot\wss\virtualdirectories\80. The web directory is where you want to install Connector for SharePoint. 5. Use a text editor to open the web.config file. Ensure that you create a backup copy of the web.config file before editing. 6. Check the following settings: Session state is enabled: <pages enablesessionstate="true" enableviewstate="true" enableviewstatemac="true" validaterequest="false" clientidmode ="AutoID" pageparserfiltertype="microsoft.sharepoint.applicationruntime.sppageparserfilter, Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" asynctimeout="7"> The Session module is added to the <modules> section: <add name="session" type="system.web.sessionstate.sessionstatemodule" /> If you do not see the previous settings, update the web.config file accordingly. Now you have completed configuring the SharePoint server. 11

Installing Connector for SharePoint Deploying the Connector for SharePoint Solutions Connector for SharePoint provides the following solution packages: Base Install: Installs the Connector for SharePoint DLLs, pages, and other core elements. Config Install: Installs the configuration files, which are environment specific for each Connector for SharePoint deployment. Note: The solution packages provide two versions for each command file. Run the 2010 version command files if you deploy Connector for SharePoint on SharePoint 2010. Run the 2013 version command files if you deploy Connector for SharePoint on SharePoint 2013. You must deploy Connector for SharePoint on the SharePoint server. Deploying the Base Solution In the Base Install package, run DeploySolutionPackage.cmd to deploy the base solution. This command deploys the basic solution to all the existing SharePoint applications. To deploy Connector for SharePoint to a cluster, see Deploying Connector for SharePoint to a Cluster, page 23. Note: If you get a message denying access, open the DeploySolutionPackage.cmd file in a text editor and update the following line with the full path of the.wsp file: %STSADM% -o addsolution -filename EMC_DC4MOSS_WebParts.wsp Example %STSADM% -o addsolution -filename "C:\Base Install\Package\EMC_DC4MOSS_WebParts.wsp" Deploying the Configuration Solution 1. Use a text editor to update the dctm.config file, which is located in the \TEMPLATE\LAYOUTS\Documentum directory of the Config Install package. The following table lists the sections you must update: Code Section <ServiceAccount> <username value="username" /> <password value="password" /> <docbase value="docbase" /> </ServiceAccount> Description Set the <ServiceAccount> values to retrieve a list of repositories for users to select. The Advanced Search page also uses the <ServiceAccount> values to retrieve metadata for Documentum object types. The account you set must be an account in Documentum Content Server and have superuser privileges. 12

Installing Connector for SharePoint Code Section <Dfs> <url>http://host:port</url> </Dfs> <Dfsx> <url>http://host:port</url> </Dfsx> <TicketMaster> <username value="username" /> <password value="password" /> </TicketMaster> <defaultdocbase value="" /> Description Update the <Dfs> tag with the URL of DFS. You only need to specify the server and port number. If you deployed DFS as its own web application instead of deploying it in the application server root, you must add the web application name to the URL, for example, http://host:port/dfs. Update the <Dfsx> tag with the URL of DFSX. You only need to specify the server and port number. If you deployed DFSX as its own web application instead of deploying it in the application server root, you must add the web application name to the URL, for example, http://host:port/dfsx. The <TicketMaster> tag is used for the ticketed login mode of single sign-on (SSO) authentication. When SSO authentication is enabled, you do not need to provide credentials when you use the Connector for SharePoint Web Parts to access Documentum. The <TicketMaster> tag must contain the username and password of a superuser account in Documentum. When a user logs in, the SharePoint username must match the username of a corresponding Documentum user. The usernames are case sensitive. During SSO authentication, Connector for SharePoint retrieves the username of the current SharePoint user and then retrieves a login ticket from Documentum for the SharePoint user. Connector for SharePoint uses the login ticket to access Documentum instead of using the user s password. Update the <defaultdocbase> tag with the name of the default Documentum repository for the Browse Web Part. 2. Run CreateSolutionConfigs.cmd in the \Config Install\Package directory to create the.wsp file for deployment. 3. Run DeploySolutionConfigs.cmd to deploy the configuration solution. This command deploys the configuration solution to the entire SharePoint farm. Verifying the Installation Complete the following steps to verify the installation of Connector for SharePoint: 13

Installing Connector for SharePoint 1. Access the Global Assembly Cache (GAC), which is located in \Windows\assembly, to verify that the following Connector for SharePoint assemblies are installed: EMC.Documentum.DC4MOSS.WebParts EMC.Documentum.SDF.Authentication EMC.Documentum.SDF.BusinessServices EMC.Documentum.SDF.Common EMC.Documentum.SDF.WebControls EMC.Documentum.SDF.WebServices Emc.Documentum.SharePoint.DataServices 2. Verify that the %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\Documentum directory exists and contains files. 3. Open the WEB.CONFIG file of the SharePoint site and verify an entry for EMC.Documentum.DC4MOSS.WebParts exists in the <SafeControls> tag. <SafeControl Assembly="EMC.Documentum.DC4MOSS.WebParts, Version =7.1.0.0, Culture=neutral, PublicKeyToken=46b9abbd26f95bf7" Namespace="EMC.Documentum.SharePoint" TypeName="*" Safe="True" SafeAgainstScript="False" /> Activating Connector for SharePoint Features After you install Connector for SharePoint, you must activate the Connector for SharePoint features in your top-level SharePoint site. 1. Select Site Actions > Site Settings. 2. Select Manage site features in the Site Actions section. 3. Activate the following features: Check In to Documentum EMC SharePoint Development Framework Transfer to Documentum by property update After you activate the Connector for SharePoint features, verify that the Web Part Gallery has a Documentum group and the group contains Web Parts. If not, you must manually populate all the Web Parts whose name starts with EMC.Documentum.SharePoint. 14

Installing Connector for SharePoint Running the InstallFeature.cmd Command You can also run InstallFeature.cmd in the Base Install package to activate the Connector for SharePoint features for your SharePoint sites. After you run InstallFeature.cmd, verify the following settings of the top-level SharePoint site: In Site Settings, select Site Actions > Manage site features to verify that the EMC SharePoint Development Framework feature is activated. In Site Settings, select Galleries > Web parts to verify that the Documentum group exists and contains Web Parts. 15

Installing Connector for SharePoint 16

Chapter 3 Installing and Configuring Add-ons Installing and Configuring the D2 Add-on The D2 add-on provides the D2 Browse Web Part for you to perform D2 file operations based on your D2 configuration. The D2 add-on also extends the Connector for SharePoint data services to support uploading or checking in documents from SharePoint as well as checking out documents to SharePoint. Before installing the D2 add-on, you must deploy the Base and Configuration solutions. You must also have EMC Documentum D2 installed and configured on the repository. Complete the following steps to install and configure the D2 add-on: 1. In the D2Plugin Install package, run DeploySolutionPackage.cmd to deploy the D2 add-on. 2. Activate the D2 add-on in SharePoint. a. In Site Settings, select Site Actions > Manage site features. b. Activate the EMC Documentum Connector for SharePoint - D2 Plugin feature. c. In Site Settings, select Galleries > Web parts. d. Click Documents in the ribbon and click New Document. e. Select EMC.Documentum.SharePoint.D2Plugin.D2BrowseWebPart and click Populate Gallery. f. Verify that D2Browse.webpart appears in the Web Part Gallery. 3. Open the d2_plugin.config file in %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\Documentum\d2. 4. Update the <d2url> tag with the URL of your D2 Client. Installing the UCF Client Connector for SharePoint provides the UCF Client that you can install to support using UCF as the content transfer mode. You must install the UCF Client on all the user machines. 1. Run ucfwinclient_setup.msi. If prompted, download and install.net Framework 4.0. 2. Review the registry settings located at HKEY_CURRENT_USER\Software\Documentum\SDF -UCF, which is where you set the geolocation for BOCS and enable or disable client logging. 17

Installing and Configuring Add-ons 3. On the SharePoint server, open the dctm.config file located in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\template\layouts \Documentum. Note: If you use site-based configuration, you may have the dctm.config file in subdirectories. 4. Locate the <Dfs> tag and set the value of the <content_transfer_mode> tag to ucf. 5. Save the dctm.config file. To verify the deployment of the UCF Client, open a document in the Browse Web Part and make sure that you see the Documentum UCF Status message. Installing Language Packs The Connector for SharePoint language packs enable the use of the Connector for SharePoint Web Parts in multiple languages. Before installing a Connector for SharePoint language pack, you must make sure that you have installed the SharePoint language pack for the language. You must install language packs on the SharePoint server. Unzip the DC4SP_Language_Pack_xx_XX_7.1.zip file and run the DeployLanguagePack_xx-XX.cmd file to install a language pack. You can install multiple language packs on one Connector for SharePoint solution. After you install a language pack, select Site Administration > Language settings in SharePoint to change the display language. Select My Settings > My Regional Settings in SharePoint to change the display of numbers, dates, and time. 18

Chapter 4 Upgrading Connector for SharePoint This chapter describes the steps to upgrade Connector for SharePoint from a previous release. Before you upgrade Connector for SharePoint, you must back up configuration settings by saving a copy of the dctm.config file, mossdctmmap.xml file, and other XML configuration files. Note: If you are using an older version of Sharepoint, that is, DFSX 6.7 and lower, ensure to upgrade to the latest version, that is, DFSX 7.X. 1. Deactivate the following features in Site Settings > Site Actions > Manage site features: Check In to Documentum EMC SharePoint Development Framework Transfer to Documentum by property update 2. Run UpgradeSolutionPackage.cmd in the Base Install package to upgrade the base solution. 3. Run UpgradeSolutionConfigs.cmd in the Config Install package to upgrade the configuration solution. 4. Activate the features you deactivated in step 1. After you upgrade Connector for SharePoint, you can merge the backed-up configuration settings with the new configuration files. Do not overwrite the new configuration files directly. 19

Upgrading Connector for SharePoint 20

Chapter 5 Uninstalling Connector for SharePoint 1. Back up configuration settings by saving a copy of the dctm.config file, mossdctmmap.xml file, and other XML configuration files. 2. Ensure the Connector for SharePoint deployment packages is available on the SharePoint server. 3. Remove the Connector for SharePoint solution by completing the following steps: a. If you installed language packs, run the UndeployLanguagePack_xx-XX.cmd file of each language pack to uninstall language packs. b. If you installed the D2 add-on, run the UndeploySolutionPackage.cmd command in the D2Plugin Install solution package. c. Run the UndeploySolutionConfigs.cmd command in the Config Install solution package. d. Run the UndeploySolutionPackage.cmd command in the Base Install solution package. Note: If you deployed Connector for SharePoint on a SharePoint Farm, you must use the Central Administration console to retract and remove the Connector for SharePoint solution. Note: If the SharePoint Administration service is started, you must make sure that language packs are removed by completing one of the following steps: In Central Administration > Solution Management, remove all language packs with the Not Deployed status. In SharePoint Management Shell, run stsadm.exe -o deletesolution -name <Solution name> -lcid <language>. 4. Remove the Connector for SharePoint Web Parts from the Web Part Gallery: a. In Site Settings, select Galleries > Web parts. b. Select all the Web Parts that belong to the Documentum group. c. Click Delete Document in the ribbon. 5. Revert the Session State settings that you have added and enabled only for Connector for SharePoint. 6. Remove Documentum Foundation Services Extensions (DFSX) from the application server. 21

Uninstalling Connector for SharePoint 22

Troubleshooting Chapter 6 This chapter contains information about troubleshooting common Connector for SharePoint installation problems. Deploying Connector for SharePoint to a Cluster When running in a cluster, Connector for SharePoint uses session attributes. A user must remain in a single HTTP session from the time the user first accesses Connector for SharePoint functionality until the user closes the browser. When determining how to load balance users in a cluster, you must make sure that the user remains on the same cluster node for the entire HTTP session. When you deploy Connector for SharePoint to a server farm, you can run the deployment from one node and the timer job is created there. The SharePoint admin service then runs this timer job on all nodes of the farm and deploys the solution to all the nodes. All the nodes need to get the deployment successfully for the solution to be considered deployed by SharePoint and available to be used. Otherwise you cannot use Connector for SharePoint, even if you deploy it to a specific node. You cannot manually copy the files to the failed node to resolve this problem. The best way to resolve this problem is to run the sdsadm o execadminsvcs process on the failed node to force the timer job to run and pull down the solution. Tuning for Large File Upload You need to modify the Java memory settings on the application server to enable uploading large files from Connector for SharePoint via DFS. These settings allow a large enough Java heap size for the files to be loaded in memory. Note: These settings can be superseded by limitations of the DFS application server. 1. Increase heap size for the application server by setting the Java Virtual Machine parameter as the following: -Xms4096m Xmx4096m XX:PermSize=64m XX:MaxPermSize=256m Xss256k XX:+DisableExplicitGC Xrs 23

Troubleshooting 2. In the web.config file of the site, set maxrequestlength to 80000: <httpruntime maxrequestlength="80000" /> This value specifies that the maximum upload size that a web application can allow is around 80 MB. 3. Set maxallowedcontentlength to 80000000: <system.webserver> <security> <requestfiltering> <requestlimits maxallowedcontentlength="80000000" /> </requestfiltering> </security> </system.webserver> Put the preceding lines in the <configuration> node of the file. The preceding lines set the maximum size that a web application can write to the server to around 80 MB, which is a security feature of IIS 7. 4. Open a Command window and run iisreset. Using Custom Columns in the Data Grid When you use custom columns in the data grid, the resulting queries may have many results. If you set the maximum results count too low the column data may not display. Make sure to set the maximum results count higher if the custom attributes do not display. If you change the columns, particularly custom ones, you must clear the Connector for SharePoint cache before attempting to load the data. Because the display data for the grid may be cached without the data of those columns. Clear the Connector for SharePoint cache by entering http://<yourserver>/_layouts /Documentum /ClearCache.aspx in a web browser. Tuning DFS Data Synchronization If you experience slow data synchronization between Documentum Content Server and the SharePoint server, you can modify the data synchronization time of DFS. The following line in the dfc.properties file of DFS determines the data synchronization time of DFS: dfc.cache.type.currency_check_interval=86400 The value is in milliseconds and ranges from 0 to 86400. For example, when you create a new Documentum type named customizedtype from EMC Documentum Administrator and set dfc.cache.type.currency_check_interval to 300 on the DFS and DFSX server, you can see the new type appears in Connector for SharePoint in 300 milliseconds. 24

Troubleshooting Resource Files Are Not Deployed Correctly Connector for SharePoint uses the following resource files to externalize the strings displayed in the Connector for SharePoint screens: DC4M_Feature.resx DC4M_Message.resx DC4M_Page.resx DC4M_WebPart.resx DC4M_Script_en-US.resx D2Plugin_Resources.resx (for the D2 Add-on) The resource files might fail to deploy correctly, which leads to you seeing the resource label name as opposed to the string, for example, Properties_Button_Title as opposed to Properties. To fix this issue, you can copy the resource files manually. You can find the resource files in the Base Install\EMC_DC4MOSS_WebParts.wsp\RESOURCES\ folder. When deployed, the files must be copied to %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14 (or 15)\Resources. You can find the resource file for the D2 Add-on in the D2Plugin Install\D2Plugin.wsp \RESOURCES\ folder. When deployed, the file must be copied to %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14 (or 15)\Resources Using Manual Authentication When you use manual authentication, the user authentication data is cached on the SharePoint node when a user enters the information. If the user visits another node in a cluster that authentication information is not available to Connector for SharePoint, the user needs to enter the authentication information again. You can reuse the cache file by copying the cache file to other nodes in the cluster. The cache file is located in %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\Documentum\Cache. You can also use various methods to synchronize the cache file between cluster nodes so the user needs to authenticate to each Web Part only once. Using Ticketed Login with Privileged Client There can be performance issues when you use ticketed login and privileged client with generating the random number needed for this process. For Linux deployments, you can resolve this issue by adding the following parameter to the Java startup settings of the server you deployed DFS and then restart the server: -Djava.security.egd=file:///dev/urandom 25

Troubleshooting You can also add the following lines to the beginning of the dm_start_<server> script on the Content Server hosts: DEVRANDOM=/dev/urandom export DEVRANDOM 26