Embed Size (px)
Citation preview
EMC® Documentum®
Connector for Microsoft SharePointVersion 7.3
Installation Guide
EMC CorporationCorporate Headquarters
Hopkinton, MA 01748-91031-508-435-1000www.EMC.com
Legal Notice
Copyright © 2013–2016 EMC Corporation. All Rights Reserved.
EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS 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 PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarksused 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 feedbackabout how we can make our documentation better or easier to use, please send us your feedback directly [email protected]
Table of Contents
Preface ................................................................................................................................ 5
Chapter 1 Prerequisites ............................................................................................... 7
Chapter 2 Installing Connector for SharePoint ............................................................ 9Deploying Documentum Foundation Services Extensions (DFSX)........................ 9Registering Connector for SharePoint App ......................................................... 10Installing the Connector for SharePoint Server.................................................... 10Uploading the App to SharePoint ...................................................................... 13Adding the App ............................................................................................... 13
Chapter 3 Installing and Configuring App ................................................................... 15Installing and Configuring the D2 Plug-in .......................................................... 15
Chapter 4 Uninstalling Connector for SharePoint ........................................................ 17
Chapter 5 Troubleshooting .......................................................................................... 19The ClickOnce UCF Client Cannot Start Up........................................................ 19Unable to Edit App Part .................................................................................... 19Http Error 500.21 – Internal Server Error ............................................................ 20Tuning for Large File Upload ............................................................................ 20Tuning DFS Data Synchronization ..................................................................... 20Using Manual Authentication ........................................................................... 21Using Ticketed Login with Privileged Client ...................................................... 21
3
Table of Contents
4
Preface
Intended AudienceThis document is intended for system administrators responsible for installing EMC DocumentumConnector for Microsoft SharePoint on Office 365.
Revision History
Revision Date Description
December 2016 Initial publication.
5
Preface
6
Chapter 1Prerequisites
Before you install the Documentum Connector for Microsoft SharePoint, ensure that the followingprerequisites are met:
• SharePoint prerequisites:
— SharePoint Online Deployment: Office O365 account
OR
— SharePoint On Premise Deployment: SharePoint 2013 SP1 or SharePoint 2016
— Ensure that the SharePoint On Premise server machine is in the domain and installSharePoint as a valid domain user.
— SharePoint server must be configured for Apps installations. Follow the instructions in thefollowing Microsoft link.https://msdn.microsoft.com/en-us/library/office/fp179923.aspx
— SharePoint server must have SSL enabled SharePoint web application.
• Connector for SharePoint Server prerequisites:
— Microsoft Windows Server 2012 enabled with IIS
— In addition to the default IIS roles and features on the Windows Server 2012, enable thefollowing:
— Server Roles: Enable all roles inWeb Server (IIS) > Security. Enable the roles, .NETExtensibility 4.5 and ASP. NET 4.5 inWeb Server (IIS) > Application Development.
— Features: Enable all features in .NET Framework 4.5 Features.
— Ensure you have a valid X.509 SSL Certificate (.pfx format) for the Connector for SharePointServer
This server should be on the DMZ for SharePoint Online Deployment, and it should bepublicly accessible and the firewall should be configured to allow access Documentum ContentServer and Microsoft Office 365 sites.
The EMC E-LAB Interoperability Navigator contains the software requirements information for yourproduct and compatibility matrices.
Separate servers are needed for the Connector for SharePoint server and the SharePoint server incase of the SharePoint On-premise Deployment.
For optimal performance, EMC recommends the following server configuration:
7
Prerequisites
Server A Server B Server C Server D
SharePoint Onlineor SharePoint 2013SP1/2016 On-premiseServer
Connector forSharePoint server
• DocumentumFoundation Services
• DFSX
Documentum ContentServer
Note: You can install Documentum Foundation Services on the IIS web server, but it might affect theperformance of the IIS web server.
8
Chapter 2Installing Connector for SharePoint
This chapter provides instructions for installing Connector for SharePoint.
To install Connector for SharePoint complete the following procedures:1. Deploying Documentum Foundation Services Extensions (DFSX), page 9
2. Registering Connector for SharePoint App, page 10
3. Installing the Connector for SharePoint Server, page 10
4. Uploading the App to SharePoint, page 13
5. Adding the App, page 13
You cannot upgrade to Connector for SharePoint 7.3 from a previous version. You must uninstallConnector for SharePoint before installing the latest version. Chapter 4, Uninstalling Connector forSharePoint provides more information.
Deploying Documentum Foundation ServicesExtensions (DFSX)The Documentum Foundation Services Extensions (DFSX) is an extension of EMC DocumentumFoundation Services (DFS). DFSX implements several web services that Connector for SharePointuses. 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 Serverinstallation suite.
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 andunzip the file to the dfsx folder.
Note: Do not use the built-in Windows compression utility to extract the dfsx.war file becauseit may 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 fileof DFS. For example:
9
Installing Connector for SharePoint
#include C:\tomcat\webapps\emc-dfs\WEB-INF\classes\dfc.properties
You can also update the dfc.properties file by copying the settings from thedfc.properties file that installs with the Content Server. For example, on a Windowsinstallation of Content Server, the dfc.properties file is located in the Documentum\configdirectory.
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 candownload this application from the EMC download site.
Registering Connector for SharePoint App1. Log in to the SharePoint Site as an administrator.
2. Create or open a SharePoint App Catalog.
3. Modify the URL. For example, if the URL of your site is http://MySite.SharePoint.com/ then modifyit to http://MySite.SharePoint.com/_layouts/15/appregnew.aspx
4. Provide the following information:• Client Id: Automatically generated.
• Client Secret: Automatically generated.
• Title: Provide title as SDFOnline.
• App Domain IP: Fully Qualified Domain Name (FQDN) of the Connector for SharePointserver.
• Redirect URI: Local host URL of the IIS system.
URL format:https://<Connector_for_SharePoint_server_FQDN>/WebPartPage/BrowseWebPartPage.aspx
Note: Save the details you provided for future reference.
5. Click Create.
Installing the Connector for SharePoint Server1. Run SDFOnline.exe as an administrator on the Connector for SharePoint server.
2. Click Install to install the prerequisites.
10
Installing Connector for SharePoint
3. Select one of the following options:• On-Premise: To host on on-premise SharePoint server
• Office 365: To host on SharePoint Online
4. Provide the Client ID, Secret, App Domain generated when Registering Connector forSharePoint App, page 10.
5. For SharePoint Online deployment, provide SharePoint Online details.
6. Provide DFS Endpoint as http://localhost:8080/dfs/.
7. Select Enable D2 features in SharePoint Library option to enable D2 functionality in SharePointlibrary and provide D2 Site URL as D2 Endpoint.
8. Provide the Documentum Repository credentials.
9. Click Install.
10. For SharePoint Online deployment, click Yes to upload the App to SharePoint Online through theinstaller. Click No to upload the App manually.
11. Perform Step 12 to Step 17 for SharePoint On-premise Deployment. Otherwise, skip to Step 17.
12. The X.509 SSL Certificate (.pfx format) should be placed in a folder on the Connector forSharePoint Server.
13. In IIS manager of the Connector for SharePoint Server, select the ServerName node in the treeview on the left. Select the Server Certificates icon and import the X.509 SSL Certificate (.pfxformat). Ensure that you provide a strong password.
14. Create a corresponding .cer file on the Connector for SharePoint Server:
a. In IIS manager, select the ServerName node in the tree view on the left.
b. Double-click Server Certificates.
c. In Server Certificates view, double-click <X.509 SSL Certificate (.pfx format)to display the certificate details.
d. On the Details tab, choose Copy to File to launch the Certificate Export Wizard, and thenclick Next.
e. Use the default value No, do not export the private key, and then click Next.
f. Use the default values. click Next.
g. Click Browse, browse to C:\Certs, name the certificate <certificatename>,and then click Save. The certificate is saved as a .cer file.
h. Click Next.
15. Copy the .cer <certificatename.cer> file, created in Step 14 to the SharePoint On Premiseserver machine and run the following scripts:
a. In the SharePoint 2013 Management Shell, start a new file and add the following lines to it tocreate a certificate object:$publicCertPath = "C:\Certs\sdf.cer"$certificate = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($publicCertPath)
b. Add the following line to ensure that SharePoint treats the certificate as a root authority.
11
Installing Connector for SharePoint
New-SPTrustedRootAuthority -Name "sdf" -Certificate $certificate
c. Add the following line to get the ID of the authorization realm.$realm = Get-SPAuthenticationRealm
d. Your remote web application uses an access token to get access to SharePoint data. Theaccess token must be issued by a token issuer that SharePoint trusts. In a high-trust app forSharePoint, the certificate is the token issuer. Save the issuer ID and password for futurereferences. Add the following lines to construct an issuer ID in the format that SharePointrequires: specific_issuer_GUID@realm_GUID:$specificIssuerId = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"$fullIssuerIdentifier = $specificIssuerId + '@' + $realm
e. Add the following lines to register the certificate as a trusted token issuer. The -Nameparameter must be unique so in a production configuration, it is common to use a GUID aspart (or all) of the name, but in this context, you can use a friendly name. The –IsTrustBrokerswitch is needed to ensure that you can use the same certificate for all the high-trust apps youdevelop. The iisreset command is required to make your token issuer registered immediately.Without it, you might have to wait as long as 24 hours for the new issuer to be registered.New-SPTrustedSecurityTokenIssuer -Name "SDF On Premise" -Certificate$certificate -RegisteredIssuerName $fullIssuerIdentifier –IsTrustBrokeriisreset
f. Run the following commands:$serviceConfig = Get-SPSecurityTokenServiceConfig$serviceConfig.AllowOAuthOverHttp = $false$serviceConfig.Update()
Note: SharePoint 2013/2016 does not normally accept self-signed certificates. So when youuse a self-signed certificate for debugging, add the commands mentioned in this step toturn off SharePoint’s normal requirement to use HTTPS when remote web applications callinto SharePoint. If you do not add the commands mentioned in this step, you get a 403(forbidden) message when the remote web application calls SharePoint using a self-signedcertificate. You will reverse this step in a later procedure. Turning off the HTTPS requirementmeans that the requests from the remote web application to SharePoint are not encrypted,but the certificate is still used as a trusted issuer of access tokens which is its main purposein high-trust apps for SharePoint.
For an internal setup created using a non commercial SSL certificate, the value of$serviceConfig.AllowOAuthOverHttp must be set true.
16. Locate the web.config file on the Connector for SharePoint Server and specify the followingsettings:• <add key="ClientSigningCertificatePath" value="<.pfx certificate
location>”/>
• <add key="ClientSigningCertificatePassword" value="<password for the.pfx certificate>" />
• <add key="IssuerId" value="<issuer ID>" />
For more information on Create high-trust SharePoint Add-ins, follow the instruction on theMicrosoft website.
12
Installing Connector for SharePoint
Note: For autoevents to work in IIS, locate the Connector for SharePoint Server and verify if .svcmime type is listed. If it is not listed, add a new mime type with .svc extension and specifyMimetype= application/octet-stream. Also ensure that in IIS Server Manager > Rolesand Features, .NET 4.5 and WCF (all components) are installed.
17. In IIS manager of the Connector for SharePoint server, select sites node in the tree view on theleft, expand and select <yoursite>, select edit bindings on the right, select the https binding, edit itand map the X.509 SSL Certificate. Enter the hostname details as well.
Uploading the App to SharePointNote: For SharePoint Online deployment, if you have not uploaded the App using the installer, thenyou can follow this procedure to manually upload the App.
1. For SharePoint on-premise deployment, ensure you enable the App Catalog in SharePoint.Chapter 1, Prerequisites provides more details.
2. Navigate to the App Catalog created previously.
3. In the Apps for SharePoint page, click Upload.
4. Navigate and upload the SDFOnline.app file located at C:\inetpub\wwwroot\<yoursite>\_layouts\Documentum.After the upload is successful, the Valid App Package value is shown as Yes.
Adding the App1. In the Site settings option, click Add an app.
2. Click From Your Organization and add the uploaded App to the site.
3. When prompted, click Trust It to add it to the trusted list of Apps.
4. Navigate to the Site Contents page and verify if the App you added is displayed.
5. Navigate to the SharePoint site and edit the site.
6. Click INSERT > App Part > DC4SP Browse App Part > Add.
7. Click Save.
8. Repeat these steps to add the required App Parts.
13
Installing Connector for SharePoint
14
Chapter 3Installing and Configuring App
Installing and Configuring the D2 Plug-inThe D2 plug-in provides the D2 Browse App Part for you to perform D2 file operations based onyour D2 configuration. The plug-in also extends the Connector for SharePoint data services tosupport uploading or checking in documents from SharePoint as well as checking out documents toSharePoint.
Before installing the plug-in, you must also have EMC Documentum D2 installed and configured onthe repository.
Complete the following steps to install and configure the D2 plug-in:
1. Ensure that the D2 plug-in value has been set to Yes while deploying the Connector forSharePoint server.
2. Activate the D2 plug-in SharePoint.
a. In the Site settings option, click Add an app.
b. Click From Your Organization and add the uploaded App to the site.
c. When prompted, click Trust It to add it to the trusted list of Apps.
d. Navigate to the Site Contents page and verify if the App you added is displayed.
e. Navigate to the SharePoint site and edit the site.
f. Click INSERT > App Part > D2 Browse App Part> Add.
g. Click Save.
h. Follow the steps above to add the required App Parts.
15
Installing and Configuring App
16
Chapter 4Uninstalling Connector for SharePoint
You must uninstall existing version of Connector for SharePoint to install the latest version of thesoftware.
1. Take a backup of SDFOnline folder located at C:\inetpub\wwwroot to back up all the configfiles.
2. Open Control Panel > Programs and Features on the Connector for SharePoint server.
3. Select EMC Documentum Connector for SharePoint and click Uninstall.
4. Click Yes.
5. Click Finish.
6. Open C:\inetpub\wwwroot and ensure that the SDFOnline folder is removed.
7. You can replace the files backed up in Step 1 at C:\inetpub\wwwroot\SDFOnline to updatethe customization.
17
Uninstalling Connector for SharePoint
18
Chapter 5Troubleshooting
This chapter contains information about troubleshooting common Connector for SharePointinstallation problems.
The ClickOnce UCF Client Cannot Start UpIf the ClickOnce UCF Client cannot start up on an end user client and the message “Unable to installthis application because an application with the same identity is already installed” shows up, itmeans that the end user already cached a version of the current ClickOnce UCF Client on the client.To fix this issue, you must delete the following items:
• The UcfInstaller folder in the system directory, for example, C:\Users\<username>\UcfInstaller
• The Documentum folder in the system directory, for example, C:\Users\<username>\Documentum
• The files in the \AppData\Local\Apps\2.0 folder in the system directory
You then clear the application cache by completing the following steps:
1. Download and install the Windows SDK from Microsoft official site. For Windows 7 client, youcan download from http://www.microsoft.com/en-us/download/details.aspx?id=8279.
2. Open a command prompt.
3. Go to the path where mage.exe is located.For Windows 7 32-bit, the path is C:\Program Files\Microsoft SDKs\Windows\v7.0A\bin.For Windows 7 64-bit, the path is C:\Program Files (x86) \MicrosoftSDKs\Windows\v7.0A\bin.
4. Execute the command Mage.exe -cc. The Application cache cleared notice appears.
Unable to Edit App PartProblemThe edit option of the App part does not work.
19
Troubleshooting
CauseThe edit option of the App part does not work because the site is not added to the trusted sites list.
ResolutionEnsure that the site is added to the trusted sites list and viewed in the compatibility mode.
Http Error 500.21 – Internal Server ErrorProblemThe following error occurs when you try to execute the batch script:
Http Error 500.21 – Internal Server Error
CauseThis error occurs due to the Net framework mismatch or if the framework is missing.
ResolutionBefore executing the batch file, run the following on the command prompt:%windir%\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe -i
In a 32-bit system, run the following:%windir%\Microsoft.NET\Framework\v4.0.21006\aspnet_regiis.exe –i
Tuning for Large File UploadYou need to modify the Java memory settings on the application server to enable uploading largefiles from Connector for SharePoint via DFS. These settings allow a large enough Java heap sizefor the files to be loaded in memory.
Note: These settings can be superseded by limitations of the DFS application server.
Increase heap size for the application server by setting the Java Virtual Machine parameter as thefollowing:
-Xms4096m –Xmx4096m –XX:PermSize=64m –XX:MaxPermSize=256m –Xss256k–XX:+DisableExplicitGC –Xrs
Tuning DFS Data SynchronizationIf you experience slow data synchronization between Documentum Content Server and theSharePoint server, you can modify the data synchronization time of DFS. The following line in thedfc.properties file of DFS determines the data synchronization time of DFS:
20
Troubleshooting
dfc.cache.type.currency_check_interval=86400
The value is in milliseconds and ranges from 0 to 86400. For example, when you create a newDocumentum type named customizedtype from EMC Documentum Administrator and setdfc.cache.type.currency_check_interval to 300 on the DFS and DFSX server, you can seethe new type appears in Connector for SharePoint in 300 milliseconds.
Using Manual AuthenticationWhen you use manual authentication, the user authentication data is cached on the SharePoint nodewhen a user enters the information. If the user visits another node in a cluster, that authenticationinformation is not available to Connector for SharePoint, the user needs to enter the authenticationinformation again.
To reuse the cache file, copy the cache file to other nodes in the cluster. The cache file is located atC:\inetpub\wwwroot\<yoursite>\_layouts\Documentum\cache. You can also use variousmethods to synchronize the cache file between cluster nodes so the user needs to authenticate to eachApp Part only once.
Using Ticketed Login with Privileged ClientThere can be performance issues when you use ticketed login and privileged client while generatingthe random number needed for this process.
For Linux deployments, you can resolve this issue by adding the following parameter to the Javastartup settings of the server you deployed DFS and then restart the server:
-Djava.security.egd=file:///dev/urandom
You can also add the following lines to the beginning of the dm_start_<server> script on the ContentServer hosts:
DEVRANDOM=/dev/urandomexport DEVRANDOM
21
