Product DocsMenu

Coveo Platform 7.0 >
Administrator Help > Connectors > Oracle UCM Connector > Configuring and Indexing a Source

Configuring and Indexing an Oracle UCM Source

A source defines a set of configuration parameters for a specific Oracle UCM server.

Note: In an environment with more than one Oracle UCM server, you need to define one source for each Oracle UCM server that you want to index.

To configure and index an Oracle UCM source

  1. On the Coveo server, access the Administration Tool (see Opening the Administration Tool).

  2. Select Index > Sources and Collections.

  3. In the Collections section:

    1. Select an existing collection in which you want to add the new source.


    2. Click Add to create a new collection (see Adding a Collection).

  4. In the Sources section, click Add.

    The Add Source page that appears is organized in three sections.

  5. In the General Settings section of the Add Source page:

    1. Enter the appropriate value for the following required parameters:


      A descriptive name of your choice for the connector source.

      Example: Corporate Oracle UCM

      Source Type

      The connector used by this source. In this case, select Oracle UCM.


      The address of the Oracle UCM Content Server Website. This should be the same address that you entered for the ServerUrl parameter in the security provider (see Configuring an Oracle UCM Security Provider). Enter the address in the form:


      where you replace [ucm-host] by the actual Oracle UCM server host name and [idc] by the name of the UCM instance to index.

      Refresh Schedule

      Time interval at which the index is automatically refreshed to keep the index content up-to-date. By default, the Every day option instructs CES to refresh the source everyday at 12 AM.

      Because incremental refresh is not available for the Oracle UCM connector, ensure to select an appropriate source refresh schedule, as this is the only mechanism that ensures that the index content is kept up-to-date.


      • A refresh does not detect that an item needs to be re-indexed when only its metadata changes because the item itself has not been checked in.

      • You can create new or modify existing source refresh schedules (see Creating or Modifying a Source Schedule).

    2. Review the value for the following parameters that often do not need to be modified:


      Change this value only when you want to globally change the ranking associated with all items in this source relative to the rating of other sources (see Understanding Search Results Ranking).

      Example: If this source was for a legacy system, you may want to set this parameter to Low, so that in the search interface, results from this source appear later in the list compared to those from other sources.

      Document Types

      If you created a custom document type set for this source, select it (see Creating a Document Type Set). Otherwise, select Default.

      Active Languages

      If you defined custom active language sets, ensure to select the most appropriate for this source (see Adding and Configuring a Language Set).


      If you defined custom field sets, ensure to select the most appropriate for this source (see What Are Field Sets?).

  6. In the Specific Connector Parameters & Options section of the Add Source page:

    1. When you chose to customize how metadata is set on the CES documents using a mapping file, in the Mapping File box, enter the full path of your valid mapping file (see About the Oracle UCM Mapping File). When this parameter is empty, the connector uses a generic mapping file.

      Example: C:\CES7\UCM\Mapping.config

    2. Review the default values for the following parameters: 

      Number of Refresh Threads

      The number of simultaneous connections established with the Oracle UCM Content Server by the connector. Increasing this value may improve source refresh speed but puts more load on the Oracle UCM Content Server.

      Content Server Port

      The port used by the Oracle UCM Content Server.

      Note: This value can be found by logging in the UCM Content Server and going to the Configuration >  Server Configurations page. The default value for the Content Server port is 4444 and should not be mistaken with the Web Server port, which is usually 80 or 8080.

    3. In the Parameters section, in rare cases the Coveo Support can instruct you to click Add Parameter to enter the name and value of hidden parameters that can help in troubleshooting issues.

    4. In the Option section, the state of check boxes generally does not need to be changed:

      Index Subfolders

      Check to index all subfolders below the specified starting addresses.

      Index the document's metadata

      When selected, CES indexes all the document metadata, even metadata that are not associated with a field. The orphan metadata are added to the body of the document so that they can be searched using free text queries.

      When cleared (default), only the values of system and custom fields that have the Free Text Queries attribute selected will be searchable without using a field query (see Adding a Field to Search On and What Are Field Queries and Free Text Queries?).

      Example: A document has two metadata:

      • LastEditedBy containing the value Hector Smith

      • Department containing the value RH

      In CES, the custom field CorpDepartment is bound to the metadata Department and its Free Text Queries attribute is selected.

      When the Index the document's metadata option is cleared, searching for RH returns the document because a field is indexing this value. Searching for hector does not return the document because no field is indexing this value.

      When the Index the document's metadata option is selected, searching for hector also returns the document because CES indexed orphan metadata.

      Document's addresses are case-sensitive

      Leave the check box cleared. This parameter needs to be checked only in rare cases for case sensitive systems in which distinct documents may have the same file name but with different casing.

      Generate a cached HTML version of indexed documents

      When you select this check box (recommended), at indexing time CES creates HTML versions of indexed documents and saves them in the unified index. In the search interfaces, users can then more rapidly review the content by clicking the Quick View link to open the HTML version of the item rather than opening the original document with the original application.

      Consider clearing this check box only if you do not want to use Quick View links or to save resources when building the source.

      Open results with cached version

      Leave this check box cleared (recommended) so that in the search interfaces, the main search result link opens the original document with the original application. Consider selecting this check box only when you do not want users to be able to open the original document but only see the HTML version of the document as a Quick View. When this option is selected, you must also select the Generate a cached HTML version of indexed documents check box.

  7. In the Security section of the Add Source page:

    1. In the Security Provider drop-down list, select the Oracle UCM security provider that you created for a this source (see Configuring an Oracle UCM Security Provider).

    2. In the Authentication drop-down list, select the Oracle UCM user identity that you created for this source.

    3. Click Save to save the source configuration. Do not start indexing this source yet.

  8. In the navigation panel on the left, click General.

  9. In the General page, modify the Title Selection Sequence so that the Use the filename option is the first option at the top of the list.

  10. In the navigation panel on the left, click Permissions.

  11. In the Permissions page:

    1. From the Permissions options:


      1. Select the Specify the security permissions to index option when your Oracle UCM system uses External Authorization from a repository other than Microsoft Active Directory to manually specify the permissions that will be set on documents from this source.

      2. In the Allowed Users and Denied Users boxes, respectively enter the allowed and denied users and groups for the source.

    2. Click Apply Changes.

  12. When you are ready to start indexing the Oracle UCM source, click Start.

  13. In the navigation panel on the left, click Status, and then validate that the indexing proceeds without errors.

People who viewed this topic also viewed