Add or Edit a Khoros Community Source

Add or Edit a Khoros Community Source

1. If not already in the Add/Edit a Khoros Community Source panel, access the panel:

   • To add a source, in the main menu, under Content, select Sources > Add Source button > Khoros Community.

     OR

   • To edit a source, in the main menu, under Content, select Sources > source row > Edit in the Action bar.

2. In the Configuration tab, enter appropriate values for the available parameters:

   • Source name

     A descriptive name for your source under 255 characters (not already in use for another source in this organization).

     Corporate-Khoros-Community

   • Community URL

     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 additional lines.

     • http://company.khoros.com

     • https://community.company.com/

     • You can also specify to crawl only a subset of a Khoros community 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>

       where the possible values for khorosobjectlabel are given in the Label column in 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

     • 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 to specify the URL address at which your REST API resides (see Khoros Community Source JSON Modification).
     • Be aware, however, that Khoros Community doesn’t recommend using a reverse proxy (see Reverse proxy and Lithium communities while logged in with a Khoros community account).

   • Character optical recognition (OCR)

     Check this box if you want Coveo Cloud to use optical character recognition to extract text from image files or PDF files containing images. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View.

     Since the OCR feature is available at an extra charge, you must first contact Coveo Sales to add this feature to your organization license. You can then enable it for your source.

   • Index

     When adding a source, if you have more than one logical (non-Elasticsearch) index in your organization, select the index in which the retrieved content will be stored (see Leverage Many Coveo Indexes). If your organization only has one index, this drop-down menu isn’t visible and you have no decision to make.

     • To add a source storing content in an index different than default, you need the View access level on the Logical Index domain (see Privilege Management and Logical Indexes Domain).

     • Once the source is added, you can’t switch to a different index.

3. In the Authentication section, when the Khoros Community to index is private, you must fill out the following parameters.

   • Some Khoros communities have public items as well as private items, and private items are only accessible to users allowed to view this content. If you have such a community, you must enter the credentials of an account that’s allowed to access all private content. If you don’t do so, private items aren’t indexed (see Khoros Community Permissions and Limiting Source Content Permissions To Specific Users).

   • When your Khoros Community is secured using a basic authentication, you must modify the source JSON configuration (once the source is saved) to add a hidden parameter (see Add a Hidden Source Parameter and Khoros Community Source JSON Modification).

   • Username

     The username of a native Khoros community account, such as an administrator account, that has access to the content that you want to index. 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.

     Boards and categories for which the account doesn’t have this permission are skipped during the indexing process and thus not searchable in a Coveo Cloud 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.

   • Password

     The corresponding password.

4. In the Content to Include section, consider turning off one or more of the following settings when you want to prevent specific Khoros Community content from being included in the index:

   • Attachments

     Includes message attachments, such as images, videos, and PDF files.

   • Users

     Includes data regarding users of a community.

     • You can include users only when indexing an entire community. If you only index a community subset such as a category or a board, users aren’t included (see Note: Crawling a community subset).

     • Including users of a large Khoros community can have a significant impact on the indexing performance.

5. In the 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.

6. In the Access tab, determine whether each group and API key can view or edit the source configuration (see Understanding Resource Access):

   1. In the Access Level column, select View or Edit for each available group.

   2. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

   If you remove the Edit access level from every group of which you’re a member, you won’t be able to edit the source again after saving. Only administrators and members of other groups that have Edit access on this resource will be able to do so. To keep your ability to edit this resource, you must grant the Edit access level to at least one of your groups.

7. Optionally, consider editing or adding mappings (see Adding and Managing Source Mappings).

   You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).

8. Complete your source addition or edition:

   • Click Add Source/Save 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.

     • By default, a Khoros community source indexes the entire community content. If you want to index only certain parts of your community, click Save, and then specify the desired address patterns accordingly (see Restrict Indexed Addresses).

     • On the Sources page, you must click Start initial build or Start required rebuild in the source Status column to add the source content or make your changes effective, respectively.

     OR

   • Click Add and Build Source/Save and Rebuild Source when you’re done editing the source and want to make changes effective.

     Back on the Sources page, you can review the progress of your Khoros Community source addition or modification.

   Once the source is built or rebuilt, you can review its content in the Content Browser (see Inspect Items With the Content Browser).

Restrict Indexed Addresses

You may want to avoid indexing certain boards or categories in your community, or to index only a few of them. To do so, you can specify address filters in your source JSON configuration (see Edit a Source JSON Configuration and Add Source Filters).

Once your changes are done, on the Sources page, build or rebuild your Khoros Community source (see Refresh, Rescan, or Rebuild Sources).

What’s Next?

• Review your source update schedule and optionally change it so that it better fits your needs (see Edit a Source Schedule). By default, your content is refreshed every hour and rescanned every day.

• When your Khoros Community is private, you should consider limiting source content permissions to email users inside your company domain in the source JSON configuration (see Edit a Source JSON Configuration).

• When your Khoros Community is secured using basic authentication, specify the additional credentials (see Khoros Community Source JSON Modification).