Install a Search Client in Salesforce Console

Find information right inside your console. This article takes you through the steps of installing and setting up a SearchUnify client in Salesforce Console. The installation consists of four (Classic) or five (Lightning) steps.

Installation Overview

Become a Knowledge User

  1. From in Salesforce, go to Quick Find Box and look up "users."

  2. Click Edit and check the Knowledge User box.

Enable Lightning Knowledge

NOTE. You can skip this step if you want to continue using Salesforce Classic to create and store articles.

  1. Find Knowledge Settings from Quick Find Box.

  2. Check Yes, I understand the impact of enabling Salesforce Knowledge. and click Enable Lightning Knowledge.

Install a Client

  1. Unzip the search client and open readme.

  2. From the package link (highlighted above) in readme, install SUVfConsole for All Users.

Configure the Client

  1. Open a new tab and log into Salesforce.
  2. Create a remote site and use the web address highlighted on your Installation Complete screen in the URL field.

  3. Return to the Installation Complete screen (first tab) and scroll down.
  4. Enter configuration details and click Done.
    • Select your application for Configuration. Choose either Sales Console or Service Console. The search client will be installed in the chosen console.
    • Enter Service Endpoint. It is your SearchUnify instance URL. Copy it from readme.
    • Enter Provision Key. You can get it from your SearchUnify representative.
    • Enter UID. It is your search client ID. Copy it from readme.
    • Enter jwt token expiration time(time should be in minutes). Enter any integer. The suggested value is 120.


Create a Custom Component

Activate Results Scrolling

  1. Copy the <div> snippet from readme.

  2. Log into your SearchUnify instance.
  3. Go to Search Clients > Edit > Designer.
  4. Paste the <div> in the CSS tab of Search Results Page and click Update.


Once the entire process is complete, you can open the app from App Launcher and start searching.

Find the App

To use the app, look up your component from App Launcher.

App in Use


Last updatedFriday, September 4, 2020