C Advanced Configuration

This section covers these topics:

Important:

This section deals with advanced configuration. End users typically do not need to perform these actions. Make sure that you consult with your system administrator before doing any of the tasks in this section.

C.1 Setting Advanced Windows Explorer Integration Options

Desktop Integration Suite offers a number of advanced configuration options that enable you to fine-tune the way Windows Explorer integration works on your computer. To see the options dialog, right-click the Oracle Content Servers icon on your desktop while simultaneously holding the Shift and Ctrl keys. The context menu then includes an option called Properties... (Figure C-1). Choose this option to open the Windows Explorer Integration Properties dialog (Figure C-2).

Figure C-1 Expanded Context Menu of Oracle Content Server Icon on Desktop

Right-click menu of Oracle Content Server icon on desktop.

Figure C-2 Windows Explorer Integration Properties Dialog

Description of Figure C-2 follows
Description of "Figure C-2 Windows Explorer Integration Properties Dialog"

Important:

Do not modify any of these settings unless specifically instructed to do so, for example by a support engineer. Changing these settings may break your Desktop Integration Suite client installation!
Element Description
Enable error logging Select this check box if you want errors that occur during software execution to be written to a log file. This may be useful for troubleshooting purposes. The log file is called WebDAVClient.log, and it is located in the Windows temp directory (as defined by the %TEMP% system variable).
Maximum logfile size (MB) Specify the maximum file size that the log file is allowed to have (in megabytes). Once the log file exceeds this size limit, it is deleted and a new log file is started.
View Log... Click this button to view the current log file.
Open documents with native URLs Select this check box if you want URLs to be encoded in the operating system's native encoding (for example, Big-5) rather than Unicode.
Escape native URLs in %XX format Select this check box to encode all URL bytes in the %XX escaped format, except for the following characters: a-z A-Z 0-9 ! # $ & ' ( ) + - . ; = _.
Perform file operations with batch semantics Select this check box to attempt to check in files and directories in batches instead of individually. This does not use the WEBDAV spec.
Use WebDAV URL when opening files with the following extensions Select this check box if you want files with the specified file extensions to be opened via WebDAV rather than downloading them and then opening them from the offline cache. In other words, the WebDAV URL is provided to the application, so that it acts as a WebDAV client. Use commas to separate the file extensions.
Make 'Open' the default file action, not 'View' Select this check box if you want a content file to be opened rather than viewed when you select it in Windows Explorer and press Enter or double-click it. For a comparison of these two actions, see Section 8.2.4, "Content Management Actions on Files."
Remove Passwords Click this button to remove the cached passwords for all content server connections on your computer. This forces a login prompt the next time you connect to a server, which may be useful if the incorrect login credentials were inadvertently cached for a content server.
Launch document URLs with DDE Select this check box to attempt to open URLs using a DDE transaction instead of a ShellExecute API call. The connection and transaction are timeout values (in milliseconds) that help to ascertain if the DDE conversation has succeeded.
Launch document URLs with associated executables Select this check box to issue a call to ShellExecute using the document's associated executable as the exe and the URL as the document argument. (This is done for URLs.)
Launch local documents with associated executables Select this check box to issue a call to ShellExecute using the document's associated executable as the exe and the file path as the document argument. (This is done for files on the file system; that is, those that are checked out and cached locally on the disk.)
Unquote secondary launch API Select this check box to call ShellExecute without the document path surrounded by quotes.
OK Click this button to close this dialog and submit any changes you made.
Cancel Click this button to close this dialog and cancel any changes you made.

C.2 Configuring Form-Based Login

Your organization may use separate identity and access management software that provides secure, form-based login screens to authenticate users and control what they have access to on the network. Desktop Integration Suite is compatible with form-based logins. To set this up, system administrators need to add a comment to the login page so that Desktop Integration Suite identifies an HTML response as the forms-based login page. Users, as a result, will see the form-based login instead of the standard content server login.

Perform these steps to configure form-based login:

  1. Locate the login form on the file system (for example, login.fcc for Netegrity SiteMinder). The location of this form depends on how the authentication system was set up in your organization.

  2. Open the form in a text editor.

  3. Add the following comment (with no spaces) to the HEAD section of the form:

    <!--IdcClientLoginForm=1-->
    

    Important:

    The form's HEAD section may contain a lot of code; for example, many META tags or JavaScript code. The delivered page must have that HTML comment (or token) in the first 5,000 characters of the response, otherwise the server connection may fail. The software on the client computer sniffs the response for the <!--IdcClientLoginForm=1--> token (using a strict string search) and route through the prompting code if it is found. It is encoded as an HTML comment so that regular browsers do not show the token when they attempt to log in. (If it is Idoc Script, then the parser removes that bit of code from the delivered page, and the client-side browser will not see anything in the page.)
  4. Save and close the form.

The next time users connect to a content server using Desktop Integration Suite, they will see a login form, where they can provide their username and password to log on.

C.3 Customizing the Form-Based Login Regular Expression

By default, Desktop Integration Suite 11g uses the following regular expression to identify a form-based login:

<!--IdcClientLoginForm=1-->|
<form .*sso.* name=\"LoginForm\"|
<form *name=\"loginForm\"

This regular expression is configurable in the Windows Registry. The code first looks in the following place:

[HKEY_CURRENT_USER\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV\Servers\SERVER_NAME]
"Form Based Logins Reg Exp"="REGULAR_EXPRESSION"

Then in:

[HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV\Servers\SERVER_NAME]
"Form Based Logins Reg Exp"="REGULAR_EXPRESSION"

Then in:

[HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV\Servers\SERVER_NAME]
"Form Based Logins Reg Exp"="REGULAR_EXPRESSION"

And finally in:

[HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV]
"Form Based Logins Reg Exp"="REGULAR_EXPRESSION"

If no custom regular expression is defined in any of these Windows Registry locations, the default one is used.

C.4 Changing the Location of the Local File Cache

Desktop Integration Suite uses temporary storage cache on the file system of client computers.For more information, see Section 8.2.3, "Local Caching of Content Files." By default, this storage cache is located in the following directory:

  • Windows XP: C:\Documents and Settings\USER\Application Data\Stellent\SyndicationCache

  • Windows Vista and Windows 7: C:\Users\USER\AppData\Stellent\SyndicationCache

However, this may not comply with your organization's standards for where data should be stored on client computers. To accommodate for this, you can use the following Windows Registry keys to modify the location of the temporary storage cache on a client computer (the paths below are examples):

Important:

Check with your system administrator whether you are allowed to make changes to the Windows registry. Also, changing the registry, if done incorrectly, may affect the stability of your computer. Do not edit the Windows registry unless you are confident about doing so.
[HKEY_CURRENT_USER\Software\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV]
"Syndication Dir"="H:\\Application Data\\SyndicationCache"

Please note the following:

  • These registry values are not included by default; you need to add them manually.

  • The registry values are string values.

  • Any files already in the offline cache are not automatically moved from the old to the new location. It is therefore recommended that you empty your offline cache before changing its location. For more information, see Appendix B, "Using the Offline Content Manager."

  • The offline cache location has subdirectories for each defined server connections.

  • Make sure that you restart your computer (or log off and log back on) after modifying this setting.

  • When entering the path in Registry Editor, use single backslashes (\) to separate directories in the path. However, if you export the registry branch to a file, the value will contain double backslashes (\\).

  • Setting these registry keys affects the offline cache location for all defined server connections. You cannot change the cache location setting for individual content servers. However, the settings are user-specific, so if there are multiple user accounts on the computer, the settings apply to the current user only.

C.5 Showing or Hiding Productivity Nodes in the Integration Hierarchy

When you connect to an Oracle Content Server 11g instance, the server tree in the integration hierarchy will include a number of productivity nodes:

  • My Checked-Out Content

  • My Saved Queries

  • My Workflow Assignments

For more information on these nodes, see Section 6.4, "Oracle Content Server Repositories." .

You can use the following Windows Registry keys to hide one or more of these productivity nodes in the integration hierarchy:

[HKEY_CURRENT_USER\Software\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV\DisabledProductivityNodes]
"MyCheckedOutContent"=dword:00000001
"MyWorkflowAssignments"=dword:00000001
"MySavedQueries"=dword:00000001

Important:

Check with your system administrator whether you are allowed to make changes to the Windows registry. Also, changing the registry, if done incorrectly, may affect the stability of your computer. Do not edit the Windows registry unless you are confident about doing so.

Please note the following:

  • These registry values are not included by default; you need to add them manually.

  • The registry values are dword values.

  • Setting the value to '0' shows the productivity node (which is also the default).

  • Make sure that you restart your computer (or log off and log back on) after modifying these settings.

  • Setting these registry keys affects the productivity nodes of all defined server connections. You cannot change the node display settings for individual content servers. However, the settings are user-specific, so if there are multiple user accounts on the computer, the settings apply to the current user only.

C.6 Disabling Automatic Reopening of Documents After Check-ins

After you check a Microsoft Office document in to a server using the Check In option on the Oracle UCM menu or ribbon (a "silent check-in"), Desktop Integration Suite automatically checks out that document again and reopens it in the Office application for you to edit further if you want.

You can use the following Windows Registry key to turn off this behavior, which means a document is closed after check-in and you must reopen it manually if you want to edit it again:

  • 32-bit Microsoft Office on 32-bit Windows:

    [HKEY_LOCAL_MACHINE\Software\Oracle\Universal Content Management\Desktop Integration Suite]
    "Check Out After Silent Checkin"=dword:00000000
    
  • 32-bit Microsoft Office on 64-bit Windows:

    [HKEY_LOCAL_MACHINE\Software\Wow6432Node\Oracle\Universal Content Management\Desktop Integration Suite]
    "Check Out After Silent Checkin"=dword:00000000
    
  • 64-bit Microsoft Office on 64-bit Windows:

    [HKEY_LOCAL_MACHINE\Software\Oracle\Universal Content Management\Desktop Integration Suite]
    "Check Out After Silent Checkin"=dword:00000000
    

Important:

Check with your system administrator whether you are allowed to make changes to the Windows registry. Also, changing the registry, if done incorrectly, may affect the stability of your computer. Do not edit the Windows registry unless you are confident about doing so.

Please note the following:

  • This registry value is not included by default; you need to add it manually.

  • The registry value is a dword value.

  • Setting the value to '0' prevents documents from being checked out and reopened automatically after check-in. The default value is '1'.

C.7 Disabling Overriding the Default Content Profile Selection

If you are prompted to provide metadata when dragging and dropping or copying and pasting a new file into a folder that has a default content profile assigned to it, you can normally change that profile in the content check-in dialog (see Section A.13, "Check In Content Dialog (Metadata Prompt)").

You can use the following Windows Registry key to disable the ability to override the default content profile selection:

  • 32-bit Microsoft Office on 32-bit Windows:

    [HKEY_LOCAL_MACHINE\Software\Oracle\Universal Content Management\Desktop Integration Suite]
    "Metadata Prompts Allow Any Profile"=dword:00000000
    
  • 32-bit Microsoft Office on 64-bit Windows:

    [HKEY_LOCAL_MACHINE\Software\Wow6432Node\Oracle\Universal Content Management\Desktop Integration Suite]
    "Metadata Prompts Allow Any Profile"=dword:00000000
    
  • 64-bit Microsoft Office on 64-bit Windows:

    [HKEY_LOCAL_MACHINE\Software\Oracle\Universal Content Management\Desktop Integration Suite]
    "Metadata Prompts Allow Any Profile"=dword:00000000
    

Important:

Check with your system administrator whether you are allowed to make changes to the Windows registry. Also, changing the registry, if done incorrectly, may affect the stability of your computer. Do not edit the Windows registry unless you are confident about doing so.

Please note the following:

  • This registry value is not included by default; you need to add it manually.

  • The registry value is a dword value.

  • Setting the value to '0' prevents you from changing the default content profile selection in the content check-in dialog. The default value is '1'.

C.8 Configuring the Title and File Name of Checked-in E-mails

Oracle Content Server administrators can use configuration variables on the server to specify what the title and file name of checked-in e-mail messages will be.

Configuration Variables

There are four configuration variables that control the title and file name of checked-in e-mail messages:

  • EmailMetadataAlwaysSetTitle: With this variable set to 'true', the title will always be the subject line of the e-mail message. If it is set to 'false', then the title will be the e-mail message ID (for received messages, as retrieved from the header) or UUID (for drafts or sent messages), unless it is changed to the subject line based on the EmailMetadataSetTitleIfMessageId variable below. The default is 'false'.

  • EmailMetadataSetTitleIfMessageId: With this variable set to 'true', if the title is identical to the file name (without file extension), then the title will be set to the subject line. If it is set to 'false,' then the title will not be changed. The default is 'true'.

  • EmailMetadataAlwaysRenameFile: With this variable set to 'true', the file name will always be the subject line of the e-mail message. If it is set to 'false', then the file name will be the e-mail message ID (for received messages, as retrieved from the header) or UUID (for drafts or sent messages), unless it is changed to the subject line based on the EmailMetadataRenameFileIfMessageId variable below. The default is 'false'.

  • EmailMetadataRenameFileIfMessageId: With this variable set to 'true', if the title is identical to the file name (without file extension), then the file name will be set to the subject line. If it is set to 'false,' then the file name will not be changed. The default is 'true'.

Note:

If the subject line is empty, then the title or file name will revert to their original value (that is, the value it had before the change).

Setting the Configuration Variables

Perform these steps to configure the title or file name of checked-in e-mail messages:

  1. Log in to Oracle Content Server as a system administrator.

  2. Open the Administration tray or menu, and click Admin Server.

    The Content Admin Server page is displayed.

  3. Click General Configuration on the left.

  4. In the Additional Configuration Variables section, add the following lines as needed:

    EmailMetadataAlwaysSetTitle=true|false
    EmailMetadataSetTitleIfMessageId=true|false
    EmailMetadataAlwaysRenameFile=true|false
    EmailMetadataRenameFileIfMessageId=true|false
    
  5. Click Save.

  6. Restart the content server.

Examples

Here are some usage examples:

  • Both the title and file name should always be the subject line (which is the default situation):

    EmailMetadataAlwaysSetTitle=false
    EmailMetadataSetTitleIfMessageId=true
    EmailMetadataAlwaysRenameFile=false
    EmailMetadataRenameFileIfMessageId=true
    

    Note:

    You could also use the following variable settings to accomplish this:
    EmailMetadataAlwaysSetTitle=true
    EmailMetadataAlwaysRenameFile=true
    

    However, this may change the title and file name in situations where this may not be desirable. For example, if you copy an e-mail to your desktop and then use Windows Explorer to drag and drop the file into an Oracle Content Server contribution folder with metadata prompting, you may change the title in the check-in form from the subject line to something else. In that case, the automatic renaming should not take place.

  • Both the title and file name should always be the message ID or UUID:

    EmailMetadataAlwaysSetTitle=false
    EmailMetadataSetTitleIfMessageId=false
    EmailMetadataAlwaysRenameFile=false
    EmailMetadataRenameFileIfMessageId=false
    
  • The title should always be the subject line and file name should always be the message ID or UUID:

    EmailMetadataAlwaysSetTitle=false
    EmailMetadataSetTitleIfMessageId=true
    EmailMetadataAlwaysRenameFile=false
    EmailMetadataRenameFileIfMessageId=false