Add or Edit a Khoros Community Source
Add or Edit a Khoros Community Source
A Khoros Community source is an interactive community that enables users to share digital customer experiences on the Khoros platform. Members of a Coveo organization with the required privileges can add the source to index the content of their Khoros Community instance.
|
The Khoros Community source can’t include permissions because the Khoros Community API doesn’t allow the retrieval of user permissions for each item. This means that any user who has access to search results from a Khoros community source can find any indexed item, regardless of whether they’re allowed to access these items in Khoros Community (see Private Content and Limiting Source Content Permissions To Specific Users). |
|
Leading practice
The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About Crawling Speed for information on what can impact crawling speed, as well as possible solutions. |
Source Key Characteristics
Features | Supported | Additional information | |
---|---|---|---|
Khoros Community version |
Latest version |
||
Searchable content types |
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. |
||
Takes place every hour by default. A rescan or rebuild is required to take account of deleted or modified items. |
|||
Content security options |
|||
Add or Edit a Khoros Community Source
When adding a source, select the Khoros Community Source option.
To edit a source, on the Sources (platform-eu | platform-au) page, click the desired source, and then click Edit in the Action bar.
"Configuration" Tab
In the Add/Edit a Khoros Community Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.
General Information
Source Name
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 ( |
Community URL
Enter the web address of the Khoros Community server for the community that you want to index. If you want to make more than one address searchable, click the plus sign (+), and then enter the addresses to index on the additional lines.
-
http://company.khoros.com
-
https://community.company.com/
You can also specify a subset of a Khoros community to crawl by copying and pasting the address of a Khoros community category, board, or thread. The URL is in the form:
http://community.company.com/[...]/<KHOROS-OBJECT-LABEL>/<OBJECT-ID>
The possible values for <KHOROS-OBJECT-LABEL>
are given in the Label column of the following table:
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
|
Character optical recognition (OCR)
If you want Coveo to extract text from image files or PDF files containing images, check the appropriate box. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.
|
Note
Contact Coveo Sales to add this feature to your organization license. |
"Authentication" Section
When the Khoros Community is private, you must enter the credentials of a native Khoros Community account, such as an administrator account, that has access to the content you want to index. See Source Credentials Leading Practices. This account must also have permission to make REST API read calls for all boards and categories of your community.
When you have the 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.
|
Notes
|
"Content to Include" Section
Optionally, select additional content to index: message attachments, user data, and/or message tags.
|
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
|
"Content Security" Tab
Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content Security.
"Access" Tab
In the Access tab, set whether each group and API key can view or edit the source configuration (see Resource Access):
-
If available, in the left pane, click Groups or API Keys to select the appropriate list.
-
In the Access Level column for groups or API keys with access to source content, select View or Edit.
Completion
-
Finish adding or editing your source:
-
When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon, click Add Source/Save.
NoteOn the Sources (platform-eu | platform-au) page, you must click Launch build or Start required rebuild in the source Status column to add the source content or to make your changes effective, respectively.
-
When you’re done editing the source and want to make changes effective, click Add and Build Source/Save and Rebuild Source.
Back on the Sources (platform-eu | platform-au) page, you can review the progress of your source addition or modification.
Once the source is built or rebuilt, you can review its content in the Content Browser.
-
-
Optionally, consider editing or adding mappings once your source is done building or rebuilding.
Refine the Content to Index
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.
-
In your source JSON configuration, enter an address filter to refine the targeted content.
Your community URL must match one of your inclusion
addressPatterns
and not match any of your exclusionaddressPatterns
. -
Build or rebuild your source.
-
With the following filter, Coveo doesn’t index the board whose ID is
PrivateBoard
."AddressPatterns": [ { "Expression": ".*board:PrivateBoard\/.*", "PatternType": "RegEx", "Allowed": false } ],
-
With the following filter, Coveo doesn’t index categories whose ID contains
Private
,private
,Moderator
,moderator
,Archive
, orarchive
."AddressPatterns": [ { "Expression": ".*category:([Pp]rivate|[Mm]oderator|[Aa]rchive).*", "PatternType": "RegEx", "Allowed": false } ],
What’s Next?
-
If your Khoros Community is private, consider setting source permissions so that only end users from your company domain can access the source content.
-
If your Khoros Community is secured using basic authentication, specify the additional credentials in the source JSON configuration.