This appendix describes the configuration tasks that must be performed to enable Desktop use.
This appendix includes the following sections:
Section E.1, "Using Custom Installation Options for the Client Software"
Section E.6, "Customizing the Form-Based Login Regular Expression"
The Desktop client software installers support a number of custom installation options that can help system administrators roll out the software:
You can use several command-line parameters to automate part of the installation process.
Use command-line parameters for the MSI installer as follows:
msiexec /q /i "DIS-11.1.x.yy-Setup.msi" OUTLOOK=0 INSTALLDIR="C:\Desktop"
For a 64-bit Windows system, use the following parameters:
msiexec /q /i "DIS-11.1.x.yy-x64-Setup.msi" OUTLOOK=0 INSTALLDIR="C:\Desktop"
The /i switch provides the name of the MSI package to be installed. INSTALLDIR is the installation directory of the Desktop software. The double quotation marks are required only if the parameter values have spaces in them, but using them for values with no spaces is acceptable (for example, "C:\Program Files\Desktop" as the installation directory).
For more information about the OUTLOOK parameter, see Section E.1.2, "Disabling Integrations."
The EXE installer can be invoked from the command line as follows:
DIS-11.1.x.yy-Setup.exe /v"WORD=0 EXCEL=0 INSTALLDIR=\"C:\Program Files\Desktop\""
For a 64-bit Windows system, use the following parameters:
DIS-11.1.x.yy-x64-Setup.exe /v"WORD=0 EXCEL=0 INSTALLDIR=\"C:\Program Files\Desktop\""
The /v switch passes parameters to the installer. Note the use of double quotes around the entire /v switch section. If any command-line argument has spaces in it, then it must be embedded in double quotes, as in the INSTALLDIR property above. Also note the backslash (\) in front of the double quotes (as they are embedded within the double quotes for the /v switch).
The Desktop installers provide a number of command-line options used to disable specific software integrations. If the installer detects that an integration can be applied to existing software on the computer (Microsoft Word, PowerPoint, Excel, and so on), it usually will automatically attempt to install an integration. If prevent an integration installed for a specific software product, disable that integration using these command-line switches:
EXPLORER=0
WORD=0
POWERPOINT=0
EXCEL=0
OUTLOOK=0
NOTES=0
Use capital letters for the switch names. For examples of how to use these switches on the command line, see Section E.1.1, "Command-Line Operation."
Switches are only used to disable software integrations. They are not needed to enable software integrations for applications found on client computers.
The MSI installer enables an administrator to roll out the Desktop client software to multiple client machines with the help of third-party tools such as SMS or netOctopus, which are capable of executing one executable on many machines. The MSI installer for the Desktop client software supports a silent installation option that can be configured with SMS.
The command to install the Desktop software silently follows:
msiexec /q /i "DIS-11.1.x.yy-Setup.msi" OUTLOOK=0 INSTALLDIR="C:\Desktop"
For a 64-bit Windows. system, use the following command:
msiexec /q /i "DIS-11.1.x.yy-x64-Setup.msi" OUTLOOK=0 INSTALLDIR="C:\Desktop"
You can add Content Server connections by creating a registry file on a Windows system. Desktop Integration Suite supports the configuration of servers and settings by executing a registry file named defaults.reg in the installation program's directory. The file is not included as part of the standard installation files; you must create it.
Adding servers in a registry file automates the setup process by saving your users from setting up connections on their computers. When you add a server connection in this manner, the user cannot delete the server connection from their desktop (Windows Explorer, the email client, or any desktop application).
The following sample registry file entries are examples for Content Servers instances, WebDAV servers, and Content DB servers, with comments below the code lines.
The sample file registry entries are under HKEY_LOCAL_MACHINE. If you would like the user to run the installer, use HKEY_CURRENT_USER instead of HKEY_LOCAL_MACHINE.
Using HKEY_LOCAL_MACHINE means that users cannot change the ServerAuth or RememberMetaData values because they will not have permission to change HKEY_LOCAL_MACHINE entries (unless a Windows policy is set to allow this, or the user is an administrator).
HKEY_LOCAL_MACHINE values override HKEY_CURRENT_USER values.
REGEDIT4 [HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV\Servers\Corporate] "ServerType"="ucm" "ServerURL"="http://corporate/cs/idcplg/webdav"
(In this registry entry, the server is a Content Server instance, the display name of the server is Corporate, and the server WebDAV URL is http://corporate/cs/idcplg/webdav.)
[HKEY_LOCAL_MACHINE\Software\ORACLE\Universal Content Management\Desktop Integration Suite\Shared\Config\Corporate] "HostCgiUrl"="http://corporate/cs/idcplg" "ServerAuth"=REG_DWORD:0x00000000 (0) "RememberMetaData"=REG_DWORD:0x00000000 (0)
(In this registry entry, the server is a Content Server instance, the name of the server is Corporate, the CGI URL is http://corporate/cs/idcplg, and the user interface URL is http://corporate/wcc/faces. Content DB servers and WebDAV servers do not use these registry entries.)
[HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV\Servers\Department] "ServerType"="dav" "ServerURL"="http://corporate/content/app/explorerPage.jspx" "Single Sign-On Url"="http://section/content/app/explorerPage.jspx" "Use Single Sign-On"=REG_DWORD:0x00000001 (1)
(In this registry entry, the server is a WebDAV server, the display name of the server is Department, the server WebDAV URL is http://corporate/content/app/explorerPage.jspx, a single sign-on page has been identified, and single sign-on has been implemented.)
[HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV\Servers\Section] "ServerType"="cdb" "ServerURL"="http://section/content/dav" "Single Sign-On Url"="http://section/content/app/explorerPage.jspx" "Use Single Sign-On"=REG_DWORD:0x00000001 (1)
(In this registry entry, the server is a Content DB server, the display name of the server is Section, the server WebDAV URL is http://section/content/dav, a single sign-on page has been identified, and single sign-on has been implemented.)
Desktop provides plug-ins for various popular web browsers which enable users to search for content on a Content Server instance directly from the search field in their web browser.
The default search provider name for an Oracle WebCenter Content Server instance is Oracle WebCenter Content Search, but this can be modified to a more meaningful name for the server.
To modify the default search provider name:
Log in to Content Server as an administrator.
Choose Administration then Configuration for SERVER.
On the Configuration page, in Features And Components, click Enabled Component Details.
In the list of installed components, find DesktopIntegrationSuite and click its Configure link.
On the Update Component Information page, make sure the Enable web browser search plug-in checkbox is selected.
Enter the search provider name for the server in the Web browser search plug-in title field. Choose a search provider name that is unique across the organization. Two servers with the same search provider name are not allowed.
When done, click Update to enable the new settings, Reset to cancel any modifications, or Revert To Install Settings to return to all default settings.
Restart Content Server.
If a Content Server instance is using Framework Folders as the content hierarchy component, subfolder searching can be enabled. This allows users to specify whether a content search should apply to the current folder only or whether it should include all subfolders of that folder.
To enable subfolder searching, Content Server must be configured to use the Oracle Text Search engine and some elements must be added to the search form.
To enable subfolder searching:
Log in to the Administration Server for Content Server.
Choose General Configuration.
On the General Configuration page, verify that the Additional Configuration Values section includes the following entries:
SearchIndexerEngineName=OracleTextSearch FoldersIndexParentFolderValues=true
Click Save.
Restart Content Server.
Rebuild the search collection index.
The content search form now includes a Parent Folder field as well as an Include Subfolders checkbox, which allows users to limit a search query to just the current content folder or expand it to include all subfolders.
Administrators can map email header fields to metadata fields for messages checked in to Content Server. MSG metadata mapping is used for the Microsoft Outlook message format and EML metadata mapping for Internet mail message format.
The six standard email metadata mappings cannot be overridden. Only additional mappings can be created.
Log in to Content Server as an administrator.
Choose Administration then Configure Email Metadata then Map MSG Metadata or Map EML Metadata.
On the Email Metadata Mappings page, the listed email header fields under Available Fields are not mapped and the fields under Mapped Fields are mapped to metadata. Use the right and left arrows to select a field and move it from one group to the other. Use the up and down arrows to sort the fields within each grouping.
As fields are added to or removed from Mapped Fields, a drop-down list appears for that field under Mapped Values. For each mapped email header field, select a value for the metadata field from the dropdown list.
When all fields are updated with metadata values, click Save.
Your organization may use separate identity and access management software that provides secure, form-based login screens to authenticate users and control access. Desktop is compatible with form-based logins. To enable this, add a comment to the login page so Desktop identifies an HTML response as the forms-based login page. Users will see the form-based login instead of the standard content server login.
To configure form-based login:
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.
Open the form in a text editor.
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 great deal of code. The delivered page must have that HTML comment (or token) in the first 5,000 characters of the response. If not, the server connection may fail.
The software on the client computer checks 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.
Save and close the form.
By default, Desktop 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 registry entry:
[HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV\Servers\SERVER_NAME] "Form Based Logins Reg Exp"="REGULAR_EXPRESSION"
Then the code looks in this registry entry:
[HKEY_CURRENT_USER\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV\Servers\SERVER_NAME] "Form Based Logins Reg Exp"="REGULAR_EXPRESSION"
Then the code looks in this registry entry:
[HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\Universal Content Management\Desktop Integration Suite\WebDAV]
"Form Based Logins Reg Exp"="REGULAR_EXPRESSION"
Finally, the code looks in this registry entry:
[HKEY_CURRENT_USER\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 entries, the default one is used.