EMC ® Documentum ® My Documentum for Microsoft Outlook Version 7.1
Administration Guide
EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.EMC.com
Legal Notice Copyright © 1999 –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 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
[email protected]
Table of Contents
Preface Chapter 1
................................................................................................................................. Introduction
................................................................................................. 11
My Documentum for Microsoft Outlook architecture .......................................... Components of My Documentum for Microsoft Outlook 7.1 ............................ Chapter 2
9
11 11
....................................... 15 Prerequisites .................................................................................................... 15
Installing My Documentum for Microsoft Outlook
Installing the My Documentum for Microsoft Outlook 7.1 server environment ....................................................................................................
15
Setting up the Oracle BEA WebLogic application server ...................................... Installing web services on an IBM WebSphere 8.5 application server ....................
16 18
....................................................................................................................... 19 Installing on a Tomcat application server............................................................ 19 Using urandom generators for service context registration on Linux systems ............................................................................................................ Setting up a client machine ................................................................................ System requirements .................................................................................... Prerequisites ................................................................................................ Configuring WebSEAL server for certificate authentication ............................. WebSEAL SSO authentication at My Documentum for Microsoft Outlook ....................................................................................................... Enabling optional certificate authentication mode in WebSEAL server ............. Creating an SSL junction between WebSEAL server and My Documentum for Microsoft Outlook server ................................................ Creating a certificate user in LDAP registry ................................................ Enabling DFC privileged authentication for WebSEAL certificate authentication in the My Documentum for Microsoft Outlook application server ......................................................................................... Change at the My Documentum for Microsoft Outlook Client to enable SSL connection with self-signed certificates .......................................... Enabling Kerberos based authentication on Windows 7 and Windows Server 2008 R2 machines ................................................................ To refresh expiring Ticket Granting Ticket ...................................................... Configuring Kerberos on Content Server in a Linux environment .................... CA Siteminder support ................................................................................. Configuring My Documentum for Microsoft Outlook EAR file .................... Configuring Siteminder WebAgent ............................................................ Installing My Documentum for Microsoft Outlook on client machines ............. Upgrading to My Documentum for Microsoft Outlook 7.1 .............................. Uninstalling My Documentum for Microsoft Outlook ..................................... Installing and uninstalling the My Documentum for Microsoft Outlook client using the silent installation method.......................................... Troubleshooting ...........................................................................................
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
20 21 21 21 21 22 22 23 23 24 24 24 25 25 26 27 27 27 28 29 30 31
3
Table of Contents
Chapter 3
Chapter 4
4
........................................................... The dco_system_settings.xml and dco_custom_settings.xml files ......................... dco_system_settings.xml ............................................................................... dco_custom_setting.xml ................................................................................ UI customization using Documentum Administrator ...................................... Customizing menu items and buttons ............................................................ Menu items and buttons in Microsoft Outlook 2007 .................................... Menu items and buttons in Microsoft Outlook 2010/2013 ............................
33 34 39 40 40 41 44
Administration of My Documentum for Microsoft Outlook using Documentum Administrator .............................................................................
47
Profiles ............................................................................................................
48
Modifying a My Documentum for Microsoft Outlook profile...............................
50
Overview link ..................................................................................................
51
The Column Setup screens ................................................................................
51
The Client Setup screen .....................................................................................
53
Dynamic display of metadata dialog based on unique key .................................. Sample entries from dco_system_settings.xml ................................................ Notes for Properties dialog customization .....................................................
53 54 55
Mapping file system properties ......................................................................... Sample XML entries for mapping file system properties .................................. Notes for mapping file system properties ....................................................... Security Configuration ..................................................................................
57 57 58 59
........................................................................................... Deploying Client.exe files.................................................................................. Decrypting the Global Repository Password ....................................................... Moving folders using drag and drop.................................................................. Document extension format mapping ................................................................ Logging in to My Documentum for Microsoft Outlook........................................ EMCMF messages ............................................................................................ Deletion of non-empty folders in the Offline mode ............................................. My Documentum folders node .......................................................................... Email forward during synchronization............................................................... Multiple Microsoft Outlook profiles ................................................................... Advanced search .............................................................................................. dm_message_archive type................................................................................. Cache clearance from empty folders .................................................................. Setting message properties ................................................................................ Using Aspect ................................................................................................ Adding a custom type to the repository (DCO-9327) ........................................... Creating Dump Files ......................................................................................... Difference between the columns of Received and ReceivedDate ........................... Preparing the application server for Java 2 security (DCO-9160) .......................... Removing SQLAnywhere (DCO-8985) ............................................................... Limitations of property inheritance (DCO-8181) ................................................. Applying the Documentum Administrator hotfix (DCO-9159) ............................. My Documentum for Microsoft Outlook Local Storage and Caching ....................
61
Managing Repositories and Profiles
Technical Notes
33
61 61 62 62 62 62 63 63 63 63 63 63 64 64 64 64 64 66 66 66 67 67 67
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Table of Contents
Chapter 5
Modifying a file directly from file system may not save changes to repository (DCO-1059) ......................................................................................
68
Modifying the display configuration to include attributes of a custom type .................................................................................................................
68
Setting default profile target to user’s home cabinet (DCO-2620) ..........................
68
Searching while in offline mode .........................................................................
68
Searching for an email or a text string results return the string if found in an attached document ...................................................................................
69
Accepted meeting requests in Microsoft Outlook 2007 are not uploaded in Documentum (DCO-6605) ..............................................................
69
WebSEAL 6.1.0 does not support HTTP 11 chunking resulting in UCF content transfer failure in Tivoli Access Manager 6.1.0 ........................................
69
Installing Application Connector and My Documentum for Microsoft Outlook client on same machine (DCO-10843) ....................................................
70
PST override setting..........................................................................................
70
.......................................................................................... Repairing My Documentum for Microsoft Outlook ............................................. Resetting the My Documentum for Microsoft Outlook client ............................... My Documentum for Microsoft Outlook client fails to load ................................. Error during UCF operation ..............................................................................
71
Troubleshooting
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
71 72 72 72
5
Table of Contents
List of Figures
Figure 1.
My Documentum for Microsoft Outlook architecture diagram ................................
11
Figure 2.
Java Options settings for Tomcat application server (32-bit Windows Operating System) ............................................................................................
19
Figure 3.
Authentication flow at stack components ...............................................................
22
Figure 4.
Location of My Documentum for Outlook node in Documentum Administrator ..................................................................................................
48
Figure 5.
Creating a My Documentum for Microsoft Outlook profile .....................................
49
Figure 6.
Create Tab ............................................................................................................
49
Figure 7.
Info Tab ...............................................................................................................
49
Figure 8.
Selecting target destinations for My Documentum for Microsoft Outlook profiles ............................................................................................................
49 50
Figure 11.
Profile creation Import tab..................................................................................... The My Documentum for Microsoft Outlook Overview screen in Documentum Administrator ............................................................................. The Column Setup screen......................................................................................
Figure 12.
New View dialog ..................................................................................................
52
Figure 13. Figure 14.
Selecting columns ................................................................................................. Client Setup Screen ...............................................................................................
52 53
Figure 9. Figure 10.
6
51 52
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Table of Contents
List of Tables
Table 1.
dco_system_setting.xml file settings.......................................................................
Table 2.
Microsoft Outlook 2007 explorer toolbar ................................................................
41
Table 3.
Microsoft Outlook 2007 different explorer menu items ............................................
41
Table 4.
Microsoft Outlook 2007 explorer main menu ..........................................................
42
Table 5.
Microsoft Outlook 2007 inspector main menu .........................................................
43
Table 6.
Microsoft Outlook 2007 inspector main menu if Word used as a mail editor in Outlook 2003 ......................................................................................
43
Table 7.
Microsoft Outlook 2007 inspector toolbar ...............................................................
43
Table 8.
Microsoft Outlook 2007 context menu items documents and mails ...........................
43
Table 9.
Microsoft Outlook 2007 context menu items for folder ............................................
44
Table 10.
Microsoft Outlook 2010/2013 explorer ribbon .........................................................
44
Table 11.
Microsoft Outlook 2010/2013 inspector ribbon ........................................................
45
Table 12.
Microsoft Outlook 2010/2013 context menu items for mail object .............................
46
Table 13. Table 14.
Microsoft Outlook 2010/2013 context menu items for document object ..................... Microsoft Outlook 2010/2013 context menu items for multiple objects selected ............................................................................................................ Microsoft Outlook 2010/2013 context menu items for folder.....................................
46
Table 15.
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
34
46 47
7
Table of Contents
8
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Preface
The EMC Documentum My Documentum for Microsoft Outlook Administration Guide explains how to configure and administer your My Documentum for Microsoft Outlook environment. This guide is written with the assumption that you have a basic knowledge of Documentum repositories and Microsoft ® Outlook ®, hereafter referred to as “Outlook”. EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Release Notes contains the latest information about the product, including supported environments and known issues. The latest version of this document is available for download from EMC Online Support (https://support.emc.com).
Intended audience Intended audience
User
Description
Administrators of My Documentum for Microsoft Outlook server environments
Users with administrative rights and responsibilities for My Documentum for Microsoft Outlook and its respective components (application server, content server, Documentum Administrator, etc.)
To use advanced functionalities of My Documentum for Microsoft Outlook, you should have a good working knowledge of Documentum Content Server, application (web) servers, Microsoft Outlook, and other Documentum basic technical workings. Related documentation: • EMC Documentum My Documentum for Microsoft Outlook Version 7.1 User Guide provides information on using My Documentum for Microsoft Outlook. • EMC Documentum Content Server Administration Guide Version x provides information on administering repositories, such as managing permission sets or users, where x is the version number of the Content Server you are using. • EMC My Documentum for Microsoft Outlook Version 7.1 Release Notes provides information on My Documentum for Microsoft Outlook client software installation and known issues. • EMC Documentum 7.1 Environment and System Requirements Guide provides information on system requirements. All related documentation can be downloaded from EMC Online Support (https://support.emc.com).
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
9
Preface
Revision history The following changes have been made to this document. Revision date
Description
April 2016
Added additional prerequisite for deploying MDMO on a Application server. Installing the My Documentum for Microsoft Outlook 7.1 server environment, page 15
September 2014
Updated details related to automatic synchronization in The Client Setup screen, page 53 section.
September 2014
Initial publication
10
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Chapter 1 Introduction
My Documentum for Microsoft Outlook supports the following: • Storing email messages, their attachments, and other documents from Microsoft Outlook into profiled locations in Documentum repositories. • Saving metadata about the email messages and their attachments, such as name of the sender, name of the recipient, date, and subject automatically. • Saving duplicate email messages to the same location • Attaching documents stored in Documentum to an email message.
My Documentum for Microsoft Outlook architecture This section discusses the components of My Documentum for Microsoft Outlook 7.1.
Components of My Documentum for Microsoft Outlook 7.1 The interface used to administer My Documentum for Microsoft Outlook 7.1 is called Documentum Administrator, and is the component that is used to create profiles, configure user options (for example, column views), and other product functionality. Document Foundation Services (DFS) provides the infrastructure and architectural components to enable communication between My Documentum for Microsoft Outlook and the Documentum Content Server. These components are deployed at the application server tier. Figure 1, page 11 illustrates the structure of these components. Figure 1. My Documentum for Microsoft Outlook architecture diagram
My Documentum for Microsoft Outlook allows the end user to work with email messages and documents while offline or online, then synchronizes the new and changed items to the Documentum repository the next time a connection is made. The Synchronization Manager is the component that
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
11
Introduction
provides this functionality, and the interface used to access the Synchronization Manager and allow it to communicate with the Web Services infrastructure is called the Documentum Connector. Other connectors included in the architecture are the Local Storage Connector, File System Connector, and SQL Anywhere 12 Database Connector. These connectors are interfaces between the client local storage (PST files, local file system, and SQL Anywhere 12 Database), the mapping of Documentum-specific functionality (interaction with the EMC messaging type (.msg) etc.), and, in the case of the SQL Anywhere 12 Database connector, provides the interface to Documentum object attributes (properties), as well as managing the metadata associated with the synchronization processes. The Command Processor, File Watcher, and User Interface manage the FrameworkUser interactions and operations. These three components serve to process user-initiated Documentum commands (opening, checking out, checking in files, etc.), tracking user-file interactions and centralized processing of menu and toolbar system context. The Microsoft Outlook component is the Outlook “façade”, that is, it provides unified access to Outlook data regardless of Outlook version, the type of mail transport and data field in use. The Form Manager allows for the customization of native and custom Outlook forms.
12
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Introduction
Finally, the local file system is the location where users store the documents, during their work with My Documentum for Microsoft Outlook. This is the location from which objects are synchronized during the online synchronization process (automatically when online, manually after connecting to the repository).
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
13
Introduction
14
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Chapter 2 Installing My Documentum for Microsoft Outlook Note: Only users with administrator privileges can install the My Documentum for Microsoft Office client.
Prerequisites Ensure the following before installing the My Documentum for Microsoft Outlook 7.1: • Install and setup the following Documentum and third-party applications: — Documentum Administrator. EMC Documentum Administrator 7.1 Deployment Guide contains complete information on how to install and configure Documentum Administrator. The EMC Documentum 7.1 Environment and System Requirements Guide contain the supported environment requirements. Note: Documentum Administrator is the preferred method for the administration of My Documentum for Microsoft Outlook. — Documentum Content Server compatible versions. The EMC Documentum 7.1 Environment and System Requirements Guide contains the supported versions. — This guide does not include instructions on installation of the Content Server and its requirements. EMC Documentum Server Installation Guide provides instructions to install and configure Documentum Content Server version you are installing. It is available for download at EMC Online Support (https://support.emc.com). Ensure that the Content Server and its components (database, application server, Java, etc.) are installed and running before beginning the My Documentum for Microsoft Outlook version 7.1 installation. — Documentum Foundation Services (DFS) installed and currently running (The EMC Documentum 7.1 Environment and System Requirements Guide contains the supported versions). • Get the required permissions to create Personal Folders File (.pst) on your client machine. • To install MDMO 7.1 on a Windows 8.1 operating system turn on Net Framework 3.5 (includes .NET 2.0 and 3.0).
Installing the My Documentum for Microsoft Outlook 7.1 server environment To install My Documentum for Microsoft Outlook: 1.
You must have a repository defined as the global registry repository. Administrator rights are required to log in to the repository, and that administrator account must be active before you can log in to any other My Documentum for Microsoft Outlook-enabled repository. If the global
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
15
Installing My Documentum for Microsoft Outlook
repository is not yet active, the first time you attempt to access another My Documentum for Microsoft Outlook repository, you will be prompted to log in to the global repository. Note: Other repositories can be used in addition to the global repository for storing My Documentum for Microsoft Outlook content, but it is not necessary to have more than just the global repository. 2.
Copy the dfc.properties file from C:\Documentum\config\dfc.properties and modify the following entries: • registry.password • registry.repository • registry.username to reflect the name of the global repository, as well as the user name and password of the BOF user for the global registry.
3.
The My Documentum for Microsoft Outlook DAR must be installed on each repository that is used for My Documentum for Microsoft Outlook, including the global repository. Complete instructions for installing DAR on a Documentum repository are found in the EMC Documentum Content Server Administration Guide..
Note: 1.
Administrator should use the 7.1 composer to deploy the MDMO 7.1 dar.
2.
It is recommended to run the dardeployer.exe file as an administrator and install the MDMO 7.1 dar file.
3.
EMC recommends to disable the SSLV2 and SSLV3 Cipher protocols in the Application servers where MDMO server is deployed.
The following sections describe how to install an application server environment for My Documentum for Microsoft Outlook. EMC Documentum 7.1 Environment and System Requirements Guide contains information on the supported application servers.
Setting up the Oracle BEA WebLogic application server To configure the Oracle BEA WebLogic Server 12.1.1 for My Documentum for Microsoft Outlook in Windows, after installing jdk-7.0: 1.
Add the following parameters to the System Environment Variables Set JAVA_HOME=C: \Program Files\Java\jdk1.7.0.21 Set JAVA_PATH=C: \Program Files\Java\jdk1.7.0.21\bin
2.
Create a folder on the desktop (for example, MDMO71).
3.
Download the latest My-Documentum-for-Microsoft-Outlook-WebService-7.1.0.ear file to the new folder (for example, MDMO71) and rename the file as: My-Documentum-for-MicrosoftOutlook-WebService-7.1.0.zip.
4.
Extract the My-Documentum-for-Microsoft-Outlook-WebService-7.1.0.zip file.
16
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Installing My Documentum for Microsoft Outlook
5.
Add the dfc.properties file in the following location: APP-INF\classes. For example, C:\Users\Administrator\Desktop\MDMO71\My-Documentum-forMicrosoft-Outlook-WebService-7.1.0\APP-INF\classes
6.
Download thexalan.jar and xmlParserAPIs.jar files and add these jar files in the APP-INF/lib folder. For example, C:\Users\Administrator\Desktop\MDMO71\MyDocumentum-for-Microsoft-Outlook-WebService-7.1.0\lib\. Note: To obtain the jar files, search Subscribenet with the following keyword: My Documentum for Microsoft Outlook Web logic 6.7.1. Note: To deploy My Documentum for Microsoft Outlook, apply the WebLogic (12.1.1) patch number: p13603813_12110_Generic; via the Oracle Smart Update.
7.
Apply the patch and start the Oracle BEA WebLogic server. For example, C:\Oracle\Middleware\user_projects\domains\base_domain\startWebLogic. cmd.
8.
Start the server.
9.
Open Internet Explorer and type the following URL: http://:7001/console
The Oracle BEA WebLogic console opens. 10. Enter the credentials (username and password: configured during the web logic server setup). The Administration console appears. 11. On the left pane, select Deployments and click Install. When prompted, provide the location information of the My-Documentum-for-Microsoft-Outlook-WebService-7.1.0.zip file. 12. Click Next. Select Install this deployment as an application 13. Click Next. Select the target server for the Oracle BEA deployment. 14. Click Next. 15. Click Finish. 16. Click Save. The message “The deployment has been installed” appears. 17. Navigate to the Deployment tab (selected in Step 11) and select My Documentum for Microsoft Outlook. The Start button is enabled. 18. Click Start and select Servicing all requests to start the web service deployment. 19. Verify if the State column displays either Start Running or Active to activate the services. 20. If you have successfully installed the application server (using the My-Documentum-forMicrosoft-Outlook-WebService-7.1.0.zip file), the following URL becomes available: http://:7001/dco/smartfolder/SyncStorageConfig?WSDL http:// Server Types>WebSphere application servers.
3.
In the right pane, select server1.
4.
In the right pane of the Server Infrastructure window, select Class Loader in the Java and process management section.
5.
Create a class loader with Classes loaded with application class loader first.
6.
Click Save link.
7.
Navigate to Application servers > server1 > Session management and enable cookies.
8.
Restart the WebSphere.
To deploy My Documentum for Microsoft Outlook 7.1: 1.
Unzip the My-Documentum-for-Microsoft-Outlook-WebService-7.1.0.ear file using WinZip or a similar program.
2.
Navigate to the $ear\APP-INF\classes folder.
3.
Add dfc.properties from C:\Documentum\config to the APP-INF\Classes path.
4.
Repackage (zip) the My-Documentum-for-Microsoft-Outlook-WebService-7.1.0.ear file.
5.
Log in to the IBM WebSphere Administration Console.
6.
On the application server, in the left pane, navigate to Applications>Application Types>WebSphere enterprise applications.
7.
Deploy the My-Documentum-for-Microsoft-Outlook-WebService-7.1.0.ear file. During the deployment of My-Documentum-for-Microsoft-Outlook-WebService-7.1.0.ear file, select the Deploy Web services for the Select Installation options, select dco-smartfolder.war and ucf.war modules in the Map modules to server and Map virtual hosts for Web modules sections.
8.
From the list of available applications, click My-Documentum-for-Microsoft-OutlookWebService-7.1.0.
9.
From the Detail Properties tab, select Class loading and update detection.
10. Change Class loader order to Classes loaded with local class loader first (parent last), and change WAR class loader policy to Single class loader for application. 11. Click OK. 12. Enable cookies in Enterprise Applications > My-Documentum-for-Microsoft-OutlookWebService-7.1.0 > Session management. 13. Select My-Documentum-for-Microsoft-Outlook-WebService-7.1.0 and click Start. Note: To verify that My Documentum for Microsoft Outlook is configured and running successfully, test the following URL:
18
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Installing My Documentum for Microsoft Outlook
http://:/dco/smartfolder/SyncStorageConfig?WSDL
Installing on a Tomcat application server Before installing web services on Tomcat for My Documentum for Microsoft Outlook, download My-Documentum-for-Microsoft-Outlook-WebService-7.1.0.war from Subscribenet to continue with the installation.
To install web services on a Tomcat application server: 1.
Open My-Documentum-for-Microsoft-Outlook-WebService-7.1.war using Winzip (or another unzipping product). Add dfc.properties from C:\Documentum\config to the WEB-INF/Classes path in the war file. When prompted to verify that you wish to add this file, confirm that you do.
2.
Stop the Tomcat server: Go to Start>Programs>Apache Tomcat>Configure Tomcat. On the General tab, click the Stop button at the bottom of the dialog box.
3.
Copy My-Documentum-for-Microsoft-Outlook-WebService-7.1.war to the application server machine.
4.
On the Java tab, to avoid the permgen and heap space out of memory errors, add the following parameters in the Java Options section, each on its own line as shown in Figure 2, page 19: -Xms512m -Xmx1024m -XX:MaxPermSize=512m -XX:MaxHeapFreeRatio=70 Figure 2. Java Options settings for Tomcat application server (32-bit Windows Operating System)
5.
Place the My-Documentum-for-Microsoft-Outlook-WebService-7.1.war file into the Tomcat deployment directory (TOMCAT_HOME/webapps).
6.
Navigate to TOMCAT_HOME/conf directory. Open the server.xml file in edit mode and add the following lines (for context paths) between the tag:
7.
Start the Tomcat server.
8.
After Tomcat is started (running), check the following URL to confirm the deployment:http://:8080/dco/smartfolder/SyncStorageConfig?WSDL to confirm the DCO services are running.
9.
If the wsdl URL does not open, stop the Tomcat server, and restart the Tomcat server and check the wsdl url again.
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
19
Installing My Documentum for Microsoft Outlook
Note: • Ensure the dfc.properties is present in TOMCAT_HOME\webapps\My-Documentum-forMicrosoft-Outlook-WebService-7.1\WEB-INF\classes. • To access Tomcat Administrator page: Navigate to the TOMCAT_HOME/conf directory, open the server.xml file in edit mode, and include the following (for context paths) under the tag:
• To access the Tomcat Administrator page, follow this URL: http://localhost:8080/admin
To troubleshoot problems with the My Documentum for Microsoft Outlook deployment on Tomcat, perform the following: 1.
Stop the Tomcat server.
2.
Clean up the contents under C:\Documentum\cache.
3.
Clean up the contents under TOMCAT_HOME\work.
4.
Clean up the contents under TOMCAT_HOME\temp.
5.
Clean up the Documentum folder under TOMCAT_HOME\bin.
6.
Start the Tomcat server.
Using urandom generators for service context registration on Linux systems Service context registration is slow on Linux systems because there are issues with implementation of pseudo-random number generators. To increase the speed with which tokens for random numbers are generated (for service context registration), Linux systems must use urandom generators that are faster but less secure. To change the source of secure random numbers from random to urandom, set the java.security.egd system property as follows: -Djava.security.egd=file:///dev/urandom
This system property overrides the securerandom.source setting to urandom. If the application server is on Red Hat Linux, the application server startup script (for example, startWeblogic.sh for WebLogic) must be modified to set the option in the JVM.
20
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Installing My Documentum for Microsoft Outlook
Setting up a client machine This chapter includes the following topics: • System requirements, page 21 • Prerequisites, page 21 • Installing My Documentum for Microsoft Outlook on client machines, page 27 • Upgrading to My Documentum for Microsoft Outlook 7.1, page 28 • Uninstalling My Documentum for Microsoft Outlook, page 29 • Repairing My Documentum for Microsoft Outlook, page 71
System requirements The EMC Documentum 7.1 Environment and System Requirements Guide contains the system requirements information for your product. This documentation is available from EMC Online Support.
Prerequisites Before you begin the My Documentum for Microsoft Outlook installation on an end-user machine, ensure that the following prerequisites are met: 1.
You have the right to access repositories in Documentum Administrator. Ask your company help desk or contact your administrator for this information.
2.
Email accounts and/or profiles are configured in Microsoft Outlook.
3.
Obtain the My Documentum for Microsoft Outlook Server URL. Ask your My Documentum for Microsoft Outlook administrator for details if you do not already have this information available.
Configuring WebSEAL server for certificate authentication IBM Tivoli Access Manager for e-business WebSEAL is a high-performance, multi-threaded web server that applies fine-grained security policy to a protected network. WebSEAL incorporates back-end web application server resources into its security policy, and can provide single sign-on (SSO) solutions. WebSEAL acts as a reverse web proxy by receiving HTTP or HTTPS requests from a web browser and delivering content from its own web server or from back-end web application servers. Requests passing through WebSEAL are evaluated by its own authorization service to determine whether the user is authorized to access the requested resource. EMC Documentum can integrate with WebSEAL, its SSO solution, or any other SSO solution supported by WebSEAL.
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
21
Installing My Documentum for Microsoft Outlook
The related IBM documentation at http://publib.boulder.ibm.com/infocenter/tivihelp/v2r1/index.jsp provides more information about installing and configuring the WebSEAL server. The development guide or installation guide for your application provides more information about configuring Documentum applications to enable WebSEAL authentication. My Documentum for Microsoft Outlook supports only optional certificate authentication mode for WebSEAL.
WebSEAL SSO authentication at My Documentum for Microsoft Outlook My Documentum for Microsoft Outlook uses optional certificate authentication provided by WebSEAL server to leverage SSO capabilities. There are two authentication flows when using WebSEAL. First, Client authenticates itself to WebSEAL proxy using client certificate and gets back the valid session cookie. Then, Content Server authenticates the user against Documentum repository using DFC privileged authentication mechanism. DFC privileged authentication establishes trusted login between DFS and Content Server. Refer Figure 3, page 22. Figure 3. Authentication flow at stack components
Enabling optional certificate authentication mode in WebSEAL server Perform the following to enable optional certificate authentication mode in WebSEAL server: 1.
Turn off all default authentication mechanisms like basic and forms authentication con before figuring certificate authentication.
2.
Modify the following properties in the WebSEAL configuration file found in C:\Program Files\Tivoli\PDWeb\etc\ webseald-default.conf: [certificate] accept-client-certs = optional [SSL] webseal-cert-keyfile = “Location of the key database file where certificates are located” Example: webseal-cert-keyfile = C:/Program Files/Tivoli/PDWeb/www-default/certs/pdsrv.kdb webseal-cert-keyfile-stash = “Location of the file where password for KDB is located” Example: webseal-cert-keyfile-stash =C:/Program Files/Tivoli/PDWeb/www-default/certs/pdsrv.sth webseal-cert-keyfile-label = “Name of the server certificate” Example: webseal-cert-keyfile-label = servercert [authentication-mechanisms] cert-ssl = “Location of sslauthn.dll " & -cfgfile [location of webseal instance configuration file]”
22
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Installing My Documentum for Microsoft Outlook
Example: cert-ssl = C:/Program Files/Tivoli/PDWebRTE/bin/sslauthn.dll & -cfgfile [C:/Program Files/Tivoli/PDWeb/etc/webseald-default.conf]
3.
For an improved performance, preserve the cookie names: [preserve-cookie-names] name=JSESSIONID
4.
Restart the WebSEAL server after all modifications.
Creating an SSL junction between WebSEAL server and My Documentum for Microsoft Outlook server Perform the following to create an SSL junction between WebSEAL server and My Documentum for Microsoft Outlook server: >server task instance_name-webseald-host_name create -t type -D "dn" -K "keylabel" -s -j -e utf8_uri -c iv-user-l -p port -h host junction_point
For example to create SSL junction to the backend server with IP 10.32.122.192 listening on SSL port 8443: >server task default-webseald-WY-WEBSEAL3 create -f -t ssl -D "CN=jboss,O=dfs,C=CN" -K "webseal3" -s -j –e utf8_uri -c iv_user_l -p 8443 -h 10.32.122.192 /ssl192
Creating a certificate user in LDAP registry Perform the following to create a certificate user in LDAP registry: 1.
Log in to policy server using pdadmin command-line utility. >pdadmin –a sec_master –p
2.
Create a user in the LDAP registry: >user create [–gsouser] [–no-password-policy] username dn cn sn password
For example: >user create -gsouser -no-password-policy testuser “cn=testuser,o=DCO,c=IN” testuser testuser password
3.
Make the account user valid: >user modify account-valid {yes|no}
For example: >user modify testuser account-valid yes
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
23
Installing My Documentum for Microsoft Outlook
Enabling DFC privileged authentication for WebSEAL certificate authentication in the My Documentum for Microsoft Outlook application server Perform the following to enable DFC privileged authentication for WebSEAL certificate authentication in the My Documentum for Microsoft Outlook application server: Include the following in the authorized-service-handler-chain.xml file: Previlaged DFC authentication com.invisiblecrm.smartfolder.dfs.utils.PrivilegedDfcJaxwsHandler
Note: To enable DFC privileged authentication for Content Server repository user, refer the EMC Documentum Documentum Administrator 7.1 User Guide.
Change at the My Documentum for Microsoft Outlook Client to enable SSL connection with self-signed certificates Perform the following change at the My Documentum for Microsoft Outlook Client to enable SSL connection with self-signed certificates: • Set "InvokeCustomCertificatePolicy" to "true" at outlook.exe.config (located at \\Program Files\Microsoft Office\) to override .NET framework default certificate policy. This is not required in production environment where certificates issued by valid certificate authorities are being used. * OFFICE12 for Outlook 2007 * OFFICE14 for Outlook 2010 * OFFICE15 for Outlook 2013
Enabling Kerberos based authentication on Windows 7 and Windows Server 2008 R2 machines Documentum Content Server supports Kerberos authentication, which provides a secure Single-Sign-On (SSO) solution using Windows Integrated Authentication. Content Server supports Kerberos using the Microsoft Active Server Domain Services for Kerberos Key Distribution Center (KDC) services. Enabling Kerberos authentication in My Documentum for Microsoft Outlook and choosing to log in using SSO authentication can result in a marginal degradation of performance. From version 6.6 onwards, My Documentum for Microsoft Outlook provides SSO-based authentication. The EMC Documentum Foundation Services 7.1 Deployment Guide contains more information on SSO authentication.
24
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Installing My Documentum for Microsoft Outlook
To select the DES and RC4 Kerberos encryption types 1. 2.
Open gpedit.msc to configure the machine policy by navigating in the Windows Start menu to Start > Run. Type gpedit.msc. The Group Policy Management Console (GPMC) is displayed.
3.
In the navigation pane, double-click the Local Computer Policy node. The Local Computer Policy options are listed.
4.
Double-click the Computer Configuration node. The Computer Configuration Settings options are listed.
5.
Double-click the Windows Settings node. The Windows Settings options are listed.
6.
Double-click the Security Settings node. The Security Settings policies are listed.
7.
Double-click the Local Policies node. The Local Policies options are listed.
8.
Double-click the Security Options node. The Security options are listed.
9.
Double-click the Network security: Configure encryption types allowed for Kerberos option. Network security: Configure encryption types allowed for Kerberos dialog box is displayed.
10. Select the DES_CBC_MD5 and RC4_HMAC_MD5 encryption types. 11. Click OK. 12. Select File > Exit.
To refresh expiring Ticket Granting Ticket Ticket Granting Tickets (TGT) are periodically refreshed on Windows Operating System. In Windows XP SP2 Operating System, TGT does not get refreshed automatically, and it expires. When TGT expires, authentication fails. To avoid this problem, apply the Windows patch KB906681 available at location: http://support.microsoft.com/kb/906681. The TGT gets automatically refreshed.
Configuring Kerberos on Content Server in a Linux environment To configure Kerberos on Linux environment: 1.
Install 7.1 Content Server.
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
25
Installing My Documentum for Microsoft Outlook
2.
Create kerberos folder in $DOCUMENTUM/dba/auth/kerberos.
3.
Before you replace any binaries listed, perform the following: • Stop the Java method server. • Stop the Content Server. • Create a backup of the existing binaries.
4.
Copy binaries to the following locations: $DOCUMENTUM/dba/auth/libkerberos.so $DM_HOME/bin/libkrb5.so.3 $DM_HOME/bin/libcom_err.so.3 $DM_HOME/bin/libgssapi_krb5.so.2 $DM_HOME/bin/libk5crypto.so.3
5.
Start Content Server and Java method server.
6.
Include the following information in the /etc/krb5.conf file to include the Linux machine in the AD machine domain: • Under the [realms] tag, include the following: QA2008.COM = {kdc = 10.31.107.98 admin_server = 10.31.107.98}
• Under the [domain_realm] tag, include the following: .qa2008.COM = QA2008.COM
• Under the [libdefaults] tag: comment the following line: default_realm = EXAMPLE.COM and include the following: default_realm = QA2008.COM
7.
Copy Keytab files to $DOCUMENTUM/dba/auth/Kerberos folder and restart the docbase using the following command: /dm_start_(docbasename) -otrace_authentication
This command enables authentication trace in the dm_krb_docbasename.log file. 8.
Set the following encryption standard entries in the /etc/krb5.conf file: default_tkt_enctypes = aes128-cts default_tgs_enctypes = aes128-cts
CA Siteminder support CA Siteminder offers SSO functionality across single and multiple domains, simplifying the use of applications across various application servers, and across multiple operating systems. It also provides policy-based centralized control of user authentication and access management. My Documentum for Microsoft Outlook supports certificate-based Single Sign-On using Siteminder.
26
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Installing My Documentum for Microsoft Outlook
To use My Documentum for Microsoft Outlook in a certificated based SSO setup, perform the following: • Configure My Documentum for Microsoft Outlook EAR file • Configure Siteminder WebAgent
Configuring My Documentum for Microsoft Outlook EAR file Modify the dfs-sso-config.properties file under emc-dfs-rt.jar in WEB_INF/lib with requisite SSO type information. The netegrity Siteminder properties are as follows: sso.type = dm_netegrity user.header.name = SM_USER password.cookie.name = SMSESSION
After performing the modifications, include the updated emc-dfs-rt.jar file in the My Documentum for Microsoft Outlook EAR file.
Configuring Siteminder WebAgent The Post-Preservation feature must be disabled for My Documentum for Microsoft Outlook to work. To disable this feature, set the following in the WebAgent LocalConfig file: PreservePostData=”NO”
My Documentum for Microsoft Outlook does not support 2-way SSL for certificate-based Siteminder SSO. The proxy/web server must be set in Optional certificate mode. For Apache proxy, the httpd.conf file must contain the following options: SSLVerifyClient optional SSLOptions +StdEnvVars +CompatEnvVars SSLVerifyDepth 10
Installing My Documentum for Microsoft Outlook on client machines To install My Documentum for Microsoft Outlook: 1.
Close Microsoft Outlook.
2.
Begin the installation process by running (double-clicking on) the My-Documentum-forMicrosoft-Outlook-7.1.0.exe file.
3.
The Welcome to the InstallShield Wizard for My Documentum for Microsoft Outlook screen is displayed. Click Next to continue.
4.
The My Documentum for Microsoft Outlook user License Agreement is displayed. Once you have read the license agreement and agree to its terms, click I accept the terms of the license agreement, then click Next to continue the installation.
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
27
Installing My Documentum for Microsoft Outlook
5.
The Customer Information screen is displayed. Enter your user name and company name into the corresponding fields. Click Next to continue.
6.
The Configuration options screen is displayed. Specify the My Documentum for Microsoft Outlook Server URL. The Server URL can be entered in the form of server name:8888, or IP-address:8888, where 8888 is the port number and is always preceded by a colon. An example of the server address: http://our-dco-server:8888/
or, if you are given the IP address of the server, you would use, for example, http://10.24.3.7:8888
Contact your My Documentum for Microsoft Outlook administrator for this information. Click Next to continue. 7.
The Storage Path screen is displayed. This screen provides you an option to select the default storage location. If you select YES, then no storage folder configuration takes place after installation and it is a predefined location. If you select NO, a screen to enter the custom install path appears. Select the desired option, and click Next to continue. Note: If you set the MDMO default storage path to a network location, then users must be given access privilege to that location as the installation creates a folder there. If you select NO and if you have not configured the storage path during installation, then during login, a screen to enter the folder location path appears.
8.
The Ready to Install the Program screen is displayed. If you are ready to install, click the Install button to confirm the beginning of the installation. To review or modify previous changes, click Back.
9.
The InstallShield Wizard Complete screen appears after the application has been successfully installed on your computer. Click Finish.
Upgrading to My Documentum for Microsoft Outlook 7.1 When upgrading to My Documentum for Microsoft Outlook from 6.7.1 or 6.7.3, there are three options: Options
Steps
Option 1
1.
Upgrade 6.7.1 or 6.7.3 client to 7.1 client. Note: Upgraded 7.1 clients can still be pointed to 6.7.1 or 6.7.3 Application Server.
2.
After all the clients are upgraded to 7.1, install the 7.1 dar and upgrade the application server to 7.1.
Note: During the upgrade, it is important to provide the application server URL.
28
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Installing My Documentum for Microsoft Outlook
Options
Steps
Option 2
1.
Install 7.1.dar.
2.
Configure the 7.1 Application Server.
3.
Upgrade 6.7.1 or 6.7.3 client to 7.1. During the upgrade provide the 7.1 Application Server URL.
Note: The existing 6.7.1 or 6.7.3 clients must point to 6.7.1 or 6.7.3 Application server and clients upgraded to 7.1 must point to 7.1 Application Server. Option 3
Upgrade both client and server simultaneously. Clients upgraded from 6.7.1 or 6.7.3 to 7.1 can still work with the existing 6.7.1 or 6.7.3 Application server. However, if you upgrade the server first to 7.1 from 6.7.1 or 6.7.3, then the 6.7.1. or 6.7.3 clients will not be able to connect to the 7.1 Application server.
When upgrading from MDMO 6.7 SP1 or 6.7 SP2 to 7.1: 1.
Close the My Documentum node and perform the reset client operation.
2.
Install MDMO 7.1 .dar.
3.
Configure the 7.1 Application Server.
4.
Upgrade the 6.7 SPx client to 7.1. Note: If the migration is already performed from emcmf to dm_document, you cannot access these objects until you upgrade the application server to 7.1. During the upgrade, it is mandatory to provide the application server URL. After you upgrade the application server to 7.1, update existing DCO profiles to dm_document because the import object type and EMCMF emails will not be displayed in Microsoft Outlook.
Uninstalling My Documentum for Microsoft Outlook You can uninstall My Documentum for Microsoft Outlook either by using Add or Remove Programs option in Control Panel or by running the client setup file (My–Documentum-for-Microsoft-Outlook-7.1.0.exe). The steps for each procedure are as follows. Before uninstalling, ensure that Microsoft Outlook is not running.
To uninstall My Documentum for Microsoft Outlook by using Programs and Features: 1.
From the Start menu, select Control Panel.
2.
Select Programs and Features.
3.
From the list of programs that you can remove, select My Documentum for Microsoft Outlook.
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
29
Installing My Documentum for Microsoft Outlook
4.
Click Uninstall.
5.
At the prompt, click Yes to confirm that you want to remove the My Documentum for Microsoft Outlook application. If prompted to select an Outlook profile, do so.
6.
After the application has been successfully uninstalled from your computer, the Uninstall Complete screen appears. Click Finish. If prompted to reboot your computer, do so now.
Note: During the uninstall, installer backs-up the objects which are not resolved in the system. The objects are backed up at %userprofile%\emc.
To uninstall My Documentum for Microsoft Outlook using the installation file: 1.
On your computer, locate the My-Documentum-for-Microsoft-Outlook-7.1.0.exe file. Double-click the file to initiate the uninstall process.
2.
The Installation Wizard screen appears. Select Remove to uninstall My Documentum for Microsoft Outlook. Click Next.
3.
At the prompt, click Yes to confirm that you want to remove the My Documentum for Microsoft Outlook application.
4.
After the application has been successfully uninstalled from your computer, the Uninstall Complete screen appears. Click Finish.
Installing and uninstalling the My Documentum for Microsoft Outlook client using the silent installation method You can install and uninstall My Documentum for Microsoft Outlook using the silent installation method. You may wish to deploy the My Documentum for Microsoft Outlook 7.1 client on end-user machines via an automated tool such as Microsoft Systems Management Server (“SMS”). Note: The procedure for silent installation and uninstallation is the same.
To deploy or uninstall the My Documentum for Microsoft Outlook client automatically: 1.
Create a setup.iss file and at the command prompt (in Admin mode), type the following: My-Documentum-for-Microsoft-Outlook-7.1.0.exe -a -r -f1C:\setup.iss
2.
Run the installer by typing the following at the command prompt (in Admin mode): My-Documentum-for-Microsoft-Outlook-7.1.0.exe -a -s -f1C:\setup.iss
Note: You can change the command to indicate any custom paths to point to a customized location of the setup.iss file in either of the two command lines above. Running the silent (automated) installation of the My Documentum for Microsoft Outlook 7.1 client will update the Outlook client software, so that the next time you log in to Microsoft Outlook, you will see the My Documentum menu in the Outlook menu bar, and the My Documentum Folders node in
30
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Installing My Documentum for Microsoft Outlook
the Outlook left (navigation) pane. After this update, you have to configure the My Documentum for Microsoft Outlook client with the login credentials and other settings.
Troubleshooting Troubleshooting information for end-user client software issues can be found in the Chapter 5, Troubleshooting section at the end of this document. In order to troubleshoot client-side issues, consult the log files which are located by default at:\Application Data\Documentum\Client for Outlook\Logs on the client PC.
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
31
Installing My Documentum for Microsoft Outlook
32
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
Chapter 3 Managing Repositories and Profiles
The management of Documentum repositories, including the setup and administration of My Documentum for Microsoft Outlook profiles are handled within Documentum Administrator via a web browser. Documentum Administrator is the front-end user interface for repository and My Documentum for Microsoft Outlook administration, and is installed separately from My Documentum for Microsoft Outlook. For complete information on how to install Documentum Content Server and Documentum Administrator, refer to the EMC Documentum Content Server Installation Guide, version 7.1 and the EMC Documentum Content Server Administration Guide, version 7.1, both of which can be downloaded from EMC Online Support (https://support.emc.com): Those two documents provide you with instructions on how to install the Content Server and repositories, as well as how to manage Content Server functionalities. My Documentum for Microsoft Outlook profiles, views, search settings and more are administered via the Documentum Administrator interface. See the section entitled Using Documentum Administrator (DA) for My Documentum for Microsoft Outlook management for instructions on configuring and managing My Documentum for Microsoft Outlook through Documentum Administrator in this document. Note: Use the Documentum Administrator 6.7 SP1 Patch 06 or later. Refer to Applying the Documentum Administrator hotfix (DCO-9159), page 67 for applying the Documentum Administrator hotfix, specific to My Documentum for Microsoft Outlook. The present guide does not attempt to include that information, as it is assumed that you have already installed and configured those components.
The dco_system_settings.xml and dco_custom_settings.xml files Administration tasks for My Documentum for Microsoft Outlook version 7.1 are performed via Documentum Administrator. However, many of the settings that are configured through the Documentum Administrator browser interface are written to configuration files called dco_system_settings.xml and dco_custom_settings.xml, located by default under Cabinets>System>Applications>DCO, and created during the installation process. Note: After updating the XML (dco_system_settings.xml or dco_custom_settings.xml), clear the Application Server cache and restart the Microsoft Outlook.
EMC Documentum My Documentum for Microsoft Outlook Version 7.1 Administration Guide
33
Managing Repositories and Profiles
dco_system_settings.xml The dco_system_settings.xml file consists of sections affecting both server and client environments. Server settings that are listed in this XML file include, among others, the list of available repositories, object types, and access rights. Client-side options that are controlled in this file such as the minimum supported client software version, and many of the Client Settings options viewed in the Documentum Administrator browser screens. Table 1, page 34 describes the settings that can be configured in the dco_system_setting.xml file: Table 1. dco_system_setting.xml file settings
Settings
Description
Valid values
Default value
This setting allows you to ignore the repository setting and sets the offline use for all users or allows you to enable the offline mode.
True: Sets the offline use for all users.
true
Example:
False: Enable the offline mode for specific users only in a repository.
