Add/Edit Lithium Source - Panel

When you have the required privileges, you can add the content of a Lithium community to your Coveo organization. The source can be shared or private (see Source Permission Types).

The Lithium source cannot include Lithium permissions because the Lithium API does not allow to retrieve user permissions for each item. This means that any user having access to search results from a Lithium source can find any indexed Lithium item, regardless of whether they are allowed to access these items in Lithium (see Private Content and Limiting Source Content Permissions To Specific Users).

Source Features Summary

Features Supported Additional information
Lithium version Latest cloud version Following available Lithium releases
Searchable content types

Community, 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.

Content update Refresh A rescan or rebuild is required to retrieve deleted or modified items.
Rescan
Rebuild
Permission types Secured

Private
Shared

Add or Edit a Lithium Source

  1. If not already in the Add/Edit a Lithium Source panel, go to the panel:

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

      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 available parameters:

    • Source name

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

      Corporate-Lithium-Community

    • Community URL

      The web address of the Lithium 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.lithium.com

      • https://community.company.com/

      • You can also specify to crawl only a subset of a Lithium community by simply copying and pasting the address of a Lithium category, board, or thread. The URL is in the form:

        http://community.company.com/[...]/lithiumobjectlabel/objectid

        where the possible values for lithiumobjectlabel are given in the Label column in the following table.

        Label Lithium 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 Lithium Source JSON Modification). Be aware, however, that Lithium does not recommend using a reverse proxy (see Reverse proxy and Lithium communitieswhile logged in with a Lithium account).

    • Security

      Select by who the Lithium community content is searchable (see Source Permission Types):

      • Private - Only you, the source creator

        OR

      • Shared - Everyone

    Authentication Section

    When the Lithium community to index is private, you must fill out the following parameters.

    • Username

      The username of a native Lithium account, such as an administrator account, that has access to the Lithium community content that you want to index. Moreover, this user must have permission to make REST API read calls event on a public community. When you have the administrator rights, this setting is available in your Lithium Community Admin section, under Users tab > Permissions navigation bar section > Defaults tab > Make REST API calls with read access.

      If the source credentials do not have the required permissions, you will get the LITHIUM_AUTHORIZATION_ERROR error.

    • Password

      The corresponding password.

    Content to Include Section

    Consider turning off one or more of the following settings when you want to prevent specific Lithium 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 are not included (see Note: Crawling a community subset).

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

  3. In the Configuration Access tab, determine whether each group and API key can view or edit the source configuration. In the Access Level column, select View or Edit for each available group. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

    You can select an access level for the groups you are allowed to edit only (see Privileges and Groups Privilege). Groups that you are not allowed to edit are grayed out.

    If you remove the Edit access level from all the groups of which you are a member, you will not 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.

  4. Optionally, consider editing or adding mappings (see Edit the Mappings of a Source: [SourceName]).

    You can only manage mapping rules once you build the source (see Add/Edit a Source - Panel).

  5. Finish adding/editing your source:

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

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

      Back in the Coveo Cloud administration console Sources page, you can review the progress of your Lithium source addition or modification (see Sources - Page).

  6. Once the source is built or rebuilt, you can review its content in the content browser (see Content Browser - Page).

What’s Next?