--- title: Add a Khoros Community source slug: '1691' canonical_url: https://docs.coveo.com/en/1691/ collection: index-content source_format: adoc --- # Add a Khoros Community source A Khoros Community [source](https://docs.coveo.com/en/246/) is an interactive community that enables users to share digital customer experiences on the Khoros platform. Members of a [Coveo organization](https://docs.coveo.com/en/185/) with the [required privileges](#required-privileges) can add the source to [index](https://docs.coveo.com/en/204/) the content of their Khoros Community instance. ## Source key characteristics The following table presents the main characteristics of a Khoros Community source. [cols="4",options="header"] |=== 2+|Features |Supported |Additional information 2+|Khoros Community version ^|Latest version | 2+|Indexable content |Communities, categories, boards, and discussions (also known as threads and conversations) including topics (texts and products), replies (answers, comments, and reviews), messages (also known as posts), and message attachments. | .3+.^|[Content update operations](https://docs.coveo.com/en/2039/) |[refresh](https://docs.coveo.com/en/2710/) ^|[check] |[Takes place every hour by default](https://docs.coveo.com/en/1933/). A rescan or rebuild is required to take account of deleted or modified items. |[rescan](https://docs.coveo.com/en/2711/) ^|[check] |[Takes place every day by default](https://docs.coveo.com/en/1933/). |[rebuild](https://docs.coveo.com/en/2712/) ^|[check] | .3+.^|[Content security](https://docs.coveo.com/en/1779/) options |[Same users and groups as in your content system](https://docs.coveo.com/en/1779#same-users-and-groups-as-in-your-content-system) ^|[check] | See ["Content security" tab](#content-security-tab). |[Specific users and groups](https://docs.coveo.com/en/1779#specific-users-and-groups) ^|[check] | |[Everyone](https://docs.coveo.com/en/1779#everyone) ^|[check] | .3+|[Metadata indexing for search](#index-metadata) |Automatic mapping of [metadata](https://docs.coveo.com/en/218/) to [fields](https://docs.coveo.com/en/200/) that have the same name 2+a|This setting is disabled by default and [not recommended for this source type](https://docs.coveo.com/en/1640#about-the-performfieldmappingusingallorigins-setting). |Automatically indexed [metadata](https://docs.coveo.com/en/218/) 2+a|Examples of [auto-populated default fields](https://docs.coveo.com/en/1833#field-origin) (no user-defined metadata required):   * `clickableuri` * `language` (auto-detected from item content) * `lithreadhassolution` * `lithreadmessagecount` * `litopicrating` * `limessageauthor` * `objecttype` * `title`   After a content update, [inspect your item field values](https://docs.coveo.com/en/2053#inspect-search-results) in the **Content Browser**. |Extracted but not indexed metadata 2+a|The Khoros Community source extracts some of the metadata that the Khoros API makes available.   After a rebuild, review the [**View and map metadata**](https://docs.coveo.com/en/m9ti0339#view-and-map-metadata-subpage) subpage for the list of indexed metadata, and [index additional metadata](https://docs.coveo.com/en/m9ti0339#index-metadata). |=== > **Leading practice** > > The number of [items](https://docs.coveo.com/en/210/) that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. > See [About crawling speed](https://docs.coveo.com/en/2078/) for information on what can impact crawling speed, as well as possible solutions. ## Add a Khoros Community source > **Leading practice** > > It's best to create or edit your source in your sandbox organization first. > Once you've confirmed that it indexes the desired content, you can copy your source configuration to your production organization, either [with a snapshot](https://docs.coveo.com/en/3239/) or manually. > > See [About non-production organizations](https://docs.coveo.com/en/2959/) for more information and best practices regarding sandbox organizations. . On the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page, click **Add source**, and then select **Khoros Community**. . Enter a **Name** for your source. > **Leading practice** > > A source name can't be modified once it's saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens (`-`), and underscores (`_`). Avoid spaces and other special characters. . Enter a **Khoros Community address**. To index an entire community, enter its root URL. To index only a part of a community, you can [enter specific object addresses](#khoros-community-address). . Under **Authentication**, select whether Coveo must log in to access your community. If your community is private, select **Khoros Community account** and enter the credentials of a [crawling account](https://docs.coveo.com/en/2122/) for the source. This account must: ** Be a native Khoros Community account. ** Be an administrator account if you plan on [replicating your Khoros Community permission system in Coveo-powered search interfaces](#content-security-tab). ** Be dedicated to the source. ** Have access to all the content you want to index. ** Have permission to make REST API read calls for all boards and categories of your community. When you have administrator rights, this setting is available in your Khoros Community **Admin** section, under **Users** tab > **Permissions** navigation bar section > **Defaults** tab > **Make REST API calls with read access**. . Back in the [Coveo Administration Console](https://docs.coveo.com/en/183/), enter the username and password of the source account. . Optionally, under **Project**, select the [project](https://docs.coveo.com/en/n7ef0517/) you want to associate your source with. . Click **Next**. . Select who will be able to access the source items through a Coveo-powered [search interface](https://docs.coveo.com/en/2741/). For details on this parameter, see [Content security](https://docs.coveo.com/en/1779/). **If you select "Same users and groups as in your content system"** [%collapsible%open] #### If you want to [replicate your Khoros community's permission system in your Coveo-powered search interface](https://docs.coveo.com/en/1779/), enter the username of a newly created Khoros user under **Permission account**. This account will be used by Coveo to discover your permission system, so it must be dedicated to this purpose. It can't be the [administrator account required to index a private community](#authentication). See [Permission indexing limitations](#permission-indexing-limitations) for more information. #### . Click **Add source**. . Specify your source settings. Refer to the following sections for detailed information on the source settings: ** ["Configuration" tab](#configuration-tab) ** ["Content security" tab](#content-security-tab) ** ["Access" tab](#access-tab) ### "Configuration" tab The **Configuration** tab lets you manage the content to index, authentication methods, and advanced settings of your source. These configuration groups are presented in subtabs. #### "Content to index" subtab The **Content to index** subtab lets you define the content that you want to make available as search results. By default, Coveo indexes the community or content it finds at the [URL you provided when creating the source](#khoros-community-address). ##### Additional content Optionally, select additional content to index: message attachments, user data, and/or message tags. > **Important** > > Indexing attachments, users, and/or message tags, especially with large Khoros communities, can significantly increase the indexing time, as it requires an additional API call to Khoros per message/user. > **Notes** > > * You can include users only when indexing an entire community. > If you only [index a community subset such as a category or a board](#khoros-community-address), users aren't included. > > * The Khoros Community source populates three fields for [message item folding](https://docs.coveo.com/en/1884/): `@foldingcollection`, `@foldingparent`, and `@foldingchild`. > Other item types such as attachments don't have the folding field set and therefore can't be folded. > Instead, these items appear as a single result in the search interface. #### "Authentication" subtab The **Authentication** subtab contains the information Coveo needs to access your Khoros Community content. ##### Khoros Community address Enter the address of the content you want to index. You can index an entire Khoros community by entering the root URL of the community. The URL should look as follows: `+http://community.company.com/+`. You can also enter the address of a desired category, board, or thread. The address should be in the following format: `+http://community.company.com/[...]//+`. Check the table below for the possible values for ``: **Possible values for a Khoros Community object label**
Details [%header,cols="2"] |=== |Label |Khoros Community object |ct-p |Category |tkbc-p |Knowledge base category |bd-p |Forum |tkb-p |Knowledge base |con-p |Contest |idb-p |Idea board |qa-p |Q&A board |bg-p |Blog |gp-p |Group |m-p |Forum thread |td-p |Forum thread |ta-p |Knowledge base article |cns-p |Contest submission |idi-p |Idea |qaq-p |Q&A Question |ba-p |Blog article |gpm-p |Group article |===
> **Notes** > > * To exclude certain communities, first configure and save your source with a broad URL. > Then, [refine the content to index](#refine-the-content-to-index). > > * Hidden categories or boards aren't indexed, unless you specifically provide the URL of the desired hidden category/board and your [crawling account](#authentication) can access it. > > * The Khoros Community source uses REST API v.1. > > * If you use a reverse proxy, your REST API might not reside at your community root URL. > You must therefore [add the `RestApiUrl` hidden parameter](https://docs.coveo.com/en/2033#restapiurl) to specify the URL address at which your REST API resides. > Be aware, however, that [Khoros Community doesn't recommend using a reverse proxy while logged in with a Khoros Community account](https://community.lithium.com/t5/Launching-your-site/Reverse-proxy-and-lithium-communities/ta-p/224993). ##### Authentication If your Khoros Community is public, that is, accessible without logging in, select **No login**. If your community is private, select **Khoros Community account** and enter the credentials of a [crawling account](https://docs.coveo.com/en/2122/) for the source. This account must: * Be a native Khoros Community account. * Be an administrator account if you plan on [replicating your Khoros Community permission system in Coveo-powered search interfaces](#content-security-tab). * Be dedicated to the source. * Have access to all the content you want to index. * Have permission to make REST API read calls for all boards and categories of your community. When you have administrator rights, this setting is available in your Khoros Community **Admin** section, under **Users** tab > **Permissions** navigation bar section > **Defaults** tab > **Make REST API calls with read access**. See [Source credentials leading practices](https://docs.coveo.com/en/1920/) for more information on crawling accounts. > **Notes** > > * [[NotePrivateContent]]Some Khoros communities contain public and private items. > Private items are only accessible to users allowed to view this content. > If you have such a community, enter the credentials of an account that is allowed to access all private content. > If it isn't, private items won't be indexed. > See [Permission indexing limitations](#permission-indexing-limitations) for more information. > > * If the crawling account doesn't have the permission to make REST API read calls for certain boards and categories, they're skipped during the indexing process and therefore won't show up in a Coveo-powered search page. > Moreover, if your source **Community URL** is the address of such a board or category, Coveo returns a `KHOROS_COMMUNITY_AUTHORIZATION_ERROR` error. > > * When your Khoros Community is secured using a basic authentication, you must [provide your basic authentication credentials in the source JSON configuration](https://docs.coveo.com/en/2033/). > > * SSO credentials aren't supported. > You must use a native Khoros account. #### "Identification" subtab The **Identification** subtab contains general information about the source. ## Name The source name. It can't be modified once it's saved. Use the **Project** selector to associate your source with one or more Coveo [projects](https://docs.coveo.com/en/n7ef0517/). ### "Items" tab On the **Items** tab, you can specify how the source handles items based on their file type or content type. #### File types File types let you define how the source handles [items](https://docs.coveo.com/en/210/) based on their file extension or content type. For each file type, you can specify whether to index the item content and [metadata](https://docs.coveo.com/en/218/), only the item metadata, or neither. You should fine-tune the file type configurations with the objective of indexing only the content that's relevant to your users. **Example** Your repository contains `.pdf` files, but you don't want them to appear in search results. You click **Extensions** and then, for the `.pdf` extension, you change the **Default action** and **Action on error** values to `Ignore item`. For more details about this feature, see [File type handling](https://docs.coveo.com/en/l3qg9275/). #### Content and images If you want Coveo to extract text from image files or PDF files containing images, enable the appropriate option. The extracted text is processed as item data, meaning that it's fully searchable and will appear in the item [Quick view](https://docs.coveo.com/en/2760#search-result-quick-view). > **Note** > > When OCR is enabled, ensure the source's relevant [file type configurations](https://docs.coveo.com/en/l3qg9275/) index the item content. > Indexing the item's metadata only or ignoring the item will prevent OCR from being applied. See [Enable optical character recognition](https://docs.coveo.com/en/2937/) for details on this feature. ### "Content security" tab Select who will be able to access the source items through a Coveo-powered [search interface](https://docs.coveo.com/en/2741/). For details on the content security options, see [Content security](https://docs.coveo.com/en/1779/). **If you select "Same users and groups as in your content system"** [%collapsible%open] #### If you want to [replicate your Khoros community's permission system in your Coveo-powered search interface](https://docs.coveo.com/en/1779/), enter the username of a newly created Khoros user under **Permission account**. This account will be used by Coveo to discover your permission system, so it must be dedicated to this purpose. It can't be the [administrator account required to index a private community](#authentication). See [Permission indexing limitations](#permission-indexing-limitations) for more information. #### === "Access" tab . On the **Access** tab, specify whether each group (and API key, if applicable) in your [Coveo organization](https://docs.coveo.com/en/185/) can view or edit the current source. For example, when creating a new source, you could decide that members of Group A can edit its configuration, while Group B can only view it. For more information, see [Custom access level](https://docs.coveo.com/en/3151#custom-access-level). On the **Access** tab, specify whether each group (and API key, if applicable) in your [Coveo organization](https://docs.coveo.com/en/185/) can view or edit the current source. For example, when creating a new source, you could decide that members of Group A can edit its configuration, while Group B can only view it. For more information, see [Custom access level](https://docs.coveo.com/en/3151#custom-access-level). ### Build the source . Finish adding or editing your source: ** When you're done editing the source and want to make your changes effective, click **Add and build source**/**Save and rebuild source**. ** When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to make other changes soon, click **Add source**/**Save**. On the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page, click **Launch build** or **Start required rebuild** when you're ready to make your changes effective and index your content. > **Leading practice** > > By default, a Jira Software source indexes the entire Jira Software instance content. > To index only certain projects, click **Save**, and then specify the desired address patterns in your [source JSON configuration](https://docs.coveo.com/en/1685/) before launching the initial build. > See [Add source filters](https://docs.coveo.com/en/2006#add-source-filters) for further information. . On the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page, follow the progress of your source addition or modification. . Once the source is built or rebuilt, [review its content in the Content Browser](https://docs.coveo.com/en/2053/). . Optionally, consider [editing or adding mappings](https://docs.coveo.com/en/1640/). > **Note** > > If you selected **Specific URLs** or **User profiles** in the [**Content**](https://docs.coveo.com/en/1739#content) section, some additional items will appear in the Content Browser. > To retrieve user profiles, Coveo must crawl your SharePoint Online instance, including your host site collection and the documents it contains. > Items encountered during this process are also retrieved and therefore appear in the Content Browser. ### Index metadata To use [metadata](https://docs.coveo.com/en/218/) values in [search interface](https://docs.coveo.com/en/2741/) [facets](https://docs.coveo.com/en/198/) or result templates, the metadata must be [mapped](https://docs.coveo.com/en/217/) to [fields](https://docs.coveo.com/en/200/). Coveo automatically [maps](https://docs.coveo.com/en/217/) only a subset of the metadata it extracts. You must map any additional metadata to fields manually. > **Note** > > Not clear on the purpose of indexing metadata? > Watch [this video](https://www.youtube.com/watch?v=BmmmVJ3AWi0). . On the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page, click your source, and then click **More** > **View and map metadata** in the Action bar. . Review the default [metadata](https://docs.coveo.com/en/218/) that your source is extracting from your content. . Map any currently _not indexed_ metadata that you want to use in facets or result templates to fields. .. Click the metadata and then, at the top right, click **Add to Index**. .. In the **Apply a mapping on all item types of a source** panel, select the field you want to map the metadata to, or [add a new field](https://docs.coveo.com/en/1833#add-a-field) if none of the existing fields are appropriate. > **Note** > > For advanced mapping configurations, like applying a mapping to a specific item type, see [Manage mappings](https://docs.coveo.com/en/1640#manage-mappings). .. Click **Apply mapping**. . Return to the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page. . To reindex your source with your new mappings, click your source, and then click **More** > **Rebuild** in the Action bar. . Once the source is rebuilt, review your item field values. They should now include the values of the metadata you selected to index. .. On the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page, click your source, and then click **More** > **Open in Content Browser** in the Action bar. .. Select the card of the item for which you want to inspect properties, and then click **Properties** in the Action bar. .. In the panel that appears, select the **Fields** tab. ## Refine the content to index You may want to avoid indexing certain subfolders, or to index only a few of them. To do so: . If not already done, create and save your source with a broad [bucket URL](#amazon-s3-bucket-url). . In your [source JSON configuration](https://docs.coveo.com/en/1685/), enter an [address filter](https://docs.coveo.com/en/2006#add-source-filters) to refine the targeted content. > **Important** > > Your [bucket URL](#amazon-s3-bucket-url) must match one of your inclusion [`addressPatterns`](https://docs.coveo.com/en/2006#addresspatterns-array-required) and not match any of your exclusion `addressPatterns`. You may want to avoid indexing certain pages, or to index only a few of them. To do so: . If not already done, create and save your source with a broad [URL](#urls). . In your [source JSON configuration](https://docs.coveo.com/en/1685/), enter an [address filter](https://docs.coveo.com/en/2006#add-source-filters) to refine the targeted content. > **Important** > > Your [URL](#urls) must match one of your inclusion [`addressPatterns`](https://docs.coveo.com/en/2006#addresspatterns-array-required) and not match any of your exclusion `addressPatterns`. > Otherwise, Coveo will return a `No Items Indexed` error. You may want to avoid indexing certain subfolders, or to index only a few of them. To do so: . If not already done, create and save your source with a broad [path](#path). . In your [source JSON configuration](https://docs.coveo.com/en/1685/), enter an [address filter](https://docs.coveo.com/en/2006#add-source-filters) to refine the targeted content. > **Important** > > Your [path](#path) must match one of your inclusion [`addressPatterns`](https://docs.coveo.com/en/2006#addresspatterns-array-required) and not match any of your exclusion `addressPatterns`. You may want to avoid indexing certain communities, or to index only a few of them. To do so: . If not already done, create and save your source with a broad [community URL](#khoros-community-address). . In your [source JSON configuration](https://docs.coveo.com/en/1685/), enter an [address filter](https://docs.coveo.com/en/2006#add-source-filters) to refine the targeted content. > **Important** > > Your [community URL](#khoros-community-address) must match one of your inclusion [`addressPatterns`](https://docs.coveo.com/en/2006#addresspatterns-array-required) and not match any of your exclusion `addressPatterns`. **Examples** * With the following filter, Coveo doesn't index the board whose ID is `PrivateBoard`. ```json "AddressPatterns": [ { "Allowed": false, "Expression": ".*board:PrivateBoard\/.*", "PatternType": "RegEx" } ], ``` * With the following filter, Coveo doesn't index categories whose ID contains `Private`, `private`, `Moderator`, `moderator`, `Archive`, or `archive`. ```json "AddressPatterns": [ { "Allowed": false, "Expression": ".*category:([Pp]rivate|[Mm]oderator|[Aa]rchive).*", "PatternType": "RegEx" } ], ``` ## Permission indexing limitations When you [replicate your community's permission system in your Coveo-powered search interface](https://docs.coveo.com/en/1779/), the interface end users only see the Khoros content they're allowed to see in your Khoros community. Their Khoros-related search results vary based on the roles they've been assigned in Khoros Community. However, this option has some limitations regarding the following: * [User privacy settings](#user-privacy-settings) * [Restriction roles on public boards](#restriction-roles-on-public-boards) * [User-specific permissions](#user-specific-permissions) ### User privacy settings Khoros Community user data includes private information such as user full names and email addresses. Privacy settings (**My settings** > **Preferences** > **Privacy Settings**) lets users choose who can see their private information on their profile. Options are: "All", "Friends only", and "No one", which is the default option. When "No one" is selected, the user's private information is visible to administrators only. If you decide to [index Khoros Community user data](#additional-content), Coveo will crawl user information, including private data. However, since Coveo doesn't support user privacy settings, it handles user private information as regular data. As a result, depending on your mapping rules, user private information could be available to anyone who can see your Khoros Community content in their search results. If you want user private information to appear in your Coveo-powered search interface, [create mapping rules](https://docs.coveo.com/en/1640/) for fields containing sensitive information such as `email` and `fullname`. If don't want user private information to appear in your Coveo-powered search interface, ignore these fields. As a result, Coveo will crawl the private information in the sensitive fields, but won't index it due to the lack of mapping rule. ### Restriction roles on public boards Public Khoros boards are accessible to all users, including unauthenticated users. Khoros administrators can forbid users that have a certain role to access a certain public board. However, this doesn't affect unauthenticated users. In other words, a user that has a role preventing them to see a certain public board could log out of Khoros and access this board. Since public boards are ultimately public, Coveo doesn't replicate this behavior. When a board is public, any Coveo user that can access your search interface can also access the board's content through it. ### User-specific permissions User-specific permissions (**Users** > **Edit Users** > **Permissions**) aren't supported. Khoros recommends setting permissions for roles, and then assigning roles to users, rather than using user permissions on a permanent basis. ## Required privileges You can assign privileges to allow access to specific tools in the [Coveo Administration Console](https://docs.coveo.com/en/183/). The following table indicates the privileges required to view or edit elements of the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page and associated panels. See [Manage privileges](https://docs.coveo.com/en/3151/) and [Privilege reference](https://docs.coveo.com/en/1707/) for more information. > **Note** > > The **Edit all** privilege isn't required to create sources. > When granting privileges for the [Sources](https://docs.coveo.com/en/1707#sources-domain) domain, you can grant a group or API key the **View all** or [**Custom**](https://docs.coveo.com/en/3151#custom-access-level) access level, instead of **Edit all**, and then select the **Can Create** checkbox to allow users to create sources. > See [Can Create ability dependence](https://docs.coveo.com/en/3151#can-create-ability-dependence) for more information. ## What's next? * [Schedule source updates](https://docs.coveo.com/en/1933/). * If your Khoros Community is secured using basic authentication, [specify the additional credentials in the source JSON configuration](https://docs.coveo.com/en/2033/).