Skip Headers
Oracle® Content Database Administrator's Guide for Oracle WebCenter Suite
10g (10.1.3.2)

Part Number B32191-01
Go to Documentation Home
Home
Go to Book List
Book List
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

4 Choosing Oracle Content DB Options

After you install and configure Oracle Content DB, you may want to customize your setup for a particular deployment scenario. For example, you may want to integrate Oracle Content DB with an antivirus solution, or run the Oracle Content DB application on a different port number.

This chapter provides information about the following topics:

Enabling Oracle Content DB Error Reporting and Site Quota Warning Notifications

You can choose to configure an SMTP server to use with Oracle Content DB. Choosing this option enables the following functionality:

Use the Application Server Control to set up an SMTP server for use with Oracle Content DB.

To enable Web client error reporting and Site quota warning notifications:

  1. Set up an SMTP server, if you do not have one running already. This can be any SMTP server.

  2. Connect to the Application Server Control and go to the Content DB Home page. See "Accessing the Oracle Content DB Home Page" for information about how to do this.

  3. On the Content DB Home page, click the Administration tab.

  4. In the Domain Properties table row, click the Go to Task icon.

  5. On the Domain Properties page, click IFS.DOMAIN.EMAIL.Administrator Address. You may need to move to the next page to find this property, or you can use the Search field.

  6. Enter the e-mail address of an administrator where you want error reports and Site quota warning notifications to be sent, then click OK. Click IFS.DOMAIN.EMAIL.SmtpHost.

  7. Enter the host name for the SMTP server you want to use with Oracle Content DB, then click OK.

  8. Click IFS.DOMAIN.EMAIL.SmtpPort.

  9. Enter the port number for the SMTP server you want to use with Oracle Content DB, then click OK.

  10. Click IFS.DOMAIN.EMAIL.SmtpTimeoutLength.

  11. Enter the number of seconds you want Oracle Content DB to wait for the SMTP server to return from sending e-mail (for example, 60), then click OK.

  12. Click IFS.DOMAIN.EMAIL.SmtpUser.

  13. Enter the name of a user for the SMTP server you want to use with Oracle Content DB, then click OK.

  14. Return to the Cluster Topology page and restart the Oracle Content DB domain. See "Starting and Stopping the Oracle Content DB Domain" for information about how to do this.

Setting Up Antivirus Integration

Oracle Content DB integrates with a partner solution, the Symantec AntiVirus Scan Engine (SAVSE), to provide options to verify that content is virus free and to clean files that are infected.

After antivirus integration has been set up, files will be scanned for viruses whenever they are opened for read access, using the latest available virus definitions. The following files will be excluded from the scanning process:

If a file is infected with a virus, it will be marked as quarantined, and users will not be able to open the file until it is repaired. Contents of the file will remain unreadable even if virus checking is disabled by the administrator.

The Virus Repair Agent is responsible for repair attempts and retrieving the latest virus definitions. Whenever the agent becomes active, it polls the SAVSE server for updated virus definitions, and then attempts to repair the quarantined files. The agent will not attempt to repair the following files:

The following sections describe how to set up virus checking in Oracle Content DB:

Setting Up SAVSE

SAVSE must be installed and configured properly to function with Oracle Content DB. You must license the SAVSE server separately; the SAVSE license is not included with Oracle Content DB.

The following options must be set:

  • You must select ICAP as the communication protocol. No other protocols are supported.

  • You must set the scan policy to Scan and Repair or Scan Only. If you choose Scan Only, no repair attempts will be made. The Scan and Delete and Scan, Repair or Delete options are not supported.

  • You must enable the ICAP 403 response. This parameter cannot be set using the SAVSE administration tool; instead, it must be manually set in the SAVSE configuration file.

Enabling Antivirus Functionality in Oracle Content DB

After the SAVSE server has been installed and configured, you can enable antivirus functionality in Oracle Content DB. You can also set the maximum number of repair attempts for quarantined documents, and configure how often the Virus Repair Agent is activated. Use the Application Server Control to perform these tasks.

Enabling Antivirus Functionality and Setting the Maximum Number of Repair Attempts

To enable antivirus functionality and set the maximum number of repair attempts:

  1. Connect to the Application Server Control and go to the Content DB Home page. See "Accessing the Oracle Content DB Home Page" for information about how to do this.

  2. On the Content DB Home page, click the Administration tab.

  3. In the Domain Properties table row, click the Go to Task icon.

  4. On the Domain Properties page, click the IFS.DOMAIN.ANTIVIRUS.Enabled property, set the value to true, and click OK.

  5. Click the IFS.DOMAIN.ANTIVIRUS.Host property, enter the host name or IP address of the computer where the SAVSE server is running, and click OK.

  6. Click the IFS.DOMAIN.ANTIVIRUS.MaxRepairAttempts property, enter the number of times you want the Virus Repair Agent to attempt to repair a file, and click OK.

  7. Click the IFS.DOMAIN.ANTIVIRUS.Port property, enter the value for the SAVSE listener port, and click OK.

  8. Return to the Cluster Topology page and restart the Oracle Content DB domain. See "Starting and Stopping the Oracle Content DB Domain" for information about how to do this.

Configuring the Virus Repair Agent

To configure how often the Virus Repair Agent becomes active:

  1. Connect to the Application Server Control and go to the Content DB Home page. See "Accessing the Oracle Content DB Home Page" for information about how to do this.

  2. On the Content DB Home page, click the Administration tab.

  3. In the Server Configurations table row, click the Go to Task icon.

  4. Click VirusRepairAgentConfiguration. You may need to move to the next page to find this agent, or you can use the Search field.

  5. In the Properties section, click IFS.SERVER.TIMER.ActivationPeriod.

  6. Change the Value as necessary.

  7. On the Edit Property page, click OK.

  8. On the Edit Server Configuration page, click OK.

  9. Return to the Cluster Topology page and restart the node (OC4J_Content instance) that runs this agent. See "Starting, Stopping, and Restarting OC4J_Content Instances" for information about how to do this.

Excluding Formats from Being Scanned

You can exclude formats from being scanned for viruses to improve system performance. For example, you may choose to only scan formats with a higher probability of being infected, such as .zip files. Use the Application Server Control to exclude formats from virus checking.

To exclude formats from being scanned:

  1. Connect to the Application Server Control and go to the Content DB Home page. See "Accessing the Oracle Content DB Home Page" for information about how to do this.

  2. On the Content DB Home page, click the Administration tab.

  3. In the Formats table row, click the Go to Task icon.

  4. Click the name of the format you want to exclude from virus scanning.

  5. Select Omitted From Antivirus Scan.

  6. Click OK.

Performance Implications of Scanning for Viruses

The performance of Oracle Content DB may be affected by enabling the virus checking option. The performance impact depends on the following factors:

  • The frequency of virus definition updates made to the SAVSE service. Each time virus definitions are updated, all files that are opened (except for quarantined or excluded files) are scanned - none are excluded based on having already been scanned with these definitions, because the definitions are new.

    After a virus definition update, overall system performance will degrade initially, but will gradually return to normal as more files are scanned with the current virus definitions and are therefore excluded from subsequent scans.

  • The size and frequency of use of the Oracle Content DB repository.

  • The type and size of the data in the repository.

  • The probability of the number of attempted reads on unique files. Since files will only be scanned the first time they are opened against the current definitions, the frequency of unique files will affect performance.

  • The performance of the SAVSE service. This is the most significant performance factor.

  • The number of files whose format has been excluded from scanning by the administrator. Excluding certain formats will reduce the number of scans and improve system performance.

Managing Storage Options

The Oracle Content DB storage management options provide support for both offline and near-line storage. In offline and near-line storage, content that is infrequently accessed is moved from expensive online media, such as a disk array, to a cheaper offline medium, such as tape. The metadata and search indexes are kept online and are readily available.

Oracle Content DB uses BFILEs to support offline and near-line storage. A BFILE is a read-only Oracle data type consisting of a directory object and a file name. Updating a document whose content is stored as a BFILE results in the content being reloaded from the external storage as a new binary large object (BLOB), where the modifications are made. The new content will be indexed, depending on its format. End users will be unaware of where their content is stored.

This section provides information about the following topics:

Data Aging and Archiving

Oracle Content DB provides both data aging and data archiving through BFILEs. Through data aging, content that has not been accessed for a specified interval can be automatically moved from a BLOB to a BFILE. Through data archiving, content in the Archive is automatically moved from a BLOB to a BFILE.

Content that has been moved to a BFILE is still accessible, and is visible as any content would be when users are browsing or searching.

BFILE aging and archiving are not enabled by default. Follow the instructions in the subsequent sections to set up BFILE aging and archiving:

Setting Up Data Aging

Oracle Content DB is not set up for BFILE aging by default. To configure BFILE aging, you must first set domain properties that enable BFILE aging, then you must configure and activate the Content Agent. You can also specify storage management options.

To set domain properties that enable BFILE aging:

  1. Connect to the Application Server Control and go to the Content DB Home page. See "Accessing the Oracle Content DB Home Page" for information about how to do this.

  2. On the Content DB Home page, click the Administration tab.

  3. In the Domain Properties table row, click the Go to Task icon.

  4. Click IFS.DOMAIN.BFILE.Enabled, set the value to true, and click OK.

  5. Click IFS.DOMAIN.BFILE.AgingEnabled, set the value to true, and click OK.

  6. Return to the Cluster Topology page and restart the Oracle Content DB domain. See "Starting and Stopping the Oracle Content DB Domain" for information about how to do this.

To configure and activate the Content Agent:

  1. Connect to the Application Server Control and go to the Content DB Home page. See "Accessing the Oracle Content DB Home Page" for information about how to do this.

  2. On the Content DB Home page, click the Administration tab.

  3. In the Server Configurations table row, click the Go to Task icon.

  4. Click ContentAgentConfiguration.

  5. Edit the server configuration properties as necessary; see the Content Agent properties in Appendix E, "Server Configuration Properties" for more information about specific properties. In particular, you may want to edit IFS.SERVER.AGENT.CONTENTAGENT.RetentionPeriod; this property specifies the inactivity interval for files before they are moved to a BFILE.

  6. Click OK.

  7. Return to the Administration tab of the Content DB Home page.

  8. In the Node Configurations table row, click the Go to Task icon.

  9. Click the name of the node configuration that corresponds to the node where you want to run the Content Agent.

  10. On the Edit Node Configuration page, in the Servers section, click ContentAgent.

  11. Select Initially Started and click OK.

  12. On the Edit Node Configuration page, click OK.

  13. Return to the Cluster Topology page, select the node based on the node configuration you edited, and click Restart.

After you have set the domain properties for BFILE aging and configured the Content Agent, you can set storage management options as described in "Specifying Storage Management Options".

Setting Up Data Archiving

Oracle Content DB is not set up for BFILE archiving by default. To configure BFILE archiving, you must set domain properties that enable BFILE archiving. You can also specify storage management options.

To set domain properties that enable BFILE archiving:

  1. Connect to the Application Server Control and go to the Content DB Home page. See "Accessing the Oracle Content DB Home Page" for information about how to do this.

  2. On the Content DB Home page, click the Administration tab.

  3. In the Domain Properties table row, click the Go to Task icon.

  4. Click IFS.DOMAIN.BFILE.Enabled, set the value to true, and click OK.

  5. Click IFS.DOMAIN.BFILE.ArchivingEnabled, set the value to true, and click OK.

  6. Return to the Cluster Topology page and restart the Oracle Content DB domain. See "Starting and Stopping the Oracle Content DB Domain" for information about how to do this.

After you have set the domain properties for BFILE archiving, you can set storage management options as described in "Specifying Storage Management Options".

Specifying Storage Management Options

Optionally, you can change the default base path and policy for BFILE storage using the Application Server Control. These settings apply to all types of BFILE storage, including BFILE aging and BFILE archiving.

To specify storage management options:

  1. Connect to the Application Server Control and go to the Content DB Home page. See "Accessing the Oracle Content DB Home Page" for information about how to do this.

  2. On the Content DB Home page, click the Administration tab.

  3. In the Storage Management table row, click the Go to Task icon.

    Figure 4-1 shows the Storage Management page.

    Figure 4-1 Storage Management Page

    Description of Figure 4-1 follows
    Description of "Figure 4-1 Storage Management Page"

  4. Change the BFILE Base Path. The default base path is:

    ORACLE_HOME/ifsbfiles/content_services_schema
    
    

    ORACLE_HOME refers to the database Oracle home on the database computer.

    Each BFILE has a relative path in addition to the base path. The relative path is:

    /yyyy/dd/mm/hh/mm/ss/ifsbfile_id
    
    

    In the relative path, ifsbfile_id is the file naming pattern that associates a unique ID to each piece of content.

  5. Change the BFILE Policy. This policy determines whether the operating system files should be deleted when the BFILE references are deleted from the database. If you are storing BFILEs on an optical device that does not permit deletion, you should specify that the operating system files should be retained.

  6. Click Apply.

Changing the Oracle Content DB Port Number

If you want to change the Oracle Content DB application port to a different port number, perform the tasks listed in the following sections:

Changing the Port Number in Oracle HTTP Server

Before you can change the port number in Oracle Content DB, you must first change the port number in Oracle HTTP Server by modifying the Oracle HTTP Server HTTP Listen Directive in the httpd.conf file, and then restarting the Oracle Application Server middle tier. See "Managing Ports" in Oracle Application Server Administrator's Guide for full instructions.

Changing the Port Number in Oracle Content DB

Use the Application Server Control to update the Oracle Content DB Application Port domain property and restart the OC4J_Content instance:

  1. Connect to the Application Server Control and go to the Content DB Home page. See "Accessing the Oracle Content DB Home Page" for information about how to do this.

  2. On the Content DB Home page, click the Administration tab.

  3. In the Domain Properties table row, click the Go to Task icon.

  4. On the Domain Properties page, click IFS.DOMAIN.APPLICATION. ApplicationPort.

  5. Enter the new port number in the Value field and click OK. If you are using a load balancer with multiple Oracle Content DB middle tiers, enter the load balancer port.

  6. Return to the Cluster Topology page, select the appropriate OC4J_Content instance, and click Restart.

Allowing Access to Oracle Content DB from Outside the Firewall

You can set up Oracle Content DB so that users outside the firewall can have access. To do this, follow these steps:

  1. Open ports. Disable the firewall for the following ports:

    • Database listener port (typically 1521)

    • Apache port (Oracle HTTP Server port)

    • Oracle Internet Directory ports (if you are using Oracle Internet Directory, and if Oracle Internet Directory is running inside the firewall)

    • Load balancer port (if you use a load balancer)

  2. Set firewall timeout periods. You must set the operating system parameter TCP_keepalive to 120 minutes.

Figure 4-2 shows a possible firewall scenario with the database and middle tiers inside the firewall, and with OracleAS Infrastructure outside the firewall.

Figure 4-2 Sample Firewall Configuration

Description of Figure 4-2 follows
Description of "Figure 4-2 Sample Firewall Configuration"

Changing a Middle-Tier Host Name or IP Address

You can run a script to change the host name or IP address of a middle-tier host in Oracle Content DB. You can only run the script if you have a multiple-computer deployment of Oracle Content DB. In other words, you can only run the script if your middle tier does not run on the same host as Oracle Database (or Oracle Internet Directory, if you are using Oracle Internet Directory as your user repository).

To change the host name or IP address of your middle tier:

  1. Shut down all middle-tier processes, including OC4J_Content and the Application Server Control.


    See Also:


  2. Change the host name or IP address on your middle-tier computer.

  3. Change the host name or IP address for all of your other Oracle Application Server components. To do this, run the chgiphost utility, located in ORACLE_HOME/CHGIP/scripts, and follow the prompts. For more information, see "Changing Network Configurations" in Oracle Application Server Administrator's Guide.

  4. Run the Oracle Content DB script changehostname, located in the following directory:

    ORACLE_HOME/content/bin
    
    

    Specify the old host name or IP address and the new host name or IP address as arguments. For example:

    changehostname old_host_name new_host_name
    
    

    or

    changehostname old_ip_address new_ip_address
    
    

    If you need to change both the host name and the IP address, you must run the script twice, once to change the host name and once to change the IP address.


    Note:

    You can view log information for this script in changehostname.log, located in:
    ORACLE_HOME/content/logs
    

  5. Start all middle-tier processes, including OC4J_Content and the Application Server Control.


    See Also:


Changing the Oracle Database URL

If you change the host name for your Oracle Database, you need to update the database URL stored on each Oracle Content DB middle tier. To do this, on each middle tier, update the oc4j.properties file for the OC4J_Content instance. You can find this file at:

ORACLE_HOME/j2ee/OC4J_Content/config

You also need to update the database URL if you change from a regular Oracle Database configuration to an Oracle RAC configuration.

Using Oracle Drive with Oracle Content DB

Oracle Drive is a native Windows application that lets users use Windows Explorer, Microsoft Office, and other Windows applications to access content in Oracle Content DB and other Oracle WebDAV servers such as OracleAS Portal. Oracle Drive displays files and folders in Oracle Content DB as a mapped drive in Windows Explorer. Oracle Drive also provides an effective offline solution that lets users edit files on their computers when offline, and then synchronize with the server when they reconnect.

Oracle Drive is available on the Downloads page of the Oracle Technology Network (OTN) at:

http://www.oracle.com/technology/software/

Oracle Drive runs on Microsoft Windows 2000 and Windows XP. For the most up-to-date certification information, see OracleMetaLink at http://metalink.oracle.com.

Oracle Drive requires Microsoft .NET Framework 1.1. The Oracle Drive installation installs the Microsoft .NET Framework 1.1 on the client computer.

You can set up an administrator-configured installation of Oracle Drive so that Oracle Drive is automatically deployed on user workstations, or you can copy the Oracle Drive executable to an accessible location so that users can install Oracle Drive themselves. You can also include service details with the Oracle Drive executable so that users don't have to configure their Oracle Drive service. The following sections provide more information about these topics:

Setting Up an Administrator-Configured Installation of Oracle Drive

Setting up an automatic installation of Oracle Drive for your users is strongly encouraged. Oracle Drive is the client of choice for uploading and downloading many files at once, and also provides synchronization capabilities. Setting up an administrator-configured install will encourage user adoption and reduce support calls.

Configuring Oracle Drive Service Details For Your Users

You can choose to specify Oracle Drive service details as part of your Oracle Drive deployment. Setting up an Oracle Drive service for your users is strongly recommended so that users do not have to configure Oracle Drive themselves. Note that individual users can still edit service details as necessary for their own computers.

To specify Oracle Drive service details, update the parameters in the config.xml file. Then, specify the location of the config.xml file in the update.xml file. Both of these files need to be copied to an HTTP server that is accessible to all your users, without requiring a login.

Finally, specify the location of the update.xml file in odrive.ini, then copy it to the same location as the ODriveSetup.msi file. See "Preparing for Deployment Using Active Directory" for more information about ODriveSetup.msi.

These steps are detailed in the following sections:

Setting Up config.xml

The config.xml file contains the details for the Oracle Drive service you want to deploy. Update config.xml by providing your own values for each parameter. Then, copy the file to an HTTP server that is accessible to all your users, without requiring a login. After you download the Oracle Drive installation files, you can find config.xml in the \Extra folder.

You can configure multiple services for your users by providing additional <item> entries, with parameters, in config.xml. Refer to Table 4-1 for information about the parameters in config.xml.

Example 4-1 shows the format of the config.xml file, with sample values for two services.

Example 4-1 config.xml

<wfc-config>

<item>
  <type>odrivesupport</type>
  <techsupportemail>odriveissues@oracle.com</techsupportemail>
</item>

<item> 
  <type>service</type> 
  <name>Oracle Content DB</name> 
  <hostname>myhost1.company.com</hostname> 
  <port>7777</port> 
  <secure>1</secure> 
  <server-directory>/users/mydir</server-directory> 
  <drive-letter>k</drive-letter> 
  <sharing-level>3</sharing-level> 
  <map-home>1<map-home> 
  <auto-reconnect>2</auto-reconnect>
  <basic-authentication>0</basic-authentication>
  <bypass-proxy>1</bypass-proxy>
</item> 

<item> 
  <type>service</type> 
  <name>Oracle Portal</name> 
  <hostname>myhost2.company.com</hostname> 
  <port>7778</port> 
  <secure>1</secure> 
  <server-directory>/my_location</server-directory> 
  <drive-letter>z</drive-letter> 
  <sharing-level>3</sharing-level> 
  <map-home>1<map-home> 
  <auto-reconnect>2</auto-reconnect>
  <basic-authentication>0</basic-authentication>
  <bypass-proxy>1</bypass-proxy>
</item> 

</wfc-config>

Table 4-1 Parameter Values for config.xml

Parameter Name Description

<type>

The value for this parameter must be "service" or "odrivesupport." Do not change this value.

<techsupportemail>

The e-mail address that will be used by Oracle Drive when users click Report a Problem. By default, this parameter is set to odriveissues@oracle.com. Although this address is an actual address, e-mails sent to this address will not receive responses; instead, users will receive an auto-reply message.

You can keep the default value for this parameter, or provide an alternate e-mail address.

<name>

The name of the service (for example, Oracle Content DB) as it will appear in Oracle Drive.

<hostname>

The host name of the Oracle Content DB server (for example, myhost.mycompany.com).

<port>

The port number of the Oracle Content DB server (for example, 7778). If you do not specify this value, the port number defaults to either 80 or 443, depending on the value you specify for <secure>.

<secure>

Whether HTTP or HTTPS will be used to connect to Oracle Content DB. The possible values are:

  • 0 (use HTTP)

  • 1 (use HTTPS)

<server-directory>

The Oracle Content DB folder location to mount, or in other words, the folder location that will appear as the top-level folder when users connect to Oracle Content DB using Oracle Drive (for example, /content/dav/my_site/Libraries/mydir).

You must include /content/dav at the beginning of the specified path.

<drive-letter>

The Windows drive letter to use for this service. The value can be any drive letter from D-Z.

If you do not specify a value, or if the letter you specify is not available, the first drive letter available will be used.

<sharing-level>

The default value for the refresh interval to use for this service.

The longer the refresh interval, the better the performance. However, when the refresh interval is longer, files and directories are refreshed less frequently, so users may notice a lag in seeing file and directory changes made by other users.

In addition, the longer the refresh interval, the fewer server resources are needed (such as CPU or disk I/O).

The possible values are:

  • 0 (1 hour)

  • 1 (15 minutes)

  • 2 (3 minutes)

  • 3 (15 seconds)

<map-home>

Whether to map to the Personal Library of the user by default (if the Personal Library exists). The possible values are:

  • 1 (map to the Personal Library of the user)

  • 2 (do not map to the Personal Library of the user)

The Personal Library can only be mounted if the value for <server-directory> begins with /content/dav.

<auto-reconnect>

Whether or not to automatically connect to the service when Oracle Drive starts. The possible values are:

  • 1 (automatically connect to the service)

  • 2 (do not automatically connect to the service)

<basic-authentication>

Whether users can use basic authentication to connect to WebDAV servers that require cleartext passwords. The possible values are:

  • 0 (do not use basic authentication)

  • 1 (use basic authentication)

Because Oracle Content DB does not require cleartext passwords, enter 0 for this parameter.

<bypass-proxy>

Whether Oracle Drive uses a proxy server when communicating with the WebDAV server. The possible values are:

  • 0 (do not bypass the proxy server)

  • 1 (bypass the proxy server)


Setting Up update.xml

The update.xml file holds the value for the location of the config.xml file. After you download the Oracle Drive installation files, you can find update.xml in the Extra folder.

Edit the update.xml file by providing your own values for each parameter:

  • <date>: Provide a string value (such as a date, in any format, or other representation) that corresponds to the configuration file version you are using. If Oracle Drive detects that the string value has changed since the last time it started, Oracle Drive will process the new config.xml file.

  • <location>: Provide the URL to config.xml.

Then, copy the file to an HTTP server that is accessible to all your users, without requiring a login.

Example 4-2 shows the format of the update.xml file, with sample values.

Example 4-2 update.xml

<?xml version="1.0" ?>
<config-update>
  <date>2006.07.31 13:41:PST</date>
  <location>http://myserver.mycompany.com/config.xml</location>
</config-update>
Setting Up odrive.ini

The odrive.ini file holds the value for the location of the update.xml file. After you download the Oracle Drive installation files, you can find odrive.ini in the Extra folder.

Update odrive.ini by providing the URL for your update.xml file, then copy odrive.ini to the same directory where the ODriveSetup.msi file is located. See the "Preparing for Deployment Using Active Directory" for more information about ODriveSetup.msi.

Example 4-3 shows the format of the odrive.ini file, with sample values.

Example 4-3 odrive.ini

[General]
AutoupdateURL=http://myserver.mycompany.com/odrive/update.xml

Preparing for Deployment Using Active Directory

You must use a Windows Domain Controller computer to deploy Oracle Drive using Active Directory. If you need to promote a Windows 2000 or 2003 server to be a Domain Controller, you can use the Microsoft utility DCPromo.exe.

You must also install Active Directory on the Domain Controller computer, if it is not installed already.

Finally, you must extract the ODriveSetup.msi file, along with other files required for installation, from the Oracle Drive installation executable. To do this:

  1. Exit Oracle Drive, if it is running. To do this, right-click the Oracle Drive icon in the system tray and choose Exit.

  2. Open a command prompt window and navigate to the directory where the self-extracting EXE is located (for example, OracleDrive10.2.exe).

  3. In the command prompt window, run the self-extracting EXE with the /T option, specifying a temporary location. For example:

    OracleDrive10.2.exe /T:c:\temp
    
    

    This action will extract nine files from the self-extracting EXE, including the installation executable.

  4. In the command prompt window, navigate to the temporary location (for example, c:\temp).

  5. In the command prompt window, run the Oracle Drive installation executable in administrative mode, as follows:

    executable_name /a
    
    

    For example:

    ODriveSetup10.2.0.0.0.exe /a
    
    
  6. Follow the wizard instructions. On the Network Location screen, specify the location on your local (not network) drive where you want to put the MSI and other files.

  7. Click Finish to exit the wizard.

  8. Copy the files to a public share accessible to all the users of that domain. If you are specifying Oracle Drive service details for your users, make sure to copy odrive.ini to the same location.

Deploying Oracle Drive Using Active Directory

You can use Active Directory to automatically deploy Oracle Drive (using MSI) on user workstations. With this technique, you can deploy Oracle Drive on all computers for your users from a single server.

Microsoft Windows 2000 or later operating systems include tools that allow administrators to install and maintain software applications based on Group Policy. An administrator can assign Oracle Drive to a particular computer by creating a computer-level software distribution Group Policy. Assigning Oracle Drive to user computers is the simplest way to use Group Policy to manage a package. With this method, Oracle Drive is automatically installed on the computer the first time a designated computer is started and the software installation portion of the Group Policy is applied.

This feature allows administrators to set up the environment required for the whole group, including specifying Oracle Drive service details.

To set up an automatic installation of Oracle Drive using Active Directory and MSI:

  1. From the Windows Start menu, choose Active Directory for Users and Computers. The Active Directory application appears.

  2. In the tree view, under the domain name, create a new organization unit (for example, OdriveOU).

  3. By default, all the computers in the domain appear in the Computers organization unit. Move the computers on which you want to deploy Oracle Drive to the new organization unit you created in Step 2.

    Oracle recommends you deploy Oracle Drive to a small subset of computers first, for testing purposes, before deploying to your entire organization.

  4. Right-click the organization unit you created and select Properties.

  5. Click the Group Policy tab and create a new group policy object link.

  6. Double-click the group policy object link you created in Step 5. The Group Policy Object Editor appears.

  7. In the tree view, go to Computer Configuration > Software Settings > Software Installation. Ensure that Software Installation is selected, then right-click in the right pane and choose New > Package.

  8. Specify the extracted MSI file for the new package, then, in the Deploy Software dialog box, select Advanced for the deployment method.

  9. After you have created the new package, right-click the package and select Properties. Click the Deployment tab and ensure that the Deployment type is set to Assigned, then click OK.

Any errors that occur during the deployment of Oracle Drive will appear in the Event Log for the Windows Domain Controller computer. The Event Log can be viewed locally, or remotely.

Most files installed with Oracle Drive are put in the Oracle Drive installation directory. In addition, Oracle Drive installs additional files in the System32 directory for use by Windows. Table 4-2 lists these additional files.

Table 4-2 Files Installed by Oracle Drive Into the System32 Directory

File Name File Location

tdfsd.sys

Windows_folder\System32\Drivers

TDShell.dll

Windows_folder\System32

TDHook.dll

Windows_folder\System32

XDNP.dll

Windows_folder\System32

ODriveHelper.dll

Windows_folder\System32


Redeploying Oracle Drive

You can upgrade the version of Oracle Drive on user workstations by redeploying Oracle Drive using Active Directory.

To redeploy Oracle Drive:

  1. On the Windows Domain Controller computer, from the Start menu, choose Active Directory for Users and Computers. The Active Directory application appears.

  2. In the tree view, right-click the organization unit you created for the Oracle Drive deployment and select Properties.

  3. Click the Group Policy tab, then double-click the group policy object link. The Group Policy Object Editor appears.

  4. In the tree view, go to Computer Configuration > Software Settings > Software Installation. Right-click the package in the right pane and choose All Tasks > Redeploy application.

Removing Oracle Drive from User Workstations

You can undeploy Oracle Drive from user workstations using Active Directory.

To undeploy Oracle Drive:

  1. On the Windows Domain Controller computer, from the Start menu, choose Active Directory for Users and Computers. The Active Directory application appears.

  2. In the tree view, right-click the organization unit you created for the Oracle Drive deployment and select Properties.

  3. Click the Group Policy tab, then double-click the group policy object link. The Group Policy Object Editor appears.

  4. In the tree view, go to Computer Configuration > Software Settings > Software Installation. Right-click the package in the right pane and choose All Tasks > Remove.

Packaging Service Information with the Oracle Drive Executable

As an alternative to automatically installing Oracle Drive on user workstations, you can provide service information as part of the Oracle Drive executable. Using this method, users install Oracle Drive themselves, but do not have to configure service details after installation completes.

To include service information with the Oracle Drive executable:

  1. Download the Oracle Drive installation files to a location on your local hard drive (for example, C:\odrive).

  2. In the Extra folder, open the file config.xml in a text editor. Provide service details, then copy the file to an accessible location. See "Setting Up config.xml" for more information.

  3. In the Extra folder, open the file update.xml in a text editor. Provide the location of config.xml, then copy the file to an accessible location. See "Setting Up update.xml" for more information.

  4. In the Extra folder, open the file odrive.ini in a text editor and provide the location of update.xml. See "Setting Up odrive.ini" for more information.

  5. In the Extra folder, open the file OracleDrive10.2.SED in a text editor. Edit the TargetName, SourceFiles0, and SourceFiles1 properties, as necessary:

    • For TargetName, provide the location where you want to put the Oracle Drive executable.

    • For SourceFiles0, provide the location on your hard drive where you copied the Binaries folder.

    • For SourceFiles1, provide the location on your hard drive where you copied the Extra folder.

    If you copied the Oracle Drive files to C:\odrive, you can keep the defaults and skip this step.

    The following example shows a portion of the OracleDrive10.2.SED file:

    TargetName=C:\odrive\OracleDrive10.2.exe
    FriendlyName=Oracle Drive 10.2.0.0.0
    AppLaunched=ODUpgrade.exe
    PostInstallCmd=<None>
    AdminQuietInstCmd=
    UserQuietInstCmd=
    FILE0="ODriveSetup10.2.0.0.0.exe"
    FILE1="ODUpgrade.exe"
    FILE2="dotnetfx.exe"
    FILE3="odrive.ini"
    [SourceFiles]
    SourceFiles0=C:\odrive\binaries\
    SourceFiles1=C:\odrive\extra\
    [SourceFiles0]
    %FILE0%=
    %FILE1%=
    %FILE2%=
    [SourceFiles1]
    %FILE3%=
    
    
  6. Use the IExpress utility to re-package the files into a self-extracting executable. To do this, open a command prompt and go to the location where the SED file is located, then run this command:

    iexpress /N OracleDrive10.2.SED
    
    
  7. Copy the Oracle Drive executable to a location where users can download it. You can find the executable at the location you specified for TargetName in the SED file.

Installing Oracle Drive

If you choose not to set up the administrator-configured installation of Oracle Drive, you can download the installation files from the Oracle Technology Network (OTN), then copy the files to a location where your users can download them. Alternatively, your users can download Oracle Drive from OTN themselves.

To install Oracle Drive, there must available disk space equivalent to twice the size of the install files

The following instructions explain how to install Oracle Drive.


Note:

If you install Oracle Drive on a computer that has firewall software running, such as the native Windows XP firewall, you may see a message similar to the following:
Windows Security Alert: To help protect your computer, Windows Firewall has blocked some features of this program.  Do you want to keep blocking this program? ODFWAgent.exe

If you see this message, select Unblock to allow Oracle Drive to run.


To install Oracle Drive:

  1. Double-click the Oracle Drive executable.

  2. If you are accessing the installation files from a remote location, in the File Download window, select Run this program from its current location, then click Yes in the warning dialog box.

    You can also download the installation program to your local hard drive and run it from there. After downloading, double-click the executable file to begin installation.

  3. If you have a previous version of Oracle Drive installed, the installation wizard prompts you to uninstall the previous version first. You must close any browser windows you have open before proceeding.

  4. Oracle Drive requires Microsoft .NET Framework 1.1. If you do not have Microsoft .NET Framework 1.1, the installation wizard will install it for you.

  5. On the Choose Setup Language screen, select a language and click OK.

  6. On the Welcome screen, click Next.

  7. On the Destination Folder screen, accept the default installation directory, or click Change to select a different installation directory. Then, click Next.

  8. On the Miscellaneous Options screen, choose whether to add a shortcut to Oracle Drive on your desktop, and whether you want Oracle Drive to start automatically when Windows starts. Then, click Next.

  9. On the Ready to Install the Program screen, click Install to install Oracle Drive, or click Back to change any values that you entered.

  10. On the InstallShield Wizard Completed screen, click Finish.

  11. The Oracle Drive installer prompts you to restart your computer. Select Yes to restart your computer automatically, or select No and restart manually.

For complete information about how to set up a WebDAV connection between Oracle Drive and Oracle Content DB, as well as information about how to use Oracle Drive, see the Oracle Drive Help. Or, go to the Oracle Content DB New User Orientation (available from the Oracle Content DB Launch Page) for information about installing and using Oracle Drive.

Customizing the New User Orientation

Oracle Content DB comes with a New User Orientation, a set of customizable help pages that users can access from the Oracle Content DB launch page. These pages provide valuable information, such as how to sign on to the Web client and how to get started with Oracle Drive, that can help new users get started with Oracle Content DB. The New User Orientation is only available in English.

Figure 4-3 shows the New User Orientation.

Figure 4-3 Oracle Content DB New User Orientation

Description of Figure 4-3 follows
Description of "Figure 4-3 Oracle Content DB New User Orientation"

You can customize the HTML pages to make the information more useful for your users. For example, the topic called Signing On to Oracle Content DB includes the following text:

"Open a browser window and go to the Oracle Content DB launch page. If you don't know the URL, ask your administrator."

You can replace the value for "the Oracle Content DB URL" with the actual URL (for example, http://content_db_host_name:port/content).

You can replace any text in the New User Orientation help files. However, text that is especially appropriate for customization is highlighted in red.

The New User Orientation pages are located on each middle tier, in the following directory:

ORACLE_HOME/Apache/Apache/htdocs/eudp/

Then main entry point for the New User Orientation help files is index.html.

When you update HTML files in the New User Orientation, make sure to update the files on each middle tier.