-
Troubleshooting
- Use the Debug Panel
- Supported Browsers
- Use Two Versions of jQuery in the Same Page
- Identify the Version
- Enable Debug Information in the REST Queries
- Use the Relevance Inspector
- Use With the On-Premises Search API
- Prevent Queries Without Keywords
- Why Are Result Counts Inaccurate With Folding Enabled?
- Why Are Some Child Items Not Folded?
- Prevent Tab Captions From Being Cut Off
Identify the JavaScript Search Framework Version
Before using a new Coveo JavaScript Search Framework component or feature in a search interface, you should typically ensure that the JavaScript Search Framework version on which that search interface relies supports that new component or feature.
This article provides two methods of identifying the JavaScript Search Framework version used in a Coveo-powered product.
Method 1: From a Search Interface
-
Access the search interface using your preferred web browser (e.g., Chrome).
-
Open your web browser developer tools console (e.g., in Chrome, press
Control
+Shift
+J
[Windows/Linux], orCMD
+Option
+J
[Mac]). -
Select the Console tab.
-
In the console prompt, type
Coveo.version
, then pressEnter
.This returns an object similar to:
{ "lib": "2.4710.8", "product": "2.4710.8", "supportedApiVersion: 2 }
In the
lib
andproduct
values above,2
is the major version,4710
is the minor version, and8
is the hotfix version. -
Optionally, find the release notes corresponding to the retrieved
product
value (see JavaScript Search Release Notes).
Method 2: From the Distribution Files
For an administrator or a developer, when you have access to the CoveoJsSearch.zip
distribution file or to the folder containing the Coveo JavaScript Search Framework:
-
Using a text editor, open the
\[JsSearch\_Installation\_Path\]/js/CoveoSearch.js
file. -
Toward the beginning of the file, locate the
Coveo.version
function, and note theproduct
value.// ... (function (Coveo) { Coveo.version = { "lib" : "1.0.3.23", "product": "1.0.20.0", "supportedApiVersion": 2 }; // ...