Community

Product DocsMenu

Configuring and Indexing an Atlassian Confluence Source With the Legacy Connector

A source defines a set of configuration parameters for a specific Confluence site.

To configure and index a Confluence 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.

      OR

    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:

      Name

      A descriptive name of your choice for the connector source.

      Example: Corporate Confluence Wiki

      Source Type

      The connector used by this source. In this case, select Confluence.

      Note: If you do not see Confluence in the Source Type list, ensure that your environment meets the requirements (see Atlassian Confluence Legacy Connector Requirements).

      Addresses

      List of starting points for the connector, one address per line.

      Examples: Use the Confluence server root URL as the starting address to index a complete Confluence site: http://MyConfluenceServer:8090/

      To index specific spaces, add their URL as starting addresses:

      http://MyConfluenceServer:8090/display/space1

      http://MyConfluenceServer:8090/display/space2

      where space1 and space2 the Confluence spacekey for the desired space.

      To index Confluence Cloud content:

      https://MyCompany.atlassian.net/wiki/

      Notes:

      • To be able to index document permissions, all your starting points must be located on a single Confluence site. Create separate sources for separate sites.

      • CES 7.0.6830+ (July 2014) You can enter specific space addresses for deployments where Confluence is not installed at the server root such as:  http://server/MyConfluence/display/spacename.

    2. The following parameters often do not need to be changed:

      Rating

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

      Example: When the source indexes a legacy repository, you may want to set this parameter to Low, so that in the search interface, results from this source appear lower in the list compared to those from active repository sources.

      Document Types

      If you defined a custom document type set for this source, select it (see What Are Document Type Sets?).

      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).

      Fields

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

      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 (see Creating or Modifying a Source Schedule).

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

    1. Next to Parameters, for Confluence version 2.x to 3.4.x installations, when you chose to index permissions, click Add Parameter to add the DBConnectionString, DBDriverType, and LDAPConfigFilePath mandatory source parameters with the same value entered for the security provider (see Creating a Security Provider for the Atlassian Confluence Legacy Connector).

      Note: Other advanced parameters are also available (see Modifying Hidden Atlassian Confluence Source Parameters for the Legacy Connector).

    2. The Option check boxes generally do not need to be changed:

      Index Subfolders

      Keep this check box selected (recommended). By doing so, all subfolders from the specified server address are indexed.

      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 systems in which distinct documents may have the same name but 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. In the search interfaces, users can then more rapidly review the content by clicking the Quick View link rather than opening the original document with the original application. Consider clearing this check box only when 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. In this case, you must also select Generate a cached HTML version of indexed documents.

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

    1. In the Security Provider drop-down list, if you chose to index permissions, select the Confluence security provider that you created for this source (see Creating a Security Provider for the Atlassian Confluence Legacy Connector), otherwise, select None.

    2. In the Authentication drop-down list, if you chose to index permissions, select the Confluence crawling user identity that you created for this source. Otherwise, select None.

    3. Click Save to save the source configuration.

  8. When you chose to NOT index permissions, you must set the permissions globally for the source: 

    1. In the navigation menu on the left, select Permissions.

    2. Next to Permissions, select the Specifies the security permissions to index option.

    3. Next to Allowed Users, ensure that a well-known everyone group such as the Active Directory S-1-1-0 is added.

    4. Click Apply Changes.

    Note: You may need to enable the anonymous access to the remote API for your Confluence site (see Anonymous Access to Remote API) to prevent getting an error message similar to the following one in the CES Console or logs: 

    Cannot load the provided starting address: http://ConfluenceServer:8090/ -> Unable to connect to this address: 'http://ConfluenceServer:8090/' -> SoapException -> com.atlassian.confluence.rpc.NotPermittedException: Anonymous RPC access is disabled on this server

  9. Validate that the source building process is executed without errors:

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

      OR

    • Open the CES Console to monitor the source building activities (see Using the CES Console).

What's Next?

Add the built-in the Confluence facet to your search interface (see Managing Built-in Facets and Related Results Appearing in a .NET Search Interface).

People who viewed this topic also viewed