How do I set up SearchBlox with SalesForce?

SearchBlox SalesForce Setup

1) Install the SearchBlox "SearchBlox Force 1.0" package from this URL:

2) Enter the password. (Please contact our support desk for your password:

3) After the installation, go to Setup > Build > Develop > Custom Settings, click on Manage next to "SearchBlox Settings."

  • Click on New.
  • Enter settings that look similar to this (Note: The Name fields must match exactly):

  • Name = SearchBlox1
  • End Point = (Replace the with your own SearchBlox Server address)               
  • API Key = DF2FD769ED1A7B214BE1117F216BBBBB (Use the API from the SearchBlox Server web console)
  • Collection Name = (Leave blank for now, unless you have an existing one you want to use.  In step #6, below, you can create one.)
  • Title Delimiter = ,%20 (This is a comma and a space.)
  • Location URL = (Change na15 to your Org.)              
  • Profile = Admin

4) Go to Administer >Manage Users > Permission Sets.

  • Find the Permission Set "SearchBlox."
  • Now go to Administer > Manage Users > Users.

  • Open up each user who should access the SearchBlox application and assign the SearchBlox Permissions Set via the "Edit Assignments" button on the "Permission Set Assignments" related list.

5) Open up the ‘SearchBlox’ application.

6) If you do not yet have a Collection at SearchBlox, you can create one using these steps:

  • Click on the SearchBlox Fields tab.
  • Click on the Add/Delete Collection button.


  • Enter a new Collection name and click on Create New Collection.

7) Click on the SearchBlox Fields tab.

  • Add rows to this custom object for all of the objects and fields that you would like to send to SearchBlox.

  • The "Object Name" picklist field may need to be modified in Setup to add custom or standard objects. Custom objects should use the API name with the "__c" at the end.
  • The "Field Name" field should be the API name.
  • The "Order in Title" field is the order in which fields should display in the "Title" field in SearchBlox. The fields will be determined by the "Delimiter" field in the SearchBlox custom settings.               
  • The "Tag Value" field is the tag that is created in the XML that is sent to SearchBlox. This is basically a friendly name to send to SearchBlox since the API name may not be readable.

8) Go to Setup  >Build > Create > Apps.

  • If the "SearchBlox" connected app already exists in the Connected Apps section, then continue to modify the "Canvas App URL", listed in the next step.

  • Click on Edit, and in the "Canvas App Settings" section, change the "Canvas App URL" to match your SearchBlox instance:


  • If the "SearchBlox" connected app did not exist (Connected Apps cannot be included in an unmanaged package.), then create a connected app called "SearchBlox."

  • API (Enable OAuth Settings)

                    1. Enable OAuth Settings (checked).

                    2. Callback URL:

                    3. Selected OAuth Scopes: Access your basic information (id).

  •   Canvas App Settings

                    1. Canvas App (checked).

                    2. Canvas App URL:

                    3. Access Method: OAuth Workflow (GET)

                    4. Locations: Visualforce Page

  • Now, go to the SearchBlox Visualforce page, and edit it to remove the comments so that the <apex:canvasApp tag is enabled again.

10) Go to Setup > Develop > Apex Classes, and click on "SearchBloxSchedule."

  • Copy the execute anonymous code to the clipboard.
  • Change it as you want.  It will run the batch job every 10 minutes.


  • Click on Your Name, then "Developer Console."

  • Click on "Debug," and "Open Execute Anonymous Window."
  • Paste the text from the clipboard, and click "Execute."

  • To confirm your job is scheduled, go to Monitor > Jobs > Scheduled Jobs.

11) Go to Setup > Developer > Apex Triggers, and open the "SearchBloxField" trigger.

  • For every standard, or custom, object that you want to send to SearchBlox,      create a trigger that looks exactly like that one for every object. So, if you were going to track contacts and accounts, then you would have to create two triggers:

12) You should now be able to start making changes to the standard and custom objects that you have listed, and the changes should be sent to SearchBlox.

  • You can use the "SearchBlox Search" tab to run your searches from within Salesforce. You can search just your SalesForce collection or all collections available in SearchBlox for a federated search.



Have more questions? Submit a request