Coveo for Salesforce FAQ
This section contains the answers to the most frequently asked questions about Coveo for Salesforce.
What’s Coveo for Salesforce?
Coveo for Salesforce integrates AI-powered search and recommendations into Salesforce Service, Sales, Community, and B2B Commerce Cloud to surface relevant unified content from Salesforce and other applications (see Coveo for Salesforce Overview).
Do I Need to Be a Salesforce Administrator to Install Coveo for Salesforce?
Yes. To install the Coveo for Salesforce application from the AppExchange, you must be the Salesforce administrator of your organization.
What’s a Coveo Organization?
A Coveo organization is a private and secured environment in the Coveo Platform.
For Coveo for Salesforce Pro and Enterprise editions, the organization hosts a unified index of your content from one or more sources (such as CRM [Salesforce], websites, emails [Microsoft Exchange, Gmail], files [Dropbox, Google Drive], Intranet [SharePoint, Confluence], or community [Khoros Community]) to make this content searchable (see Coveo Administration Console).
Coveo for Salesforce Free edition (deprecated) directly queries the Salesforce index instead. As a result, the organization has no index.
For all editions of Coveo for Salesforce, a Coveo organization hosts usage analytics data allowing you to track how end users take advantage of the search solution (see Analyze Data). The Coveo organization also offers Coveo Machine Learning and Search Optimization/Search features.
How Can I Access my Coveo Organization?
A Coveo organization administrator accesses the Administration Console from a browser (see Coveo Cloud V1 and V2 Compared):
End users don’t need any access to the Coveo organization Administration Console. They only see search results from the Coveo organization in search applications such as Coveo for Salesforce (see Coveo for Salesforce Overview).
What’s a Coveo Insight Panel?
A Coveo Insight Panel is the part of the Coveo for Salesforce application that you see in Salesforce page layouts. It automatically displays content relevant to the context of the currently viewed Salesforce page.
What Type of Content Can Be Indexed?
Many different types of content can be indexed through sources such as Salesforce, Exchange, Gmail, Dropbox, and Khoros Community:
Microsoft Office items (Word, Excel, PowerPoint)
Salesforce system objects and fields (standard and custom)
Community forum posts
How Often Is Content Refreshed or Updated?
A refresh, called incremental refresh in Coveo Cloud V1, is typically performed at 15-minute intervals, but your administrator can configure the refresh rate for each source.
Can Coveo Have an Impact on the Performance of My Salesforce Organization?
Coveo for Salesforce is engineered to have only minimal impact on the performance of your Salesforce organization and won’t affect performance for users.
Coveo for Salesforce Pro and Enterprise editions:
The most resource intensive operation occurs when your Coveo organization initially indexes the whole content of your Salesforce organization, but the Salesforce API throttles call to prevent performance issues. The search results from your Salesforce source are then maintained up-to-date thanks to incremental refreshes, which only fetch the changes that have been made since the last indexing, therefore further minimizing the impact on the organization performance. Indexing content sources other than Salesforce has no impact on your Salesforce organization performance.
User interface display
The Coveo for Salesforce application consumes minimal Salesforce organization resources. For a given user, the application initially performs an HTTP request to get a security token that’s reused for all page loads. Search requests are sent directly to your Coveo organization, which returns search results without consuming Salesforce organization resources.
Coveo for Salesforce Free edition (deprecated):
Since the Free edition of Coveo for Salesforce doesn’t index your content, the Salesforce API is called only when accessing a search page (see Understanding the Coveo for Salesforce Free Edition Architecture). Due to the differences between the Salesforce and the Coveo query languages, a single Coveo query may result in several Salesforce queries.
If I Add a Source, Will Everyone Be Able to Search the Content?
Users following system permissions
Can Coveo Include Search for Content Tagged with Salesforce Topics?
In the Coveo for Salesforce configuration page, use the advanced source configuration parameters to include content tagged with Salesforce topics in your search.
What’s the Main Difference Between the Salesforce Index and the Coveo Index?
All Coveo for Salesforce editions give you access to Machine Learning, Usage Analytics, and Search Optimization features in your Coveo Administration Console. The main difference between the Free (deprecated) and the Pro and Enterprise editions is the index use.
The Coveo for Salesforce Free edition (deprecated) uses the Salesforce index. No sources are created. It means that the content isn’t crawled and stored in your Coveo Cloud like it would be in the Pro and Enterprise editions. When a query is performed, the Coveo Search API translates the query to either SOSL or SOQL (Salesforce Query Languages), depending on the query performed, and sends it to the Salesforce Index, which returns the results (see Understanding the Coveo for Salesforce Free Edition Architecture).
Pro and Enterprise Editions offer many features and customizations in the Coveo Platform. You can also use a Coveo Index. This means that your Coveo organization crawls your content and makes a copy of it that can be queried much faster and in more complex ways (see Understanding the Coveo for Salesforce Pro and Enterprise Architecture).
Is Coveo Cloud V2 a Prerequisite to Migrate to the Salesforce Lightning Experience?
Although it’s not mandatory, we strongly recommend migrating to Coveo Cloud V2 before migrating to the Salesforce Lighting Experience because newer features such as User Actions and Viewed by Customer are only available on Coveo Cloud V2.
Can I Try the Pro Edition?
Yes. When you install and configure the package, you can select the Pro Trial.
What Happens to My Data When My Pro Trial Period Is Over?
The entire Coveo organization, including all data, is securely deleted.
What Are the Main Benefits of the Pro Edition Versus the Free Edition?
The Coveo for Salesforce Pro Edition offers:
Coveo Index (faster and more complex queries)
External Content (choice of two from more than 30 connectors)
Contextual Insight Panels in Service and/or Sales Cloud
Case Deflection in Community Cloud (see Integrating a Coveo Case Deflection Component)
Search interface facets)
Basic Support included
Which Content Sources Are Available to Index in the Pro Edition?
You can have Salesforce sources, plus two Cloud sources from any of the following types (see Coveo for Salesforce Edition Comparison):
Web and Sitemap Sources
Push API and REST API
Microsoft SharePoint Online
Google Drive (Work & Personal)
Dropbox (Personal & Business)
Box (Personal & Business)
Microsoft OneDrive for Business
How Do I Estimate My Item Count?
Depending on the connector a source is based on, there are different ways to estimate its number of items.
In Salesforce, you can use the Storage Usage page (see Monitor Data and Storage Resources). You can also use SOQL to estimate the item count. Be aware that all related objects, such as Case Comments, count as additional items.
For public websites, inspect the sitemap or check how many pages external search engines have indexed using a query like
For other systems, use similar methods if available.
When Do I Consume Salesforce APIs with Pro Edition?
Mostly when indexing the Salesforce organization.
Does Pro Edition Work With Salesforce Lightning Experience and Classic Visualforce?
Yes, both are fully supported. However, new Coveo for Salesforce features are only being developed in Lightning.
What Security Precautions Should I Take to Protect My Sensitive Data on the Pro Edition?
All Coveo Platform customers benefit from an infrastructure and a platform built to satisfy the requirements of the most security-sensitive organizations. Coveo is committed to preserve the confidentiality, integrity, and availability of customers information assets (see How Does Coveo Secure Your Data and Services?).
You can choose not to index some of your content, if needed. There are a few different approaches available in your sources to consider, depending on the connector. You can choose to index only specific fields, use exclusion rules to restrict sections of a website, add a web scraping configuration to index only specific parts of a web page, or use conditional indexing to index only specific subsets of Salesforce objects.
Can I Try an Enterprise Edition?
Yes. During the package setup, you can select the Enterprise Trial.
What Are the Enterprise Edition Trial Limits?
The trial is limited to:
5 GB of disk space
How Much Does It Cost Once the Enterprise Edition Trial Is Over?
Pricing is based on a subscription license cost per user per month. Contact us for pricing.
Can an Enterprise Edition Trial Be Extended?
Contact us to discuss the possibility of extending the trial period.
What Happens to My Data When My Enterprise Trial Period Is Over?
The entire Coveo organization, including all data, is securely deleted.
What Are the Main Benefits of Enterprise Edition Versus Pro Edition?
Your choice of any source, including on-premises sources
Increased item limits
Can I Upgrade from Pro Edition to Enterprise Edition?
Yes. Contact us to determine your options.
How Many Content Sources Are Available in Enterprise Edition?
Coveo offers more than 30 connectors to the most common enterprise data sources. Coveo sources are typically configured in just a few clicks, directly from the Coveo Administration Console, and fully support incremental indexing and field mapping. Have a look at our available Cloud connectors.
Pro and Enterprise Editions
Why Does the Salesforce Source Require the Modify Metadata Through Metadata API Functions and the Manage Sharing Permissions for the Coveo Index Account?
The crawling account needs the Modify Metadata Through Metadata API Functions and the Manage Sharing permissions to access the security permissions within the Salesforce Metadata API. These permissions allow the crawling account to read the configured security model (profiles, permission sets, sharing rules) of objects and fields, and the standard and custom objects (see Coveo Cloud Management of Security Identities and Item Permissions and Metadata API Developer Guide).
Why Use the Metadata API Instead of the Sharing Object on the Records?
Since your data is kept in your Salesforce organization, only the metadata is transferred to the Coveo Index, at the field and record levels. All source links redirect to the Source System record, which is Salesforce in this case. The Coveo Index only retrieves and embeds the Salesforce security model (profiles, permission sets, sharing rules, and field level security) for each record.
When the Salesforce security model changes, the new security model is also replaced in the Coveo Index at the next source refresh, rescan, or rebuild. Coveo captures the existing Source System security model when indexing instead of replicating or creating another model version. This means that users can only search and find the Salesforce content or data that they’re allowed to access according to their configured Salesforce permission models (see Refresh VS Rescan VS Rebuild).
Do I Need the Modify Metadata Through Metadata API Functions Permission?
The Coveo Index can’t retrieve information about private objects, such as cases or opportunities. The Modify Metadata Through Metadata API Functions permission, associated to the Metadata API, allows you to create sources accessible to Users following system permissions and to index the Salesforce security settings of your objects.
If you want to create a public community or a public console, the Modify Metadata Through Metadata API Functions permission isn’t needed, since you create a source accessible to Everyone and you don’t index objects accessible to Specific identities1.
1: For more information on source content security, see Content Security
Is the Modify Metadata Through Metadata API Functions Permission Needed to Index Salesforce Chatter?
Is the Modify Metadata Through Metadata API Functions Permission Needed for Sources Accessible to “Everyone”?
No. It’s only needed for sources using the Users following system permissions content security option that index private Salesforce objects.
Do I Need to Enable the Modify Metadata Through Metadata API Functions Permission to Use the Salesforce Knowledge Source?
Salesforce Knowledge does not index permissions and therefore the Coveo Index account only needs Salesforce Knowledge User permission set on the account. This applies to both Classic and Lightning Knowledge data models.
Who uses the Modify Metadata Through Metadata API Functions Permission?
All Coveo Customers who have implemented a Coveo Salesforce source using the Users following system permissions content security option have activated the Modify Metadata Through Metadata API Functions permission for the Coveo Index account.
Why Is the Coveo Index Using the Meta-Retrieve Operation on Non-Indexed Objects?
When indexing an object, you might retrieve the lookup field of another object metadata that you don’t index.
The Salesforce Connector uses various Salesforce APIs performed in READ operations, even though the Coveo Index account has the Modify Metadata Through Metadata API Functions permission (see API Call Basics).
The Salesforce Connector makes a series of
describeSObjects() calls, which are used to retrieve the CRUD permissions and field-level security of a Salesforce object. If you select a parent or lookup field within a Salesforce object to be indexed, the
describeSObjects() call retrieves, in READ mode, metadata associated to the object and the field. It’s included in the mapping file. The parent or lookup object isn’t indexed by the Coveo Salesforce Connector, unless it’s selected to be indexed. However, the mapping file is used by the Salesforce Connector to identify the fields to index and to monitor during a refresh or rebuild process.
Is the Modify All Data Permission Required to Access the Coveo Interface Editor in Salesforce?
Yes, you must enable the Modify All Data permission to access the Interface Editor (see Access the Interface Editor).
Is the Modify All Data Permission Required to Install Coveo for Salesforce or to Index Salesforce Content?
No, the Modify All Data permission isn’t required. See Creating a Dedicated Salesforce Crawling User.
Free Edition (Deprecated)
What Are the Main Benefits of the Free Edition vs the Salesforce Native Search?
The Coveo for Salesforce Free edition offers:
Customizable Search Layouts (see Use the Interface Editor)
Personalization (see Developing With Coveo for Salesforce)
Machine Learning and Relevance Tuning (see Coveo Machine Learning)
Advanced Analytics (see Analyze Data)
Content Preview (see Coveo QuickView Component (Coveo Quickview))
Can I Go Live with the Free Edition?
Yes. You can create a production organization to go live with the Free Edition.
What Are Common Use Cases for the Coveo for Salesforce Free Edition?
Typically, customers using the Coveo for Salesforce Free Edition want to:
Scale small communities;
Improve learning and exploration for their developers.
How Can Coveo Work Without Having Its Own Index?
Coveo applies Machine Learning features and search results ranking directly on the Salesforce index, so the content stays in your Salesforce organization.
What Components and Which Salesforce Clouds Are Supported in the Free Edition?
You can create a Full Search page with a Standalone Search box, create communities or use the Service Cloud (see Editions and Pricing).
How Often Do I Consume Salesforce APIs with Free Edition?
Since the Free edition of Coveo for Salesforce doesn’t index your content, the Salesforce API is called only when accessing a search page and with the requested fields (see Understanding the Coveo for Salesforce Free Edition Architecture and API Request Limits and Allocations).
Is There a Time Limit or Expiry Date to a Free Edition?
No, there’s no expiry date.
What Security Precautions Should I Take to Protect my Sensitive Data on the Free Edition?
All Coveo Platform users benefit from an infrastructure and a platform built to satisfy the requirements of the most security-sensitive organizations. Coveo is committed to preserve the confidentiality, integrity, and availability of customers information assets (see How Does Coveo Secure Your Data and Services?).
Additionally, with the Free Edition, your content stays in your Salesforce organization index, where Coveo Machine Learning is applied. You don’t need to configure the index content.
Can I Upgrade from Free Edition to Pro Edition
Yes. You may require some help from one of our recommended Coveo implementation partners, such as Solutions Integrators. Contact your sales representative to learn more.