-
Add or Edit a Source Using One of the Available Connectors
- Amazon S3 Source
- Box (Personal) Source
- Box Business Source
- Confluence Cloud Source
- Confluence Self-Hosted Source
- Database Source
- Dropbox (Personal) Source
- Dropbox Business Source
- Exchange Enterprise Source
- Exchange Online (Personal) Source
- File System Source
- Generic REST API Source
- Gmail for Work Source
- Gmail (Personal) Source
- Google Drive (Personal) Source
- Google Drive for Work Source
- Jira Software Cloud Source
- Jira Software Self-Hosted Source
- Jive Cloud Source
- Jive Server Source
- Lithium Source
- Microsoft Dynamics 365 Source
- OneDrive for Business Source
- OTCS Source
- Push Source
- RSS Source
- Salesforce Source
- ServiceNow Source
- SharePoint Online Source
- SharePoint Online Legacy Source
- SharePoint Server Source
- Sitecore Source
- Sitemap Source
- Twitter Source
- Web Source
- YouTube Source
- Zendesk Source
Add or Edit a Lithium Source
Members of the Administrators and Content Managers built-in groups can add the content of a Lithium community to a Coveo Cloud organization. The source can be shared or private (see Content Security). By default, a Lithium source is refreshed every hour and rescanned every day to retrieve Lithium item changes (addition, modification, or deletion) (see Edit a Source Schedule).
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 | |||
Content security options | Secured | ||
Private | |||
Shared |
Add or Edit a Lithium Source
-
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.
-
-
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-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 communities while logged in with a Lithium account).
-
-
Character optical recognition (OCR)
Check this box if you want Coveo Cloud to extract text from image files or PDF files containing images (see Enable Optical Character Recognition). OCR-extracted text is processed as item data, meaning that it is fully searchable and will appear in the item Quick View (see Search Result 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 is not 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 cannot switch to a different index.
-
-
Content security
Select a content security option to determine who can see items from this source in a search interface.
-
-
In the Authentication section, when the Lithium community to index is private, you must fill out the following parameters.
-
Some Lithium 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 is allowed to access all private content. If you do not do so, private items are not indexed (see Lithium Permissions and Limiting Source Content Permissions To Specific Users).
-
When your Lithium community is secured using a basic authentication, you must modify the source JSON configuration (once the source is saved) to add hidden parameter (see Edit a Source JSON Configuration and Lithium Source JSON Modification).
-
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. 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 Lithium 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 does not have this permission are skipped during the indexation process and therefore 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
LITHIUM_AUTHORIZATION_ERROR
error. -
Password
The corresponding password.
-
-
In the 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.
-
-
- In the Access tab, determine whether each group and API key can view or edit the source configuration (see Understanding Resource Access):
- 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.
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.
-
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).
-
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 Lithium 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 are done editing the source and want to make changes effective.
Back on the Sources page, you can review the progress of your Lithium source addition or modification (see Adding and Managing Sources).
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).
-
With the following filter, Coveo does not index the board whose ID is
PrivateBoard
."AddressPatterns": [ { "Expression": ".*board:PrivateBoard/.*", "PatternType": "RegEx", "Allowed": false } ],
-
With the following filter, Coveo does not index categories whose ID contains
Private
,private
,Moderator
,moderator
,Archive
, orarchive
."AddressPatterns": [ { "Expression": ".*category:([Pp]rivate|[Mm]oderator|[Aa]rchive).*", "PatternType": "RegEx", "Allowed": false } ],
Once your changes are done, on the Sources page, build or rebuild your Lithium 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 Lithium 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 Lithium community is secured using a basic authentication, specify the additional credentials (see Lithium Source JSON Modification).