Skip Headers
Oracle® Fusion Middleware Installation Guide for Oracle WebCenter Interaction
10g Release 4 (10.3.3.0.0) for Unix and Linux

Part Number E14548-04
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

B Completing Installation of Oracle WebCenter Interaction Content Service for Documentum

If you installed Oracle WebCenter Interaction Content Service for Documentum, perform the following tasks to complete the installation:

Verifying Installation

Complete the steps on the Content Service for Documentum Installation Verification page. This page is located on your Oracle WebCenter Interaction Content Service for Documentum host computer, at http://RemoteServer:port/ptdctmcws/web/install/index.html.

Creating a Content Source

Create a content source to define the area of Documentum from which you want to import content. To create a content source, perform the following steps in the Oracle WebCenter Interaction Content Service for Documentum folder in the portal's Administrative Object Directory:

  1. Log in to the portal as an administrator.

  2. Click Administration.

  3. Open the Oracle WebCenter Interaction Content Service for Documentum folder.

  4. From the Create Object menu, select Content Source - Remote.

  5. In the Choose Web Service dialog box, choose the Oracle WebCenter Interaction Content Service for Documentum Web service.

  6. Configure the content source as described in the online help.

Stay logged in to the portal with the Oracle WebCenter Interaction Content Service for Documentum folder open for the next procedure.

Creating a Content Crawler

Create a content crawler to import content from the content source. To create a content crawler, perform the following steps in the Oracle WebCenter Interaction Content Service for Documentum folder of the portal's Administrative Object Directory:

  1. From the Create Object menu, select Content Crawler - Remote.

  2. In the Choose Content Source dialog box, choose the content source that you created in the previous procedure.

  3. On the Main Settings page of the Content Crawler Editor, select Import security with each document. Configure the rest of the content crawler as described in the online help.

Stay logged in to the portal with the Oracle WebCenter Interaction Content Service for Documentum folder open for the next procedure.

Creating a Job

To import content, you must associate the content crawler with a job and run the job. To create and run a job, perform the following steps in the Oracle WebCenter Interaction Content Service for Documentum folder of the portal's Administrative Object Directory:

  1. From the Create Object menu, select Job.

  2. Click Add Operation.

  3. Choose the content crawler that you created in the previous procedure.

  4. Choose the scheduling values for the job and click Finish.

  5. Name the job and click OK.

  6. When you are finished creating the job, ensure that the Oracle WebCenter Interaction Content Service for Documentum folder is associated with an automation service. For assistance, see the online help under Select Utilities, then Automation Service.

Configuring Security for Document Discovery

Portal users discover documents by browsing the Knowledge Directory and using portal search tools. In the portal, you manage document discovery with access control lists (ACLs) that are associated with portal directories.

If you want Documentum users to be able to browse records for crawled Documentum records in the portal with a similar level of privilege they experience in the Documentum environment, you map the configuration for Documentum user privileges to the portal ACL Read privilege and ensure that their credentials are used for document access.

Note:

You manage document discovery (display a record) as described in the following procedure. You manage document access (open a file) with click-through security, described in Configuring Security for Document Access.

To configure security settings for the Oracle WebCenter Interaction Content Service for Documentum:

  1. Deploy an authentication source (for example, LDAP) to manage Documentum users. For details, refer to Documentum documentation.

  2. Create a remote authentication source in the portal to import the Documentum users. For details, refer to the portal's online help or the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter Interaction.

  3. Configure the Global ACL Sync Map to associate the Documentum domain name with the authentication source:

    1. Log in to the portal as an administrator.

    2. Click Administration.

    3. From the Select Utility menu, select Global ACL Sync Map.

    4. Click Add Mapping and choose the authentication source you created in step 2.

    5. In the Domain Name column, click the edit icon and type the domain name of the Documentum users, usually the Lotus Domino Server name.

    6. Click Finish.

  4. Set the accessLevelMapping setting in config.xml as follows.

    Table B-1 accessLevelMapping Settings

    Setting Description

    <accessLevelMapping>2</accessLevelMapping>

    This is the default value and recommended value. This value enables portal document discovery for Documentum users with at least Browse access (Documentum Level 2 privilege).

    <accessLevelMapping>3</accessLevelMapping>

    This value restricts portal document discovery to Documentum users that have at least Read access (Documentum Level 3 privilege).


  5. If you modify config.xml, you must restart the Web application server to initialize changes.

    Note:

    If you modified the accessLevelMapping, you must rerun crawl jobs with Refresh ACLs selected on the Advanced Settings page of the Crawler Editor to realize the changes.

Stay logged in to the portal for the next procedure.

Configuring Security for Document Access

To enable portal users to open files imported into the portal, you configure click-through security. The following table describes click-through security methods.

Table B-2 Click-Through Security Methods

Click-Through Security Method

Description and Procedure

User Preferences

User Preferences is the default click-through security method for Oracle WebCenter Interaction Content Service for Documentum. The User Preferences method uses stored values for the Documentum user to enable access to the Documentum file.

To implement the User Preferences method, in the Oracle WebCenter Interaction Content Service for Documentum config.xml file (located by default in C:\Oracle\Middleware\wci\ptdctmcws\10.3.3\settings\config), set clickthroughAuthType as follows:

<clickthroughAuthType>1</clickthroughAuthType>

When users click through to a Documentum file for the first time, they are prompted for their Documentum credentials. The portal stores the credentials as user preferences, so the user does not have to enter them again. Users can modify the values of these credentials by clicking My Account, then Oracle WebCenter Interaction Content Service for Documentum.

Basic Authentication

Basic Authentication is one of two SSO click-through security methods you can implement for Oracle WebCenter Interaction Content Service for Documentum. It uses the authentication information for the user portal session to enable access to the Oracle WebCenter Interaction Content Service for Documentum file. The portal user name must match the Documentum user name; so the portal and Documentum users must be synchronized from a common source, such as LDAP.

Note: If you deploy this method, users must log in to the portal with both their user name and password. They cannot choose the Remember My Password option

To enable Basic Authentication click-through:

Disable User Preference click-through in the portal:

  1. In the portal's Administrative Object Directory, open the Oracle WebCenter Interaction Content Service for Documentum folder.

  2. Expand the Web Service section and click the Oracle WebCenter Interaction Content Service for Documentum Web service.

  3. On the left, under Edit Object Settings, click Advanced URL Settings.

  4. Remove the entry from the User Configuration URL box.

  5. On the left, under Edit Object Settings, click Preferences.

  6. Delete all User Preferences and click Finish.

Stay logged in to the portal with the Oracle WebCenter Interaction Content Service for Documentum folder open for the next procedure.

Enable Basic Authentication in the portal:

  1. In the portal PTConfig.xml file, set the CaptureBasicAuthenticationForPortlets parameter to 1.

  2. In the Oracle WebCenter Interaction Content Service for Documentum folder of the portal's Administrative Object Directory, click the Oracle WebCenter Interaction Content Service for Documentum Web service.

  3. On the left, under Edit Object Settings, click Authentication Settings.

  4. Select User's Basic Authentication Information.

  5. Restart the portal application server.

Enable Basic Authentication click-through on the Oracle WebCenter Interaction Content Service for Documentum host computer:

  1. In the Oracle WebCenter Interaction Content Service for Documentum config.xml file (located by default in C:\Oracle\Middleware\wci\ptdctmcws\10.3.3\settings\config), set clickthroughAuthType as follows:

    <clickthroughAuthType>2</clickthroughAuthType>
    

Trusted Authentication

Trusted Authentication is one of two SSO click-through security methods you can implement for Oracle WebCenter Interaction Content Service for Documentum. It uses the authentication information from an SSO partner to enable access to the Documentum file. The portal user name must match the Documentum user name; so the portal and Documentum users must be synchronized from a common source, such as LDAP.

To enable Trusted Authentication click-through:

Disable User Preference click-through in the portal:

  1. In the portal's Administrative Object Directory, open the Oracle WebCenter Interaction Content Service for Documentum folder.

  2. Expand the Web Service section and click the Oracle WebCenter Interaction Content Service for Documentum Web service.

  3. On the left, under Edit Object Settings, click Advanced URL Settings.

  4. Remove the entry from the User Configuration URL box.

  5. On the left, under Edit Object Settings, click Preferences.

  6. Delete all User Preferences and click Finish.

Stay logged in to the portal with the Oracle WebCenter Interaction Content Service for Documentum folder open for the next procedure.

Enable Trusted Authentication click-through on the Oracle WebCenter Interaction Content Service for Documentum host computer:

  1. In the Oracle WebCenter Interaction Content Service for Documentum config.xml file (located by default in C:\Oracle\Middleware\wci\ptdctmcws\10.3.3\settings\config), set clickthroughAuthType as follows:

    <clickthroughAuthType>3</clickthroughAuthType>
    
  2. In config.xml file, specify the following parameters for the SSO partner:

    <trustedUserName></trustedUserName>
    <trustedPassword></trustedPassword> 
    <trustedDomain></trustedDomain>
    

Note: The value for the <trustedPassword> parameter must be encrypted. Use the Encrypt Password link located at: http://RemoteServer:port/ptdctmcws/web/install/index.html

Admin Preference/Content Source Credential

If you prefer, you can set all click-through requests to use the credentials configured in the content source to retrieve documents upon click-through. This is referred to as the Super User click-through method.

To enable Super User click-through:

Disable User Preference click-through in the portal:

  1. In the portal's Administrative Object Directory, open the Oracle WebCenter Interaction Content Service for Documentum folder.

  2. Expand the Web Service section and click the Oracle WebCenter Interaction Content Service for Documentum Web service.

  3. On the left, under Edit Object Settings, click Advanced URL Settings.

  4. Remove the entry from the User Configuration URL box.

  5. On the left, under Edit Object Settings, click Preferences.

  6. Delete all User Preferences and click Finish.

Stay logged in to the portal with the Oracle WebCenter Interaction Content Service for Documentum folder open for the next procedure.

Enable content source credential click-through on the Oracle WebCenter Interaction Content Service for Documentum host computer:

  1. In the Oracle WebCenter Interaction Content Service for Documentum config.xml file (located by default in C:\Oracle\Middleware\wci\ptdctmcws\10.3.3\settings\config), set clickthroughAuthType as follows:

    <clickthroughAuthType>4</clickthroughAuthType>
    

Setting the Preferred Document Rendition

The Documentum server stores renditions of documents (versions of documents in various formats). By default, Oracle WebCenter Interaction Content Service for Documentum returns the native version of the document. To set a preference to always retrieve PDF, Word, or text renditions, modify the <preferredRenditionFormat> element in config.xml (located by default in C:\Oracle\Middleware\wci\ptdctmcws\10.3.3\settings\config) as follows.

Table B-3 Possible Preferred Rendition Format Element Values

Value

Definition

default

This is the default and returns the document in its native format.

pdf

This specifies that the document be returned in PDF format, if available.

msw8

This specifies that the document be returned in Microsoft Word format, if available.

crtext

This specifies that the document be returned in text format, if available.


Advanced Configuration: Tuning Documentum Server

The instructions in this section provide additional steps for configuring the Documentum Server to work with the Oracle WebCenter Interaction Content Service for Documentum. This includes configuration changes on the computer that hosts the Documentum client and on the Documentum Server. We strongly recommend tuning Documentum to work with the Oracle WebCenter Interaction Content Service for Documentum. A typical production environment would have all of the recommended settings in place.

Note:

For instructions on editing the dmcl.ini and server.ini files, refer to the Documentum eContent Server Administrator's Guide.

Modifying the dmcl.ini File on the Oracle WebCenter Interaction Content Service for Documentum Host

On all computers that host the Oracle WebCenter Interaction Content Service for Documentum, you can increase the max_session_count variable in the dmcl.ini file to allow for additional concurrent sessions. By default, the max_session_count is set to 10, meaning there can be 10 concurrent sessions to Documentum.

  • The number of Documentum sessions depends on the number of content crawlers you expect to run concurrently, as well as the number of users you expect to click through links concurrently. We recommend you set the max_session_count parameter accordingly. You can increase this setting later if you find that you run out of sessions or want to increase the number of content crawlers running simultaneously.

  • A session is started for each user with a unique user name/password that tries to click through to a Documentum document in the portal. The max_session_count must accommodate the estimated number of click through users to be handled concurrently.

Modifying the server.ini File on the Documentum Server

On the Documentum Server computer, you can change the settings in the server.ini file to allow for additional concurrent sessions.

  • The concurrent_sessions variable controls the number of connections the Documentum server can handle concurrently. This parameter should accommodate for the sum of all the max_session_count values in your environment.

If you plan to use the Oracle WebCenter Interaction Content Service for Documentum with several different docbases, you must modify the server.ini for each docbase. When making these configuration changes, consider the following:

  • As with any configuration changes, consider any hardware limitations.

  • The configuration settings depend on both existing and projected Documentum usage.

Troubleshooting

This section provides reference information for troubleshooting problems you might encounter when you use the Oracle WebCenter Interaction Content Service for Documentum. It includes the following topics:

Reviewing Log Files

If you encounter problems with crawl jobs, you can review the job logs provided through the portal's Automation Service Utility. For details, refer to the portal's online help or to the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter Interaction.

If you encounter problems with the Oracle WebCenter Interaction Content Service for Documentum, you can use Logging Spy to analyze portal communication.

The Oracle WebCenter Interaction Content Service for Documentum also logs communication on the Oracle WebCenter Interaction Content Service for Documentum host computer. To analyze logs specific to the Oracle WebCenter Interaction Content Service for Documentum processes, review the logs in install_dir/ptdctmcws/10.3.3/settings/logs.

Modifying Configuration Files

If you encounter error messages or logs that indicate misconfiguration in the Oracle WebCenter Interaction Content Service for Documentum config.xml file, you can modify the config.xml file to correct syntax or mismatched values.

The following table describes the syntax and values for config.xml configuration parameters.

Table B-4 Configuration Parameters

Configuration (sample value in bold) Value Description

baseURL

The URL for the Oracle WebCenter Interaction Content Service for Documentum application on the Oracle WebCenter Interaction Content Service for Documentum host computer.

When you configure Oracle WebCenter Interaction applications, always specify the fully qualified domain name for hosts to avoid host and domain name resolution mismatches.

<clickthroughAuthType>1</clickthroughAuthType>

<trustedUserName></trustedUserName>

<trustedPassword></trustedPassword>

<trustedDomain></trustedDomain>

The clickthroughAuth type parameter determines what type of authentication to use during click-through. The following values are valid:

  • 1 = User Preferences

  • 2 = Basic Authentication

  • 3 = Trusted Authentication

  • 4 = Admin Preferences

We recommend you set the accessLevelMapping value to 3 (read) if the clickThroughAuthType is either 4 or 5.

See Configuring Security for Document Discovery, for details on accessLevelMapping.

For Trusted authentication (option #3), credentials must be supplied below. The password must be encrypted. Follow the instructions on http://RemoteServer/ptdctmcws/web/install/index.html to generate an encrypted password.

<accessLevelMapping>2</accessLevelMapping>

The accessLevelMapping maps the Documentum access level setting to the portal's access privilege setting. Documentum users who have an access level setting that is equal to or higher than the value configured here will receive Read access in the portal. The default setting is 2 which means that Documentum users with Browse access or higher will receive Read access in the portal. Browse users will not, however, be able to click through and read the file contents because the Oracle WebCenter Interaction Content Service for Documentum verifies their credentials upon click-through and will not return the document unless they have Read access in Documentum. This is how the portal mimics the Documentum Browse-level security. An important dependency of this functionality is that userCredentialClickThrough must be set to true (see note above regarding setting this parameter to 3 if userCredentialClickThrough is set to false).

Valid values for this parameter are:

  • 2 = Browse

  • 3 = Read

<preferredRenditionFormat>default</preferredRenditionFormat>

Set the preferredRenditionFormat to the desired format for the document to be returned during click-through. The portal supports the following formats:

  • default (or blank): The document's native format

  • pdf: Acrobat PDF

  • msw8: Microsoft Word 97/2000

  • crtext: Text (Windows)

The setting is “preferred” because the Oracle WebCenter Interaction Content Service for Documentum will return the native format for documents if pdf/msw8/crtext is not available.

This option only applies if userCredentialClickThrough is set to true.


Diagnosing Unexpected Results

The following table summarizes cases in which users encountered unexpected results with the Oracle WebCenter Interaction Content Service for Documentum. You can use this table as a reference for particular issues you might encounter or as a guide for troubleshooting any similar problems you might encounter.

Table B-5 Troubleshooting

Symptom Solution

HTTP 500 Error on Clickthrough

Users have reported that the URL property in a document's Properties page is clickable, but the link returns an error.

The URL property is unique as it is clickable in the Document Properties page (accessed by clicking Properties for a document crawled into the portal). This is potentially confusing to users because the value is technical and clicking it results in an HTTP 500 error.

To avoid potential confusion, map the URL property in a content type to an Override Value, such as a space, which will prevent the technical URL from appearing in the Properties page.

Crawl fails with [DM_API_E_NO_SESSION] error: “There are no more available sessions.”

Increase the sessions in server.ini and dmcl.ini. For details, see Advanced Configuration: Tuning Documentum Server..

Port conflict, port in use, BindException

Port numbers for HTTP and HTTPS are configured in install_dir/ptdctmcws/10.3.3/settings/config/application.conf. Edit the http and https settings in application.conf to set the value to an available port. The service must be restarted to pick up changes made in the configuration file. Note that changes to a service port number require corresponding changes to any Web service or remote server settings that may reference that port number.

Memory consumption, Out of Memory Errors

The maximum amount of memory, in megabytes, that the service JVM will be allowed to use is controlled by the wrapper.java.maxmemory property, configured in the file install_dir/ptdctmcws/10.3.3/settings/config/wrapper.conf. For example, the following line shows a maximum memory setting of 1 GB:

wrapper.java.maxmemory=1024

The setting corresponds directly to the -Xmx parameter used by the java executable. The default value of this setting in the config file will be adequate for most configurations. For large production configurations, especially those in which the service is installed on a dedicated host computer, this value should be set as high as possible (for example, 1024 or 1536) but should always remain below the amount of physical RAM on the host computer.